diff options
| author | sigoden <sigoden@gmail.com> | 2024-12-12 10:31:37 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-12-12 10:31:37 +0800 |
| commit | 2fc9b476907e6fb830fd57f69d59c794548ad28b (patch) | |
| tree | b7eb0178dc2f6075ed83ae9bc6b014e756f4c820 /docs/environment-variables.md | |
| parent | 7e88e70e1783e2b03f37692e4ee84779ab6e5c62 (diff) | |
| download | llm-functions-docker-2fc9b476907e6fb830fd57f69d59c794548ad28b.tar.gz | |
refactor: add docs (#143)
Diffstat (limited to 'docs/environment-variables.md')
| -rw-r--r-- | docs/environment-variables.md | 26 |
1 files changed, 26 insertions, 0 deletions
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-functions-dir>` | +| `LLM_TOOL_NAME` | Tool name, such as `execute_command` | +| `LLM_TOOL_CACHE_DIR` | Path to `<llm-functions-dir>/cache/<tool-name>`,<br>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 `<llm-functions-dir>/agents/<agent-name>` | +| `LLM_AGENT_CACHE_DIR` | Path to `<llm-functions-dir>/cache/<agent-name>`,<br>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_<NAME>` | 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.*` | |