2.1 KiB
2.1 KiB
KBot Configuration Parameters
Core Configuration
| Parameter | Type | Default | Description |
|---|---|---|---|
| mode | enum (completion, tools, assistant) | tools | Chat completion mode: - 'completion': no tool support, use --dst to save output - 'tools': allows tools usage - 'assistant': supports documents (PDF, DOCX, etc.) |
| model | string | - | AI model to use for processing |
| router | string | openrouter | Router to use: openai, openrouter or deepseek |
| api_key | string | - | Explicit API key to use |
| baseURL | string | - | Base URL for the API |
Paths & Files
| Parameter | Type | Default | Description |
|---|---|---|---|
| path | string | . | Target directory |
| prompt | string | ./prompt.md | The prompt. Supports file paths and env variables |
| output | string | - | Optional output path for modified files (Tool mode only) |
| dst | string | - | Optional destination path for the result |
| preferences | string | ./.kbot/preferences.md | Path to preferences file |
| logs | string | ./.kbot | Logging directory |
| config | string | - | Path to JSON configuration file |
Tools & Filters
| Parameter | Type | Default | Description |
|---|---|---|---|
| tools | string[] | [defaultTools] | List of tools to use |
| disable | string[] | [] | Disable tools categories |
| disableTools | string[] | [] | List of specific tools to disable |
| filters | string[] | '' | Filters to apply to the output |
Other Options
| Parameter | Type | Default | Description |
|---|---|---|---|
| env | string | default | Environment (in profile) |
| logLevel | number | 2 | Logging level for the application |
| dump | string | - | Create a script |
| variables | Record<string, string> | {} | Variables to use |
| dry | boolean | false | Dry run - only write out parameters |
File Selection
| Parameter | Type | Default | Description |
|---|---|---|---|
| each | string | - | Glob pattern to run for each matching file |
| include | string[] | - | Comma separated glob patterns or paths |