Skip to content

Commit 9d6c5f9

Browse files
authored
docs: add CLI options reference to README (#331)
1 parent c9c6980 commit 9d6c5f9

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,33 @@ Then just tell Codebuff what you want and it handles the rest:
4848

4949
Codebuff will find the right files, makes changes across your codebase, and runs tests to make sure nothing breaks.
5050

51+
### CLI Options
52+
53+
Control how Codebuff runs with these flags:
54+
55+
**Quality & Performance**:
56+
- `--lite` - Use budget models and fetch fewer files (faster, lower cost)
57+
- `--max` - Use higher quality models and fetch more files (thorough, slower)
58+
59+
**Modes**:
60+
- `--ask` - Ask mode, won't change code (safe for exploration)
61+
- `--print, -p` - Print-only mode, run once and exit (for scripts/CI)
62+
63+
**Agent Control**:
64+
- `--agent <id>` - Run specific agent (e.g., `--agent file-picker`)
65+
- `--spawn <id>` - Spawn agent directly (e.g., `--spawn reviewer`)
66+
- `--params <json>` - Pass JSON parameters to agent
67+
68+
**Debugging**:
69+
- `--trace` - Log all subagent activity to `.agents/traces/*.log`
70+
- `--cwd <dir>` - Run in specific directory instead of current
71+
72+
**Project Setup**:
73+
- `--init` - Initialize Codebuff for your project
74+
- `--create <template>` - Create new project from template
75+
76+
Run `codebuff --help` for full details and examples.
77+
5178
## Create custom agents
5279

5380
To get started building your own agents, run:

0 commit comments

Comments
 (0)