Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Explain ¶ added in v0.11.0
func Explain(cfg *config.Config, configPath string, safe ...SafeCommand) string
Explain renders a Markdown description of the sandbox environment from cfg, for the AI agent to read on demand via `agent-sandbox ai explain`. The prose lives in explain.tmpl; this function only prepares the view data. The caller passes the config path it loaded cfg from (so the editing section names the file the agent must actually edit) and the available `safe` wrappers (from the live command tree) so the explain output points agents at them.
Types ¶
type SafeCommand ¶ added in v0.12.0
SafeCommand describes one `agent-sandbox safe <tool>` wrapper for the explain output. Use is the subcommand's usage (e.g. "git [args...]"); Short is its one-line description.
Click to show internal directories.
Click to hide internal directories.