docs: fix CLI config file path to use XDG convention#5735
docs: fix CLI config file path to use XDG convention#5735kiloconnect[bot] wants to merge 1 commit intomainfrom
Conversation
Code Review SummaryStatus: 4 Issues Found | Recommendation: Address before merge Overview
Fix these issues in Kilo Cloud Issue Details (click to expand)WARNING
Files Reviewed (1 files) |
|
fa3a8bf to
9462d59
Compare
|
|
||
| - `/connect` command for provider setup (interactive) | ||
| - Config files directly at `~/.kilocode/config.json` | ||
| - Config files directly at `~/.config/kilo/config.json` |
There was a problem hiding this comment.
WARNING: Config path in docs doesn’t match current CLI config location
The CLI currently uses cli/src/config/persistence.ts:18 (~/.kilocode/cli/config.json by default). Pointing users at ~/.config/kilo/config.json will likely cause confusion unless the CLI has been updated to use XDG paths as well.
| - Config files directly at `~/.config/kilo/config.json` | |
| - Config files directly at `~/.kilocode/cli/config.json` |
| ## Auto-approval Settings | ||
|
|
||
| Auto-approval allows the Kilo Code CLI to perform operations without first requiring user confirmation. These settings can either be built up over time in interactive mode, or by editing your config file directly at `~/.kilocode/config.json`. | ||
| Auto-approval allows the Kilo Code CLI to perform operations without first requiring user confirmation. These settings can either be built up over time in interactive mode, or by editing your config file directly at `~/.config/kilo/config.json`. |
There was a problem hiding this comment.
WARNING: Auto-approval section references a config path the CLI may not use
Same mismatch as above: the default config file path is derived from cli/src/config/persistence.ts:18. If the docs intend to describe an XDG path, it would be good to either document both paths (legacy vs XDG) or align the CLI implementation.
| Auto-approval allows the Kilo Code CLI to perform operations without first requiring user confirmation. These settings can either be built up over time in interactive mode, or by editing your config file directly at `~/.config/kilo/config.json`. | |
| Auto-approval allows the Kilo Code CLI to perform operations without first requiring user confirmation. These settings can either be built up over time in interactive mode, or by editing your config file directly at `~/.kilocode/cli/config.json`. |
- Update CLI config file path from ~/.kilocode/config.json to ~/.config/kilo/config.json - Replace outdated auto-approval section with permissions system from OpenCode docs - Revert MCP settings path changes (kept as-is)
9462d59 to
6c08236
Compare
| "enabled": false, | ||
| "timeout": 60 | ||
| "$schema": "https://kilo.ai/config.json", | ||
| "permission": { |
There was a problem hiding this comment.
WARNING: permission config examples don’t match the CLI config schema
This doc section shows a top-level permission key, but the CLI config schema currently defines autoApproval (and does not appear to accept permission). As written, users may add permission to their config and see no effect.
References: packages/core-schemas/src/config/cli-config.ts (expects autoApproval), and CLI config persistence defaults to a config.json that is merged/validated against that schema in cli/src/config/persistence.ts.
| "delay": 10 | ||
| "edit": { | ||
| "*": "deny", | ||
| "packages/web/src/content/docs/*.mdx": "allow" |
There was a problem hiding this comment.
WARNING: Example path in permissions snippet doesn’t exist in this repo
packages/web/src/content/docs/*.mdx doesn’t appear to be a path in this repository, so readers copying this example will likely end up with a rule that never matches. Consider using a path that exists under apps/kilocode-docs/ (or replace with a clearly-marked placeholder).
| "packages/web/src/content/docs/*.mdx": "allow" | |
| "apps/kilocode-docs/pages/**/*.md": "allow" |
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://kilo.ai/config.json", |
There was a problem hiding this comment.
The schema doesn't exist yet. I see two options:
- We continue with this and commit to providing this the future
- We link to the upstream schema opencode.ai/config.json
Summary
~/.kilocode/config.jsonto~/.config/kilo/config.jsonChanges
apps/kilocode-docs/pages/code-with-ai/platforms/cli.md:~/.config/kilo/config.jsonMCP settings path left unchanged (not part of this fix).
Built for josh by Kilo for Slack