From d2e3aa2923800ec3bb3cc60cc8c1dba00812771d Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Mon, 6 Apr 2026 12:14:36 +0000 Subject: [PATCH 1/3] docs: add documentation gap audit report MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Miguel Betegón --- docs/DOCS-GAP-REPORT.md | 336 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 336 insertions(+) create mode 100644 docs/DOCS-GAP-REPORT.md diff --git a/docs/DOCS-GAP-REPORT.md b/docs/DOCS-GAP-REPORT.md new file mode 100644 index 000000000..03a8ab572 --- /dev/null +++ b/docs/DOCS-GAP-REPORT.md @@ -0,0 +1,336 @@ +# Documentation Gap Report + +_Generated: 2026-04-06 | Branch: `cursor/sentry-cli-docs-gaps-3d35`_ + +This report identifies gaps between the Sentry CLI implementation and its documentation across all surfaces: the Astro doc site (`docs/src/content/docs/`), `README.md`, `DEVELOPMENT.md`, and `AGENTS.md`. + +--- + +## A. Undocumented or Missing Commands/Subcommands + +### Missing from `ROUTE_TO_REFERENCE` in `script/generate-skill.ts` + +The `release` and `sourcemap` routes in `src/app.ts` are **not present** in the `ROUTE_TO_REFERENCE` map. This means they fall through to the default (`route.name` used as-is), producing reference files named `release.md` and `sourcemap.md` instead of being grouped with a `REFERENCE_TITLES` entry. + +| Route | Expected in `ROUTE_TO_REFERENCE`? | Has `REFERENCE_TITLES` entry? | Generated ref file | +|-------|-----------------------------------|-------------------------------|--------------------| +| `release` | **No** — missing | **No** — no title like "Release Commands" | `release.md` (untitled group) | +| `sourcemap` | **No** — missing | **No** — no title | `sourcemap.md` (untitled group) | + +**Source:** `script/generate-skill.ts` lines 94–111 (map), lines 114–127 (titles) +**Impact:** Generated skill reference files for releases and sourcemaps have no descriptive title, just a fallback. + +### `sentry release propose-version` — No bash example in docs + +The `release.md` doc page covers `propose-version` in the command table, but the examples section does show a usage example: `sentry release create $(sentry release propose-version)`. This is adequate. + +### `sentry issue events` — Not in README command table + +The README `Commands` table lists `sentry issue` as "List, view, explain, and plan issues" but does **not mention** the `events` subcommand. The doc site's `issue.md` does document it. + +**Source:** `README.md` line 76; `src/commands/issue/events.ts` +**Doc file:** `docs/src/content/docs/commands/issue.md` (covered); `README.md` (gap) + +### `sentry dashboard widget` subcommands — Not in README command table + +The README lists `sentry dashboard` as "List, view, and create dashboards with widgets" but omits the `widget add`, `widget edit`, and `widget delete` subcommands from the description. + +**Source:** `README.md` line 81; `src/commands/dashboard/widget/` + +### Missing from README: `sentry release`, `sentry repo`, `sentry team` + +The README command table is missing the following command groups that exist in both code and docs: + +| Command | In code? | In doc site? | In README? | +|---------|----------|--------------|------------| +| `sentry release` | Yes | Yes (`release.md`) | **No** | +| `sentry repo` | Yes | Yes (`repo.md`) | **No** | +| `sentry team` | Yes | Yes (`team.md`) | **No** | + +**Source:** `src/app.ts` routes; `README.md` lines 69–87 + +--- + +## B. Undocumented Flags + +### `sentry auth login --force` + +The code defines a `force` flag (boolean, brief: "Re-authenticate without prompting"). The doc page at `auth.md` documents `--force` correctly. **No gap.** + +### `sentry cli feedback` — brief differs + +- **Code brief:** `"Send feedback to the Sentry team"` +- **Doc brief:** `"Send feedback about the CLI"` + +Minor wording difference. Not a functional gap. + +### `sentry log list` — `--cursor` flag + +The `log list` command sets `noCursorFlag: true`, so it does **not** have a `--cursor` flag. The doc page correctly omits it. **No gap.** + +### `sentry log list` — `-f` alias for `--fresh` + +The code assigns `-f` to `--follow` (not `--fresh`) for `log list`. The `--fresh` flag exists but has **no short alias**. The doc page shows `--fresh` with no alias, which is correct. + +### `sentry org list` — no `--cursor` flag + +`org list` does not define a `--cursor` flag. The doc page correctly omits it. **No gap.** + +### `sentry sourcemap upload` — missing `--org` / `--project` docs + +The `sourcemap upload` command resolves org/project via `resolveOrgAndProject()`, but the doc page only shows `--release` and `--url-prefix` flags. The positional `` is documented. Users may need to specify org/project via env vars or positional when auto-detect fails, but the docs don't explain this resolution path. + +**Source:** `src/commands/sourcemap/upload.ts` +**Doc file:** `docs/src/content/docs/commands/sourcemap.md` + +--- + +## C. Missing Usage Examples + +### `sentry release deploy` — no example with optional flags + +The doc page shows basic `sentry release deploy 1.0.0 production` examples, but does not show examples for `--url`, `--started`, `--finished`, or `--time` flags. + +**Source:** `src/commands/release/deploy.ts` +**Doc file:** `docs/src/content/docs/commands/release.md` + +### `sentry release deploys` — no example + +The doc page lists the command but has no dedicated bash example. The general examples section covers it indirectly but doesn't show the `deploys` subcommand standalone. + +### `sentry release delete` — no example + +No bash example for `sentry release delete`. The examples only show create/finalize/deploy workflow. + +**Doc file:** `docs/src/content/docs/commands/release.md` + +--- + +## D. Stale Descriptions + +### `sentry cli feedback` + +| Source | Brief | +|--------|-------| +| Code (`cli/feedback.ts`) | `"Send feedback to the Sentry team"` | +| Doc (`cli.md`) | `"Send feedback about the CLI"` | + +Minor wording difference, but the code version is more accurate. + +### `sentry dashboard` description in `commands/index.md` + +| Source | Description | +|--------|-------------| +| `commands/index.md` | "Manage Sentry dashboards" | +| Code route brief | "Manage Sentry dashboards" | + +**No gap** for this one. + +### `sentry init` — description in `commands/index.md` + +| Source | Description | +|--------|-------------| +| `commands/index.md` | "Initialize Sentry in your project (experimental)" | +| Code brief | "Initialize Sentry in your project (experimental)" | + +**No gap.** + +--- + +## E. Missing Route Mappings in Skill Generator + +The `ROUTE_TO_REFERENCE` map in `script/generate-skill.ts` is **missing**: + +| Route in `src/app.ts` | Present in `ROUTE_TO_REFERENCE`? | Generated file | +|------------------------|----------------------------------|----------------| +| `release` | **No** | Falls back to `release.md` (no title in `REFERENCE_TITLES`) | +| `sourcemap` | **No** | Falls back to `sourcemap.md` (no title in `REFERENCE_TITLES`) | +| `help` | **No** | Falls back to `help.md` (acceptable — help is special) | + +The `release` and `sourcemap` routes should be added to both `ROUTE_TO_REFERENCE` and `REFERENCE_TITLES` for proper generated skill documentation. + +**Source:** `script/generate-skill.ts` lines 94–127 + +--- + +## F. Installation / Distribution Gaps + +### 1. Installer flags not fully documented + +The `install` bash script accepts these flags: + +| Flag | Documented in getting-started.mdx? | Documented in README? | +|------|-------------------------------------|----------------------| +| `--version ` | Yes | Yes (inline) | +| `--no-modify-path` | **No** | **No** | +| `--no-completions` | **No** | **No** | +| `-h` / `--help` | **No** | **No** | + +**Source:** `install` script usage function +**Doc file:** `docs/src/content/docs/getting-started.mdx`, `README.md` + +### 2. `SENTRY_CLI_NO_TELEMETRY` suppresses installer error reporting + +The install script checks `SENTRY_CLI_NO_TELEMETRY=1` to disable fire-and-forget error reporting. This is documented in `configuration.md` but not mentioned in the getting-started page's install script section. + +### 3. Windows support not mentioned in docs + +The install script supports Windows (MINGW/MSYS/CYGWIN detection), but **none of the documentation** mentions Windows as a supported platform. The install script, `.craft.yml`, and build scripts all produce Windows x64 binaries. + +**Source:** `install` script lines 128–151; `script/build.ts` targets +**Doc file:** `getting-started.mdx`, `README.md` (no mention) + +### 4. `pnpm dlx`, `yarn dlx`, `bunx` run-without-installing not in README + +The getting-started page shows `pnpm dlx`, `yarn dlx`, `bunx` via the `PackageManagerCode` component, but the README only shows `npx sentry@latest`. Missing alternatives. + +**Source:** `docs/src/content/docs/getting-started.mdx` line 58–63 +**Doc file:** `README.md` line 43 + +### 5. `yarn` as install method mentioned in getting-started but not README + +The getting-started page includes `yarn global add sentry`, but the README does not list yarn. + +--- + +## G. Undocumented Environment Variables + +The following `SENTRY_*` variables are referenced in `src/` but **not documented** in `docs/src/content/docs/configuration.md`: + +| Variable | Location in code | Purpose | +|----------|-----------------|---------| +| `SENTRY_RELEASE` | `src/commands/release/propose-version.ts` | Used by `release propose-version` to get release version from env | +| `SENTRY_MAX_PAGINATION_PAGES` | `src/lib/api/infrastructure.ts` | Override max pagination pages (default: 50) | +| `SENTRY_CLI_NO_AUTO_REPAIR` | `src/lib/db/schema.ts` | Disable automatic SQLite schema repair | +| `SENTRY_OUTPUT_FORMAT` | `src/lib/command.ts`, `src/lib/sdk-invoke.ts` | Internal: forces JSON output (used by SDK invoke) | + +### Already documented (for completeness): + +| Variable | In `configuration.md`? | +|----------|----------------------| +| `SENTRY_AUTH_TOKEN` | Yes | +| `SENTRY_TOKEN` | Yes | +| `SENTRY_HOST` | Yes | +| `SENTRY_URL` | Yes | +| `SENTRY_ORG` | Yes | +| `SENTRY_PROJECT` | Yes | +| `SENTRY_DSN` | Yes | +| `SENTRY_CLIENT_ID` | Yes | +| `SENTRY_CONFIG_DIR` | Yes | +| `SENTRY_VERSION` | Yes | +| `SENTRY_PLAIN_OUTPUT` | Yes | +| `NO_COLOR` | Yes | +| `SENTRY_CLI_NO_TELEMETRY` | Yes | +| `SENTRY_LOG_LEVEL` | Yes | +| `SENTRY_CLI_NO_UPDATE_CHECK` | Yes | +| `SENTRY_INSTALL_DIR` | Yes | +| `SENTRY_NO_CACHE` | Yes | + +--- + +## H. Auth / Self-Hosted Gaps + +### 1. OAuth scopes: `team:write` missing from DEVELOPMENT.md + +The code requests these scopes (`src/lib/oauth.ts` line 53–63): +``` +project:read, project:write, project:admin, org:read, event:read, event:write, member:read, team:read, team:write +``` + +But `DEVELOPMENT.md` lists only: +``` +project:read, project:write, project:admin, org:read, event:read, event:write, member:read, team:read +``` + +**Missing: `team:write`** — required for team management operations. + +**Source:** `src/lib/oauth.ts` line 62 +**Doc file:** `DEVELOPMENT.md` line 63 + +### 2. Self-hosted doc missing minimum version for `--token` fallback + +`docs/src/content/docs/self-hosted.md` documents that OAuth requires Sentry 26.1.0+, and offers `--token` as fallback for older instances. However, it does not specify any minimum version requirement for the token-based flow, which could mislead users of very old instances. + +### 3. `SENTRY_HOST` vs `SENTRY_URL` precedence not in self-hosted.md table + +The self-hosted doc's environment variable table says `SENTRY_HOST` "takes precedence over `SENTRY_URL`" but doesn't make this explicit for the `SENTRY_CLIENT_ID` flow. The code in `constants.ts` reads `SENTRY_HOST` first, then `SENTRY_URL`, which is correctly described in `configuration.md` but could be clearer in the self-hosted guide. + +### 4. Token storage path shown as `~/.sentry/` but actual file is `~/.sentry/cli.db` + +`README.md` says "Credentials are stored in `~/.sentry/`" (line 92), and `auth.md` says "Auth tokens are stored in a SQLite database at `~/.sentry/cli.db`" (line 139). The README should mention the specific filename for clarity. + +--- + +## I. Plugin/Skills Gaps + +### 1. Cursor support: `agent-skills.ts` only auto-installs for Claude Code + +The code (`src/lib/agent-skills.ts`) only auto-installs skills for **Claude Code** (detects `~/.claude` directory). It does **not** auto-install for Cursor or any other IDE. + +However, `plugins/README.md` states that skills are "automatically available in `.cursor/skills/`" for Cursor users, suggesting the repo layout provides them — but the actual `.cursor/skills/` directory is **not present** in the current repository tree. Only `.cursor/rules/` exists. + +**Source:** `src/lib/agent-skills.ts`; `plugins/README.md` + +### 2. `agentic-usage.md` says "Claude Code" but setup actually supports any `~/.claude` user + +The `agentic-usage.md` page mentions "AI coding agents like Claude Code" and says to use `npx skills add https://cli.sentry.dev`. This is a different installation path than what `sentry cli setup` does internally (which embeds skills, no HTTP fetch). + +The doc should distinguish between: +- **`sentry cli setup`** → auto-installs embedded skills for Claude Code +- **`npx skills add`** → external tool for any agent that supports the skills protocol + +### 3. `plugins/README.md` references `claude plugin marketplace add` — undocumented elsewhere + +The `plugins/README.md` describes Claude Code marketplace installation: +``` +claude plugin marketplace add getsentry/cli +claude plugin install sentry/cli +``` + +This is not mentioned in `agentic-usage.md`, `README.md`, or any doc site page. + +### 4. Plugin manifest version stale + +`plugins/sentry-cli/.claude-plugin/plugin.json` has `"version": "0.25.0"` while `package.json` has `"version": "0.25.0-dev.0"`. These should stay in sync. The version in the plugin manifest lacks the `-dev.0` suffix, but more importantly, it should be updated when releases are cut. + +--- + +## J. README / DEVELOPMENT.md Drift + +### 1. `DEVELOPMENT.md` OAuth scopes missing `team:write` + +As noted in Section H.1, the scopes list in `DEVELOPMENT.md` is missing `team:write`. The code requests 9 scopes; the doc lists 8. + +**Source:** `DEVELOPMENT.md` line 63; `src/lib/oauth.ts` lines 53–63 + +### 2. `DEVELOPMENT.md` environment variable table missing `SENTRY_AUTH_TOKEN` + +The `DEVELOPMENT.md` environment variable table only lists `SENTRY_CLIENT_ID`, `SENTRY_HOST`, and `SENTRY_URL`. It does not mention `SENTRY_AUTH_TOKEN` or `SENTRY_TOKEN`, which are the primary authentication mechanisms for CI/CD and are documented in `configuration.md`. + +**Source:** `DEVELOPMENT.md` lines 70–74 + +### 3. `README.md` — `bun add -g sentry` vs `bun install -g sentry` + +The README uses `bun add -g sentry` (line 36), which is correct Bun syntax. The `cli.md` docs page mentions `bun install -g sentry` in the detection table (line 126), which is an alias but less canonical. + +### 4. `README.md` — missing `sentry release`, `sentry repo`, `sentry team` from command table + +As noted in Section A, three command groups present in code and docs are missing from the README command table. + +### 5. `README.md` — Bun version claim + +README says "Bun v1.0+" as prerequisite (line 135). `package.json` declares `"packageManager": "bun@1.3.11"`. While v1.0 may work as a minimum, the actual development version is significantly newer. + +--- + +## Top 5 Most Impactful Fixes + +1. **Add `release` and `sourcemap` to `ROUTE_TO_REFERENCE` in skill generator** — These are major command groups (8+ subcommands for release) that lack proper titles and grouping in generated skill files. Affects AI agent usability. + +2. **Add missing `SENTRY_*` env vars to `configuration.md`** — `SENTRY_RELEASE`, `SENTRY_MAX_PAGINATION_PAGES`, and `SENTRY_CLI_NO_AUTO_REPAIR` are all user-facing environment variables that are undocumented. `SENTRY_RELEASE` is especially important for the `propose-version` command. + +3. **Fix OAuth scopes in `DEVELOPMENT.md`** — Missing `team:write` means contributors creating OAuth apps will have insufficient permissions, causing mysterious 403 errors on team operations. + +4. **Add `sentry release`, `sentry repo`, `sentry team` to README command table** — These are production-ready commands that users won't discover from the README. Release management is a critical CI/CD workflow. + +5. **Document installer `--no-modify-path` and `--no-completions` flags** — These are essential for CI/CD and Docker environments where PATH modification and shell completion are unwanted. Currently only discoverable via `install --help`. From 44ffe2f1c2ed8c358f01ed606a0830d53f46e589 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Mon, 6 Apr 2026 12:16:31 +0000 Subject: [PATCH 2/3] docs: fix top 5 documentation gaps from audit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add release and sourcemap to ROUTE_TO_REFERENCE in skill generator with proper titles and descriptions (script/generate-skill.ts) - Add SENTRY_RELEASE, SENTRY_MAX_PAGINATION_PAGES, and SENTRY_CLI_NO_AUTO_REPAIR to configuration.md - Fix OAuth scopes: add missing team:write to DEVELOPMENT.md and self-hosted.md - Add sentry release, repo, team, trial to README command table - Document installer --no-modify-path and --no-completions flags in getting-started.mdx - Fix bun install -> bun add in cli.md detection table - Add yarn to cli.md detection table Co-authored-by: Miguel Betegón --- DEVELOPMENT.md | 2 +- README.md | 8 ++++++-- docs/src/content/docs/commands/cli.md | 3 ++- docs/src/content/docs/configuration.md | 24 +++++++++++++++++++++++ docs/src/content/docs/getting-started.mdx | 12 ++++++++++++ docs/src/content/docs/self-hosted.md | 2 +- script/generate-skill.ts | 6 ++++++ 7 files changed, 52 insertions(+), 5 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 9752df857..5a620c219 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -63,7 +63,7 @@ When creating your Sentry OAuth application: - `org:read` - `event:read`, `event:write` - `member:read` - - `team:read` + - `team:read`, `team:write` ## Environment Variables diff --git a/README.md b/README.md index b0fff6054..db890d206 100644 --- a/README.md +++ b/README.md @@ -73,13 +73,17 @@ sentry issue plan PROJ-ABC | `sentry auth` | Login, logout, check authentication status | | `sentry org` | List and view organizations | | `sentry project` | List, view, create, and delete projects | -| `sentry issue` | List, view, explain, and plan issues | +| `sentry issue` | List, view, explain, plan issues, and list events | | `sentry event` | View event details | | `sentry trace` | List and view distributed traces | | `sentry span` | List and view spans | | `sentry log` | List and view logs (with streaming) | -| `sentry dashboard` | List, view, and create dashboards with widgets | +| `sentry release` | Create, finalize, deploy, and manage releases | +| `sentry dashboard` | List, view, create dashboards and manage widgets | | `sentry sourcemap` | Inject debug IDs and upload sourcemaps | +| `sentry team` | List teams in an organization | +| `sentry repo` | List repositories in an organization | +| `sentry trial` | List and start product trials | | `sentry init` | Initialize Sentry in your project | | `sentry schema` | Browse the Sentry API schema | | `sentry api` | Make direct API requests | diff --git a/docs/src/content/docs/commands/cli.md b/docs/src/content/docs/commands/cli.md index 9f3d2cc96..0331115bf 100644 --- a/docs/src/content/docs/commands/cli.md +++ b/docs/src/content/docs/commands/cli.md @@ -123,7 +123,8 @@ The CLI detects how it was installed and uses the appropriate upgrade method: | brew | Binary in a Homebrew Cellar (`brew install getsentry/tools/sentry`) | | npm | Globally installed via `npm install -g sentry` | | pnpm | Globally installed via `pnpm add -g sentry` | -| bun | Globally installed via `bun install -g sentry` | +| bun | Globally installed via `bun add -g sentry` | +| yarn | Globally installed via `yarn global add sentry` | Nightly builds are only available as standalone binaries (via the curl install method). Switching to nightly from a package manager install will automatically migrate to a standalone binary. diff --git a/docs/src/content/docs/configuration.md b/docs/src/content/docs/configuration.md index 6d5278a45..b46066f5c 100644 --- a/docs/src/content/docs/configuration.md +++ b/docs/src/content/docs/configuration.md @@ -155,6 +155,30 @@ Disable API response caching. When set, the CLI will not cache API responses and export SENTRY_NO_CACHE=1 ``` +### `SENTRY_RELEASE` + +Used by `sentry release propose-version` to propose a release version. When set, `propose-version` returns this value instead of reading from CI environment variables or git. + +```bash +export SENTRY_RELEASE=1.0.0 +``` + +### `SENTRY_MAX_PAGINATION_PAGES` + +Override the maximum number of pages the CLI will fetch when auto-paginating API responses. Defaults to 50. Only needed in rare cases with extremely large datasets. + +```bash +export SENTRY_MAX_PAGINATION_PAGES=100 +``` + +### `SENTRY_CLI_NO_AUTO_REPAIR` + +Disable automatic SQLite database schema repair. By default, the CLI auto-repairs its local database when schema mismatches are detected. Set this to skip automatic repair (useful for debugging). + +```bash +export SENTRY_CLI_NO_AUTO_REPAIR=1 +``` + ## Global Options These flags are accepted by every command. They are not shown in individual command `--help` output, but are always available. diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx index 3f697471e..e9dc7dce6 100644 --- a/docs/src/content/docs/getting-started.mdx +++ b/docs/src/content/docs/getting-started.mdx @@ -36,6 +36,18 @@ The `--version` flag takes precedence over `SENTRY_VERSION` if both are set. The chosen channel is persisted so that `sentry cli upgrade` automatically tracks the same channel on future updates. +#### Installer Flags + +| Flag | Description | +|------|-------------| +| `--version ` | Pin a specific version or use `nightly` | +| `--no-modify-path` | Skip adding the binary to your shell PATH | +| `--no-completions` | Skip shell completion installation | + +The `--no-modify-path` and `--no-completions` flags are useful in CI/CD +pipelines, Docker images, and other non-interactive environments where +PATH modification and shell completions are unnecessary. + ### Homebrew ```bash diff --git a/docs/src/content/docs/self-hosted.md b/docs/src/content/docs/self-hosted.md index 00fc0e9fd..92935c1d2 100644 --- a/docs/src/content/docs/self-hosted.md +++ b/docs/src/content/docs/self-hosted.md @@ -44,7 +44,7 @@ export SENTRY_CLIENT_ID=your-client-id If your instance is on an older version or you prefer not to create an OAuth application, you can use an API token instead: 1. Go to **Settings → Developer Settings → Personal Tokens** in your Sentry instance (or visit `https://sentry.example.com/settings/account/api/auth-tokens/new-token/`) -2. Create a new token with the following scopes: `project:read`, `project:write`, `project:admin`, `org:read`, `event:read`, `event:write`, `member:read`, `team:read` +2. Create a new token with the following scopes: `project:read`, `project:write`, `project:admin`, `org:read`, `event:read`, `event:write`, `member:read`, `team:read`, `team:write` 3. Pass it to the CLI: ```bash diff --git a/script/generate-skill.ts b/script/generate-skill.ts index 32e34e03e..5e68d3c12 100644 --- a/script/generate-skill.ts +++ b/script/generate-skill.ts @@ -105,6 +105,8 @@ const ROUTE_TO_REFERENCE: Record = { trace: "traces", span: "traces", trial: "trials", + release: "releases", + sourcemap: "sourcemaps", cli: "setup", init: "setup", schema: "setup", @@ -123,6 +125,8 @@ const REFERENCE_TITLES: Record = { logs: "Log Commands", traces: "Trace & Span Commands", trials: "Trial Commands", + releases: "Release Commands", + sourcemaps: "Sourcemap Commands", setup: "CLI Setup Commands", }; @@ -139,6 +143,8 @@ const REFERENCE_DESCRIPTIONS: Record = { logs: "List and stream logs from Sentry projects", traces: "List and inspect traces and spans for performance analysis", trials: "List and start product trials", + releases: "Create, finalize, deploy, and manage Sentry releases", + sourcemaps: "Inject debug IDs and upload sourcemaps to Sentry", setup: "Configure the CLI, install integrations, and manage upgrades", }; From 15c476005818e6c5bd48be41051369c64753ac4c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 6 Apr 2026 12:17:34 +0000 Subject: [PATCH 3/3] chore: regenerate skill files and command docs --- docs/public/.well-known/skills/index.json | 4 ++-- plugins/sentry-cli/skills/sentry-cli/SKILL.md | 4 ++-- .../sentry-cli/references/{release.md => releases.md} | 6 +++--- .../sentry-cli/references/{sourcemap.md => sourcemaps.md} | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) rename plugins/sentry-cli/skills/sentry-cli/references/{release.md => releases.md} (96%) rename plugins/sentry-cli/skills/sentry-cli/references/{sourcemap.md => sourcemaps.md} (91%) diff --git a/docs/public/.well-known/skills/index.json b/docs/public/.well-known/skills/index.json index 2ddb8279c..b7f7e73bf 100644 --- a/docs/public/.well-known/skills/index.json +++ b/docs/public/.well-known/skills/index.json @@ -13,9 +13,9 @@ "references/logs.md", "references/organizations.md", "references/projects.md", - "references/release.md", + "references/releases.md", "references/setup.md", - "references/sourcemap.md", + "references/sourcemaps.md", "references/teams.md", "references/traces.md", "references/trials.md" diff --git a/plugins/sentry-cli/skills/sentry-cli/SKILL.md b/plugins/sentry-cli/skills/sentry-cli/SKILL.md index 7f4c6170d..bc0961c45 100644 --- a/plugins/sentry-cli/skills/sentry-cli/SKILL.md +++ b/plugins/sentry-cli/skills/sentry-cli/SKILL.md @@ -355,7 +355,7 @@ Work with Sentry releases - `sentry release set-commits ` — Set commits for a release - `sentry release propose-version` — Propose a release version -→ Full flags and examples: `references/release.md` +→ Full flags and examples: `references/releases.md` ### Repo @@ -389,7 +389,7 @@ Manage sourcemaps - `sentry sourcemap inject ` — Inject debug IDs into JavaScript files and sourcemaps - `sentry sourcemap upload ` — Upload sourcemaps to Sentry -→ Full flags and examples: `references/sourcemap.md` +→ Full flags and examples: `references/sourcemaps.md` ### Span diff --git a/plugins/sentry-cli/skills/sentry-cli/references/release.md b/plugins/sentry-cli/skills/sentry-cli/references/releases.md similarity index 96% rename from plugins/sentry-cli/skills/sentry-cli/references/release.md rename to plugins/sentry-cli/skills/sentry-cli/references/releases.md index 2bb473051..647c5b135 100644 --- a/plugins/sentry-cli/skills/sentry-cli/references/release.md +++ b/plugins/sentry-cli/skills/sentry-cli/references/releases.md @@ -1,13 +1,13 @@ --- -name: sentry-cli-release +name: sentry-cli-releases version: 0.25.0-dev.0 -description: Sentry CLI release commands +description: Create, finalize, deploy, and manage Sentry releases requires: bins: ["sentry"] auth: true --- -# release Commands +# Release Commands Work with Sentry releases diff --git a/plugins/sentry-cli/skills/sentry-cli/references/sourcemap.md b/plugins/sentry-cli/skills/sentry-cli/references/sourcemaps.md similarity index 91% rename from plugins/sentry-cli/skills/sentry-cli/references/sourcemap.md rename to plugins/sentry-cli/skills/sentry-cli/references/sourcemaps.md index 85ca449a9..fee5d8910 100644 --- a/plugins/sentry-cli/skills/sentry-cli/references/sourcemap.md +++ b/plugins/sentry-cli/skills/sentry-cli/references/sourcemaps.md @@ -1,13 +1,13 @@ --- -name: sentry-cli-sourcemap +name: sentry-cli-sourcemaps version: 0.25.0-dev.0 -description: Sentry CLI sourcemap commands +description: Inject debug IDs and upload sourcemaps to Sentry requires: bins: ["sentry"] auth: true --- -# sourcemap Commands +# Sourcemap Commands Manage sourcemaps