Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
336 changes: 336 additions & 0 deletions docs/DOCS-GAP-REPORT.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/public/.well-known/skills/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 2 additions & 1 deletion docs/src/content/docs/commands/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
24 changes: 24 additions & 0 deletions docs/src/content/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 12 additions & 0 deletions docs/src/content/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/self-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions plugins/sentry-cli/skills/sentry-cli/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ Work with Sentry releases
- `sentry release set-commits <org/version...>` — 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

Expand Down Expand Up @@ -389,7 +389,7 @@ Manage sourcemaps
- `sentry sourcemap inject <directory>` — Inject debug IDs into JavaScript files and sourcemaps
- `sentry sourcemap upload <directory>` — Upload sourcemaps to Sentry

→ Full flags and examples: `references/sourcemap.md`
→ Full flags and examples: `references/sourcemaps.md`

### Span

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 6 additions & 0 deletions script/generate-skill.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ const ROUTE_TO_REFERENCE: Record<string, string> = {
trace: "traces",
span: "traces",
trial: "trials",
release: "releases",
sourcemap: "sourcemaps",
cli: "setup",
init: "setup",
schema: "setup",
Expand All @@ -123,6 +125,8 @@ const REFERENCE_TITLES: Record<string, string> = {
logs: "Log Commands",
traces: "Trace & Span Commands",
trials: "Trial Commands",
releases: "Release Commands",
sourcemaps: "Sourcemap Commands",
setup: "CLI Setup Commands",
};

Expand All @@ -139,6 +143,8 @@ const REFERENCE_DESCRIPTIONS: Record<string, string> = {
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",
};

Expand Down
Loading