Skip to content

Commit 03fb39c

Browse files
BYKcodex
andauthored
fix(cli): Generate accurate command references
Keep positional syntax and examples in command metadata for help, docs, and skills. Validate agent-conversation targets before API access. Co-Authored-By: OpenAI GPT-6 Sol <noreply@openai.com>
1 parent 517f1c6 commit 03fb39c

34 files changed

Lines changed: 477 additions & 198 deletions
Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +0,0 @@
1-
2-
3-
4-
## Examples
5-
6-
### List conversations
7-
8-
```bash
9-
# List recent agent conversations
10-
sentry agent-conversation list
11-
12-
# Explicit organization
13-
sentry agent-conversation list my-org
14-
15-
# Show more, last 24 hours
16-
sentry agent-conversation list --limit 50 --period 24h
17-
18-
# Filter conversations
19-
sentry agent-conversation list -q "has:errors"
20-
21-
# Paginate through results
22-
sentry agent-conversation list my-org -c next
23-
```
24-
25-
### View a conversation transcript
26-
27-
```bash
28-
# View full transcript (org auto-detected)
29-
sentry agent-conversation view conv-123
30-
31-
# Explicit org (slash-separated)
32-
sentry agent-conversation view my-org/conv-123
33-
34-
# JSON output
35-
sentry agent-conversation view my-org/conv-123 --json
36-
```

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/SKILL.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ Authenticate with Sentry
389389
Work with Sentry organizations
390390

391391
- `sentry org list` — List organizations
392-
- `sentry org view <org>` — View details of an organization
392+
- `sentry org view [<org>]` — View details of an organization
393393

394394
→ Full flags and examples: `references/org.md`
395395

@@ -399,16 +399,16 @@ Work with Sentry projects
399399

400400
- `sentry project create [<org>/]<name>:<platform>...` — Create one or more projects
401401
- `sentry project delete <org/project>` — Delete a project
402-
- `sentry project list <org/project>` — List projects
403-
- `sentry project view <org/project>` — View details of a project
402+
- `sentry project list [<org/project>]` — List projects
403+
- `sentry project view [<org/project>]` — View details of a project
404404

405405
→ Full flags and examples: `references/project.md`
406406

407407
### Issue
408408

409409
Manage Sentry issues
410410

411-
- `sentry issue list <org/project>` — List issues in a project
411+
- `sentry issue list [<org/project>]` — List issues in a project
412412
- `sentry issue events <issue>` — List events for a specific issue
413413
- `sentry issue explain <issue...>` — Analyze one or more issues using Seer AI
414414
- `sentry issue plan <issue>` — Generate a solution plan using Seer AI
@@ -444,12 +444,12 @@ Make an authenticated API request
444444

445445
Manage Sentry alert rules
446446

447-
- `sentry alert issues list <org/project>` — List issue alert rules
447+
- `sentry alert issues list [<org/project>]` — List issue alert rules
448448
- `sentry alert issues view <org/project/rule-id-or-name>` — View an issue alert rule
449-
- `sentry alert issues create <target>` — Create an issue alert rule
449+
- `sentry alert issues create [<target>]` — Create an issue alert rule
450450
- `sentry alert issues delete <org/project/rule-id-or-name>` — Delete an issue alert rule
451451
- `sentry alert issues edit <org/project/rule-id-or-name>` — Edit an issue alert rule
452-
- `sentry alert metrics list <target>` — List metric alert rules
452+
- `sentry alert metrics list [<target>]` — List metric alert rules
453453
- `sentry alert metrics view <org/rule-id-or-name>` — View a metric alert rule
454454
- `sentry alert metrics create <target>` — Create a metric alert rule
455455
- `sentry alert metrics delete <org/rule-id-or-name>` — Delete a metric alert rule
@@ -470,14 +470,14 @@ Manage mobile build artifacts
470470

471471
CLI-related commands
472472

473-
- `sentry cli completion <shell>` — Print the shell completion script
473+
- `sentry cli completion [<shell>]` — Print the shell completion script
474474
- `sentry cli defaults <key value...>` — View and manage default settings
475475
- `sentry cli feedback <message...>` — Send feedback about the CLI
476476
- `sentry cli fix` — Diagnose and repair CLI database issues
477477
- `sentry cli import` — Import settings from legacy .sentryclirc files
478478
- `sentry cli setup` — Configure shell integration
479479
- `sentry cli uninstall` — Uninstall Sentry CLI
480-
- `sentry cli upgrade <version>` — Update the Sentry CLI to the latest version
480+
- `sentry cli upgrade [<version>]` — Update the Sentry CLI to the latest version
481481

482482
→ Full flags and examples: `references/cli.md`
483483

@@ -493,8 +493,8 @@ Manage code mappings for stack trace linking
493493

494494
List and view agent conversations
495495

496-
- `sentry agent-conversation list <org>` — List recent agent conversations
497-
- `sentry agent-conversation view <org/conversation-id>` — View an agent conversation transcript
496+
- `sentry agent-conversation list [<org>]` — List recent agent conversations
497+
- `sentry agent-conversation view [<org>/]<conversation-id>` — View an agent conversation transcript
498498

499499
→ Full flags and examples: `references/agent-conversation.md`
500500

@@ -547,7 +547,7 @@ Search and query current Sentry documentation
547547

548548
Find Sentry DSNs
549549

550-
- `sentry dsn list <org/project>` — List DSNs
550+
- `sentry dsn list [<org/project>]` — List DSNs
551551

552552
→ Full flags and examples: `references/dsn.md`
553553

@@ -581,7 +581,7 @@ Upload React Native sourcemaps from build steps
581581

582582
Search and inspect Session Replays
583583

584-
- `sentry replay list <org/project>` — List recent Session Replays
584+
- `sentry replay list [<org/project>]` — List recent Session Replays
585585
- `sentry replay view <replay-id-or-url...>` — View a Session Replay
586586
- `sentry replay download <replay-id-or-url...>` — Download a Session Replay as rrweb JSON
587587

@@ -591,14 +591,14 @@ Search and inspect Session Replays
591591

592592
Work with Sentry releases
593593

594-
- `sentry release list <org/project>` — List releases with adoption and health metrics
594+
- `sentry release list [<org/project>]` — List releases with adoption and health metrics
595595
- `sentry release view <org/version>` — View release details with health metrics
596596
- `sentry release create <org/version>` — Create a release
597597
- `sentry release finalize <org/version>` — Finalize a release
598598
- `sentry release delete <org/version>` — Delete a release
599599
- `sentry release archive <org/version>` — Archive a release
600600
- `sentry release restore <org/version>` — Restore an archived release
601-
- `sentry release deploy <org/version> <environment> <name>` — Create a deploy for a release
601+
- `sentry release deploy <org/version> <environment> [<name>]` — Create a deploy for a release
602602
- `sentry release deploys <org/version>` — List deploys for a release
603603
- `sentry release set-commits <org/version>` — Set commits for a release
604604
- `sentry release propose-version` — Propose a release version
@@ -609,31 +609,31 @@ Work with Sentry releases
609609

610610
Work with Sentry repositories
611611

612-
- `sentry repo list <org/project>` — List repositories
612+
- `sentry repo list [<org/project>]` — List repositories
613613

614614
→ Full flags and examples: `references/repo.md`
615615

616616
### Team
617617

618618
Work with Sentry teams
619619

620-
- `sentry team list <org/project>` — List teams
620+
- `sentry team list [<org/project>]` — List teams
621621

622622
→ Full flags and examples: `references/team.md`
623623

624624
### Explore
625625

626626
Query aggregate event data (Explore)
627627

628-
- `sentry explore <target>` — Query aggregate event data (Explore)
628+
- `sentry explore [<target>]` — Query aggregate event data (Explore)
629629

630630
→ Full flags and examples: `references/explore.md`
631631

632632
### Feedback
633633

634634
Manage User Feedback
635635

636-
- `sentry feedback list <org/project>` — List and search User Feedback
636+
- `sentry feedback list [<org/project>]` — List and search User Feedback
637637
- `sentry feedback view <feedback>` — View a User Feedback item
638638
- `sentry feedback resolve <feedback>` — Mark User Feedback as resolved
639639
- `sentry feedback unresolve <feedback>` — Return User Feedback to the inbox
@@ -655,7 +655,7 @@ View Sentry logs
655655
Work with Sentry cron monitors
656656

657657
- `sentry monitor run <monitor-slug command...>` — Wrap a command with cron monitor check-ins
658-
- `sentry monitor list <org/project>` — List cron monitors
658+
- `sentry monitor list [<org/project>]` — List cron monitors
659659

660660
→ Full flags and examples: `references/monitor.md`
661661

@@ -700,7 +700,7 @@ Check Sentry service status
700700

701701
View distributed traces
702702

703-
- `sentry trace list <org/project>` — List recent traces in a project
703+
- `sentry trace list [<org/project>]` — List recent traces in a project
704704
- `sentry trace view <org/project/trace-id...>` — View details of a specific trace
705705
- `sentry trace logs <org/project/trace-id...>` — View logs associated with a trace
706706

@@ -710,16 +710,16 @@ View distributed traces
710710

711711
Manage product trials
712712

713-
- `sentry trial list <org>` — List product trials
714-
- `sentry trial start <name> <org>` — Start a product trial
713+
- `sentry trial list [<org>]` — List product trials
714+
- `sentry trial start <name> [<org>]` — Start a product trial
715715

716716
→ Full flags and examples: `references/trial.md`
717717

718718
### Init
719719

720720
Initialize Sentry in your project (experimental)
721721

722-
- `sentry init <target> <directory>` — Initialize Sentry in your project (experimental)
722+
- `sentry init [<target>] [<directory>]` — Initialize Sentry in your project (experimental)
723723

724724
→ Full flags and examples: `references/init.md`
725725

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/agent-conversation.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
List and view agent conversations
1313

14-
### `sentry agent-conversation list <org>`
14+
### `sentry agent-conversation list [<org>]`
1515

1616
List recent agent conversations
1717

@@ -64,7 +64,7 @@ sentry agent-conversation list -q "has:errors"
6464
sentry agent-conversation list my-org -c next
6565
```
6666

67-
### `sentry agent-conversation view <org/conversation-id>`
67+
### `sentry agent-conversation view [<org>/]<conversation-id>`
6868

6969
View an agent conversation transcript
7070

@@ -74,10 +74,10 @@ View an agent conversation transcript
7474
**Examples:**
7575

7676
```bash
77-
# View full transcript (org auto-detected)
77+
# View full transcript (organization auto-detected)
7878
sentry agent-conversation view conv-123
7979

80-
# Explicit org (slash-separated)
80+
# Explicit organization
8181
sentry agent-conversation view my-org/conv-123
8282

8383
# JSON output

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/alert.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
Manage Sentry alert rules
1313

14-
### `sentry alert issues list <org/project>`
14+
### `sentry alert issues list [<org/project>]`
1515

1616
List issue alert rules
1717

@@ -49,7 +49,7 @@ sentry alert issues view my-org/my-project/12345
4949
sentry alert issues view my-org/my-project/"Error Spike"
5050
```
5151

52-
### `sentry alert issues create <target>`
52+
### `sentry alert issues create [<target>]`
5353

5454
Create an issue alert rule
5555

@@ -112,7 +112,7 @@ Edit an issue alert rule
112112
sentry alert issues edit my-org/my-project/12345 --name "Prod Error Spike" --status disabled
113113
```
114114

115-
### `sentry alert metrics list <target>`
115+
### `sentry alert metrics list [<target>]`
116116

117117
List metric alert rules
118118

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/cli.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
CLI-related commands
1313

14-
### `sentry cli completion <shell>`
14+
### `sentry cli completion [<shell>]`
1515

1616
Print the shell completion script
1717

@@ -172,7 +172,7 @@ sentry cli uninstall --yes --keep-config
172172
sentry cli uninstall
173173
```
174174

175-
### `sentry cli upgrade <version>`
175+
### `sentry cli upgrade [<version>]`
176176

177177
Update the Sentry CLI to the latest version
178178

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/dsn.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
Find Sentry DSNs
1313

14-
### `sentry dsn list <org/project>`
14+
### `sentry dsn list [<org/project>]`
1515

1616
List DSNs
1717

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/explore.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
Query aggregate event data (Explore)
1313

14-
### `sentry explore <target>`
14+
### `sentry explore [<target>]`
1515

1616
Query aggregate event data (Explore)
1717

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/feedback.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
Manage User Feedback
1313

14-
### `sentry feedback list <org/project>`
14+
### `sentry feedback list [<org/project>]`
1515

1616
List and search User Feedback
1717

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/init.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
Initialize Sentry in your project (experimental)
1313

14-
### `sentry init <target> <directory>`
14+
### `sentry init [<target>] [<directory>]`
1515

1616
Initialize Sentry in your project (experimental)
1717

‎packages/cli/plugins/sentry-cli/skills/sentry-cli/references/issue.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requires:
1111

1212
Manage Sentry issues
1313

14-
### `sentry issue list <org/project>`
14+
### `sentry issue list [<org/project>]`
1515

1616
List issues in a project
1717

0 commit comments

Comments
 (0)