Skip to content

Commit 958502e

Browse files
Update CLI documentation with additional details from Notion
Co-authored-by: Rushil Patel <rpatel@codegen.com>
1 parent 1e0b9af commit 958502e

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

docs/introduction/cli.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Install the Codegen CLI using pip or uv:
1919
pip install codegen
2020
# or
2121
uv pip install codegen
22+
# or
23+
uv tool install codegen
2224
```
2325

2426
## Authentication
@@ -56,7 +58,7 @@ The Codegen CLI offers several commands for different functionalities:
5658

5759
| Command | Description |
5860
| ------- | ----------- |
59-
| `agent` | Create a new agent run with a prompt |
61+
| `agent` | Create a new agent run with a prompt, fetch an existing agent run by ID, or pull PR branch |
6062
| `agents` | Manage and interact with your agents |
6163
| `claude` | Run Claude Code with OpenTelemetry monitoring and logging |
6264
| `config` | Manage configuration settings |
@@ -78,7 +80,17 @@ The Codegen CLI offers several commands for different functionalities:
7880
To create a new agent run with a prompt:
7981

8082
```bash
81-
codegen agent "Implement a function to calculate Fibonacci numbers in Python"
83+
codegen agent --prompt "Implement a function to calculate Fibonacci numbers in Python"
84+
```
85+
86+
You can also fetch an existing agent run by ID or pull a PR branch:
87+
88+
```bash
89+
# Get run details in JSON format
90+
codegen agent --id 123 --json
91+
92+
# Pull PR branch from an agent run
93+
codegen agent --id 123 pull
8294
```
8395

8496
### Managing Organizations
@@ -128,6 +140,7 @@ The CLI respects the following environment variables:
128140
| `CODEGEN_API_TOKEN` | Your Codegen API token for authentication |
129141
| `CODEGEN_API_URL` | Custom API URL (if using a self-hosted instance) |
130142
| `CODEGEN_ORG_ID` | Default organization ID |
143+
| `REPOSITORY_ORG_ID` | Organization ID for repository-specific operations |
131144

132145
## What can I do with the Codegen CLI?
133146

@@ -161,4 +174,3 @@ import {
161174
Star us on GitHub and contribute to the project.
162175
</Card>
163176
</CardGroup>
164-

0 commit comments

Comments
 (0)