Skip to content

Conversation

@bturcotte520
Copy link
Contributor

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

Updated the README to enhance clarity and provide additional information on usage, installation, and configuration options for the Kilo Code CLI.
@changeset-bot
Copy link

changeset-bot bot commented Dec 30, 2025

⚠️ No Changeset found

Latest commit: 7385e36

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@kiloconnect
Copy link
Contributor

kiloconnect bot commented Dec 30, 2025

✅ Previous Issues Addressed

All 5 issues from my previous review have been resolved:

  • ✓ Added --yolo mode documentation with sandbox warning
  • ✓ Added Tab autocomplete hint for /model select
  • ✓ Added security warning for autonomous mode
  • ✓ Updated Windows support to reference issue kilocode config under WSL #3034 (not just WSL workaround)
  • ✓ Included --yolo flag in Quick start section

1 file reviewed | Confidence: 95% | Recommendation: Merge

Review Details

Files: 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 --yolo and autonomous modes.

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.
Copy link
Collaborator

@marius-kilocode marius-kilocode Dec 30, 2025

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

Copy link
Contributor Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants