diff --git a/docs/modules/usage/configuration-options.md b/docs/modules/usage/configuration-options.md index 29c9b6759507..cfebdec25aa3 100644 --- a/docs/modules/usage/configuration-options.md +++ b/docs/modules/usage/configuration-options.md @@ -7,53 +7,11 @@ If you are running in [GUI Mode](https://docs.all-hands.dev/modules/usage/how-to take precedence. ::: ---- - -# Table of Contents - -- [Core Configuration](#core-configuration) - - [API Keys](#api-keys) - - [Workspace](#workspace) - - [Debugging and Logging](#debugging-and-logging) - - [Session Management](#session-management) - - [Trajectories](#trajectories) - - [File Store](#file-store) - - [Task Management](#task-management) - - [Sandbox Configuration](#sandbox-configuration) - - [Miscellaneous](#miscellaneous) -- [LLM Configuration](#llm-configuration) - - [AWS Credentials](#aws-credentials) - - [API Configuration](#api-configuration) - - [Custom LLM Provider](#custom-llm-provider) - - [Embeddings](#embeddings) - - [Message Handling](#message-handling) - - [Model Selection](#model-selection) - - [Retrying](#retrying) - - [Advanced Options](#advanced-options) -- [Agent Configuration](#agent-configuration) - - [Microagent Configuration](#microagent-configuration) - - [Memory Configuration](#memory-configuration) - - [LLM Configuration](#llm-configuration-2) - - [ActionSpace Configuration](#actionspace-configuration) - - [Microagent Usage](#microagent-usage) -- [Sandbox Configuration](#sandbox-configuration) - - [Execution](#execution) - - [Container Image](#container-image) - - [Networking](#networking) - - [Linting and Plugins](#linting-and-plugins) - - [Dependencies and Environment](#dependencies-and-environment) - - [Evaluation](#evaluation) -- [Security Configuration](#security-configuration) - - [Confirmation Mode](#confirmation-mode) - - [Security Analyzer](#security-analyzer) - ---- - ## Core Configuration The core configuration options are defined in the `[core]` section of the `config.toml` file. -**API Keys** +### API Keys - `e2b_api_key` - Type: `str` - Default: `""` @@ -69,7 +27,7 @@ The core configuration options are defined in the `[core]` section of the `confi - Default: `""` - Description: API token secret for Modal -**Workspace** +### Workspace - `workspace_base` - Type: `str` - Default: `"./workspace"` @@ -80,7 +38,7 @@ The core configuration options are defined in the `[core]` section of the `confi - Default: `"/tmp/cache"` - Description: Cache directory path -**Debugging and Logging** +### Debugging and Logging - `debug` - Type: `bool` - Default: `false` @@ -91,13 +49,13 @@ The core configuration options are defined in the `[core]` section of the `confi - Default: `false` - Description: Disable color in terminal output -**Trajectories** +### Trajectories - `trajectories_path` - Type: `str` - Default: `"./trajectories"` - Description: Path to store trajectories (can be a folder or a file). If it's a folder, the trajectories will be saved in a file named with the session id name and .json extension, in that folder. -**File Store** +### File Store - `file_store_path` - Type: `str` - Default: `"/tmp/file_store"` @@ -128,7 +86,7 @@ The core configuration options are defined in the `[core]` section of the `confi - Default: `[".*"]` - Description: List of allowed file extensions for uploads -**Task Management** +### Task Management - `max_budget_per_task` - Type: `float` - Default: `0.0` @@ -139,7 +97,7 @@ The core configuration options are defined in the `[core]` section of the `confi - Default: `100` - Description: Maximum number of iterations -**Sandbox Configuration** +### Sandbox Configuration - `workspace_mount_path_in_sandbox` - Type: `str` - Default: `"/workspace"` @@ -155,7 +113,7 @@ The core configuration options are defined in the `[core]` section of the `confi - Default: `""` - Description: Path to rewrite the workspace mount path to. You can usually ignore this, it refers to special cases of running inside another container. -**Miscellaneous** +### Miscellaneous - `run_as_openhands` - Type: `bool` - Default: `true` @@ -182,7 +140,7 @@ The LLM (Large Language Model) configuration options are defined in the `[llm]` To use these with the docker command, pass in `-e LLM_