Skip to content

Conversation

@roomote
Copy link
Contributor

@roomote roomote bot commented Jan 23, 2026

This PR corrects the CLI README to match the actual implementation.

What Changed

The CLI README was documenting incorrect syntax using -P flag for prompts. The actual implementation uses a positional argument for prompts, not a flag.

Fixes

  • Updated all command examples to use correct syntax: roo "prompt" -w ~/workspace
  • Fixed options table to show [prompt] as positional argument
  • Added -w, --workspace flag documentation
  • Removed references to non-existent -P, --prompt flag

Before

roo ~/project -P "What is this code?"  # WRONG

After

roo "What is this code?" -w ~/project  # CORRECT

This aligns the README with the actual implementation in index.ts.


Important

Fix CLI README to use correct command syntax with positional argument for prompts instead of -P flag.

  • Behavior:
    • Corrects CLI README to use positional argument for prompts instead of -P flag.
    • Updates command examples to roo "prompt" -w ~/workspace.
    • Fixes options table to show [prompt] as positional argument.
  • Documentation:
    • Adds -w, --workspace flag documentation.
    • Removes references to non-existent -P, --prompt flag.

This description was created by Ellipsis for 1088078. You can customize this summary. It will automatically update as commits are pushed.

- Updated all examples to use positional prompt argument instead of incorrect -P flag
- Fixed options table to show [prompt] as positional argument and -w for workspace
- Corrected syntax from `roo ~/path -P "prompt"` to `roo "prompt" -w ~/path`
@roomote roomote bot requested review from cte, jr and mrubens as code owners January 23, 2026 21:17
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. Documentation Improvements or additions to documentation labels Jan 23, 2026
@roomote
Copy link
Contributor Author

roomote bot commented Jan 23, 2026

Rooviewer Clock   See task on Roo Cloud

Review complete. No issues found.

The documentation changes correctly align the README with the actual CLI implementation. Verified that [prompt] is a positional argument and -w, --workspace is the workspace flag per apps/cli/src/index.ts.

Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 23, 2026
@cte cte merged commit 1daac83 into main Jan 23, 2026
21 checks passed
@cte cte deleted the fix/cli-readme-syntax branch January 23, 2026 21:24
@github-project-automation github-project-automation bot moved this from Triage to Done in Roo Code Roadmap Jan 23, 2026
@github-project-automation github-project-automation bot moved this from New to Done in Roo Code Roadmap Jan 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants