docs(cli): add configuration section referencing OpenCode docs#5679
docs(cli): add configuration section referencing OpenCode docs#5679kiloconnect[bot] wants to merge 1 commit intomainfrom
Conversation
Add a concise configuration section to the CLI documentation that: - Documents config file locations (global and project-level) - Shows key configuration options with examples - Explains variable substitution syntax - Links to OpenCode docs for comprehensive coverage Since Kilo CLI is a fork of OpenCode, it supports the same JSON configuration format. This update helps users understand the configuration options without duplicating OpenCode's documentation.
|
![kiloconnect[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
|
|
||
| | Scope | Location | | ||
| |-------|----------| | ||
| | Global | `~/.kilocode/config.json` | |
There was a problem hiding this comment.
WARNING: Global config path looks incorrect for the CLI
cli/src/config/persistence.ts uses ~/.kilocode/cli/config.json (via CONFIG_DIR/CONFIG_FILE), but this table lists ~/.kilocode/config.json. Users following this doc will likely edit the wrong file.
| | Global | `~/.kilocode/config.json` | | |
| | Global | `~/.kilocode/cli/config.json` | |
|
|
||
| - **Interactive CLI**: Run `kilocode config` or use `/config` during a session | ||
| - **Configuration file**: Edit `~/.kilocode/config.json` directly | ||
| - **Project-level config**: Create `kilocode.json` in your project root |
There was a problem hiding this comment.
WARNING: Project-level kilocode.json config may not be supported
I couldn’t find any CLI code paths that read ./kilocode.json (searching the CLI source for kilocode.json returns no hits). Current config persistence appears to be centered on a single home-directory config file. If project config isn’t implemented yet, consider clarifying/removing this to avoid users assuming it works.
|
|
||
| ### Key Configuration Options | ||
|
|
||
| ```json |
There was a problem hiding this comment.
WARNING: Example config format/options don’t match the current CLI config schema
The CLI config code uses a providers: [...] array + a selected provider id (see cli/src/config/persistence.ts + cli/src/config/mapper.ts), whereas this example shows a provider: { anthropic: { ... } } map and includes permission/instructions. This may be copy-pasted and then fail validation / be silently ignored. Consider either updating the example to match the actual CLI schema or explicitly labeling it as OpenCode-only.
|
|
||
| ### Variable Substitution | ||
|
|
||
| Config files support variable substitution: |
There was a problem hiding this comment.
WARNING: {env:...} / {file:...} variable substitution may not be implemented
I couldn’t find config placeholder substitution in the CLI config loader; if this isn’t supported, readers may expect placeholders like {env:ANTHROPIC_API_KEY} to work and end up with invalid config. Consider confirming support in code or adjusting the docs to recommend standard environment variable usage instead.
Code Review SummaryStatus: 4 Issues Found | Recommendation: Address before merge Overview
Issue Details (click to expand)WARNING
Files Reviewed (1 files)
|
2 participants
Summary
Add a concise configuration section to the CLI documentation that helps users understand how to configure Kilo CLI.
Changes
~/.kilocode/config.jsonand project-levelkilocode.json){env:VAR}and{file:path})Context
Since Kilo CLI is a fork of OpenCode, it supports the same JSON configuration format. Rather than duplicating all of OpenCode's documentation, this update provides a concise overview of the key options and links to OpenCode's docs for full details.
Testing
Documentation-only change - no code changes.
Built for Brendan by Kilo for Slack