-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Revise README for Kilo Code CLI #4727
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Updated the README to enhance clarity and provide additional information on usage, installation, and configuration options for the Kilo Code CLI.
|
✅ Previous Issues AddressedAll 5 issues from my previous review have been resolved:
1 file reviewed | Confidence: 95% | Recommendation: Merge Review DetailsFiles: cli/README.md Checked: Documentation clarity, security warnings, accuracy of feature descriptions Summary: The README revision is well-structured, concise, and addresses all previous feedback. The documentation properly warns users about security implications of |
Updated README to improve clarity and fix formatting issues.
|
|
||
| - **Light mode terminals:** Theme detection isn't automatic yet. Run `kilocode config` to switch themes. | ||
| - **Windows:** We recommend using WSL for now. Native Windows support is in progress. | ||
| - **Windows:** Not currently supported. See [#3034](https://github.com/Kilo-Org/kilocode/issues/3034) for status. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Running the CLI from PowerShell: ✅ Works - The CLI is a Node.js application that can be launched from any terminal including PowerShell
- Windows directories: ✅ Works - The CLI has proper Windows path handling (AppData/Roaming/Code/...) and Windows-specific commands (cmd /c start)
- Linux: ✅ Works - Proper Linux path handling and commands (xdg-open)
- Mac: Works
- WSL in Unix dirs: Limited - Path translation between Windows and WSL Unix paths cause issues
tl;dr The CLI runs on Windows/PowerShell/Linux/Mac, but WSL Unix paths cause issues
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@marius-kilocode Good to go now?
Updated the README to enhance clarity and provide additional information on usage, installation, and configuration options for the Kilo Code CLI.
Context
Updated the public CLI npm page for readability, conciseness, and appeal