Skip to content

docs: fix CLI README to use correct command syntax #10923

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.

Sign up for GitHub

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

Merged
cte merged 1 commit into from
Jan 23, 2026
Merged

docs: fix CLI README to use correct command syntax #10923

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions apps/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ By default, the CLI prompts for approval before executing actions:
```bash
export OPENROUTER_API_KEY=sk-or-v1-...

roo ~/Documents/my-project -P "What is this project?"
roo "What is this project?" -w ~/Documents/my-project
```

You can also run without a prompt and enter it interactively in TUI mode:
Expand All @@ -92,7 +92,7 @@ In interactive mode:
For automation and scripts, use `-y` to auto-approve all actions:

```bash
roo ~/Documents/my-project -y -P "Refactor the utils.ts file"
roo "Refactor the utils.ts file" -y -w ~/Documents/my-project
```

In non-interactive mode:
Expand Down Expand Up @@ -149,8 +149,8 @@ Tokens are valid for 90 days. The CLI will prompt you to re-authenticate when yo

| Option | Description | Default |
| --------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------- |
| `[workspace]` | Workspace path to operate in (positional argument) | Current directory |
| `-P, --prompt <prompt>` | The prompt/task to execute (optional in TUI mode) | None |
| `[prompt]` | Your prompt (positional argument, optional) | None |
| `-w, --workspace <path>` | Workspace path to operate in | Current directory |
| `-e, --extension <path>` | Path to the extension bundle directory | Auto-detected |
| `-d, --debug` | Enable debug output (includes detailed debug information, prompts, paths, etc) | `false` |
| `-x, --exit-on-complete` | Exit the process when task completes (useful for testing) | `false` |
Expand Down Expand Up @@ -249,7 +249,7 @@ pnpm lint
To create a new release, execute the /cli-release slash command:

```bash
roo ~/Documents/Roo-Code -P "/cli-release" -y
roo "/cli-release" -w ~/Documents/Roo-Code -y
```

The workflow will:
Expand Down
Loading