From 2fc9b476907e6fb830fd57f69d59c794548ad28b Mon Sep 17 00:00:00 2001 From: sigoden Date: Thu, 12 Dec 2024 10:31:37 +0800 Subject: refactor: add docs (#143) --- docs/environment-variables.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/environment-variables.md (limited to 'docs/environment-variables.md') diff --git a/docs/environment-variables.md b/docs/environment-variables.md new file mode 100644 index 0000000..8c13b64 --- /dev/null +++ b/docs/environment-variables.md @@ -0,0 +1,26 @@ +# Environment Variables + +## Injected by `run-tool.*`/`run-agent.*` + +| Name | Description | +| --------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `LLM_ROOT_DIR` | Path to `` | +| `LLM_TOOL_NAME` | Tool name, such as `execute_command` | +| `LLM_TOOL_CACHE_DIR` | Path to `/cache/`,
The tool script can use this directory to store some cache data | +| `LLM_AGENT_NAME` | Agent name, such as `todo` | +| `LLM_AGENT_FUNC` | Agent function, such as `list_todos` | +| `LLM_AGENT_ROOT_DIR` | Path to `/agents/` | +| `LLM_AGENT_CACHE_DIR` | Path to `/cache/`,
The tool script can use this directory to store some cache data | + +## Injected by runtime (AIChat) + +| Name | Description | +| ---------------------- | ---------------------------------------------------- | +| `LLM_OUTPUT` | File to store the the execution results of the tool. | +| `LLM_AGENT_VAR_` | Agent variables. | + +## Provided by users + +| Name | Description | +| ------------------ | --------------------------------------------------------------------------------------------- | +| `LLM_DUMP_RESULTS` | Controls whether to print the execution results of the tool, e.g. `get_current_weather\|fs.*` | -- cgit v1.2.3