From e926ac84559dab28d18688fdb2e3cfce90113d7a Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Mon, 13 Apr 2026 12:13:48 +0000 Subject: [PATCH] docs: fix documentation gaps found in audit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add missing commands to README table (release, repo, team, trial) - Add yarn to README package manager examples - Add Node.js >=22 note for npm users - Fix OAuth scope lists: add missing team:write in DEVELOPMENT.md and self-hosted.md - Add undocumented env vars to configuration.md (SENTRY_FORCE_ENV_TOKEN, SENTRY_OUTPUT_FORMAT, SENTRY_MAX_PAGINATION_PAGES, SENTRY_INIT) - Update contributing.md project structure to reflect all 15+ command directories - Add Cursor support to agentic-usage.md alongside Claude Code - Document installer flags and SENTRY_INIT in getting-started.mdx - Add DOCUMENTATION_AUDIT.md with full gap report Co-authored-by: Miguel Betegón --- DEVELOPMENT.md | 2 +- DOCUMENTATION_AUDIT.md | 248 ++++++++++++++++++++++ README.md | 9 +- docs/src/content/docs/agentic-usage.md | 23 +- docs/src/content/docs/configuration.md | 32 +++ docs/src/content/docs/contributing.md | 31 ++- docs/src/content/docs/getting-started.mdx | 15 ++ docs/src/content/docs/self-hosted.md | 2 +- 8 files changed, 346 insertions(+), 16 deletions(-) create mode 100644 DOCUMENTATION_AUDIT.md 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/DOCUMENTATION_AUDIT.md b/DOCUMENTATION_AUDIT.md new file mode 100644 index 000000000..e5cad2a7e --- /dev/null +++ b/DOCUMENTATION_AUDIT.md @@ -0,0 +1,248 @@ +# Sentry CLI Documentation Audit Report + +**Date:** 2026-04-13 +**Scope:** Cross-reference of code implementation against all documentation surfaces + +--- + +## A. Undocumented or Missing Commands/Subcommands + +Command doc pages under `docs/src/content/docs/commands/` are **auto-generated** by `bun run generate:docs` and are **gitignored**, so they are not present in the repo at rest. The hand-written fragments in `docs/src/fragments/commands/` cover all top-level route groups. However, several commands are absent or under-represented in the **root README.md** commands table: + +| Command | In code (`src/commands/`) | In README table | In fragments | +|---------|--------------------------|-----------------|-------------| +| `sentry release` (list, view, create, finalize, delete, deploy, deploys, set-commits, propose-version) | Yes | **Missing** | Yes (`release.md`) | +| `sentry repo list` | Yes | **Missing** | Yes (`repo.md`) | +| `sentry team list` | Yes | **Missing** | Yes (`team.md`) | +| `sentry trial` (list, start) | Yes | **Missing from table** | Yes (`trial.md`) | +| `sentry whoami` (top-level alias) | Yes | **Missing** | Covered in `auth.md` | +| `sentry issue events` / `sentry event list` | Yes | **Missing** (only `event view` noted) | Partially in `issue.md` | +| `sentry release deploys` | Yes | **Missing** | Not in `release.md` fragment | +| `sentry dashboard widget` (add, edit, delete) | Yes | Mentioned as "create dashboards with widgets" | Yes (`dashboard.md`) | + +**Source files:** `src/app.ts` (route map), `README.md` (lines 69–87) + +### Recommendation +Add `sentry release`, `sentry repo`, `sentry team`, and `sentry trial` to the README commands table. Add `sentry whoami` as a note. Mention `issue events` / `event list` in the event command description. + +--- + +## B. Undocumented Flags + +The following **non-hidden** flags are defined in code but not mentioned in the corresponding hand-written fragment files. (Auto-generated doc pages would include them, but they are not checked into the repo.) + +| Command | Flag | Fragment coverage | +|---------|------|-------------------| +| `sentry auth login` | `--timeout` (default 900) | Not mentioned in `auth.md` | +| `sentry auth login` | `--force` | Not mentioned in `auth.md` | +| `sentry auth status` | `--fresh` | Not mentioned in `auth.md` | +| `sentry auth whoami` | `--fresh` | Not mentioned in `auth.md` | +| `sentry issue view` | `--spans` (span tree depth) | Not mentioned in `issue.md` | +| `sentry issue view` | `--fresh` | Not mentioned in `issue.md` | +| `sentry issue explain` | `--fresh` | Not mentioned in `issue.md` | +| `sentry issue plan` | `--fresh` | Not mentioned in `issue.md` | +| `sentry event view` | `--spans` | Not mentioned in `event.md` | +| `sentry event view` | `--fresh` | Not mentioned in `event.md` | +| `sentry trace view` | `--spans` | Not mentioned in `trace.md` | +| `sentry trace view` | `--fresh` | Not mentioned in `trace.md` | +| `sentry trace logs` | `--fresh` | Not mentioned in `trace.md` | +| `sentry log view` | `--fresh` | Not mentioned in `log.md` | +| `sentry span view` | `--spans`, `--fresh` | Not mentioned in `span.md` | +| `sentry dashboard view` | `--fresh`, `--period` | Not mentioned in `dashboard.md` | +| `sentry release list` | `--environment`, `--period`, `--status` | Not mentioned in `release.md` | +| `sentry release create` | `--ref`, `--url` | Not mentioned in `release.md` | +| `sentry release finalize` | `--released`, `--url` | Not mentioned in `release.md` | +| `sentry release deploy` | `--url`, `--started`, `--finished`, `--time` | Not mentioned in `release.md` | +| `sentry release set-commits` | `--clear`, `--commit`, `--initial-depth` | Not mentioned in `release.md` | +| All list commands | `--fresh` (cache bypass) | Rarely mentioned in fragments | +| All list commands | `--cursor` / `-c` | Mentioned in some fragments (repo, team, span, trace) but not all | +| `sentry sourcemap upload` | `--url-prefix` default is `~/` | Default not documented | + +**Source files:** `src/commands/*/` (flag definitions), `docs/src/fragments/commands/` (fragments) + +### Recommendation +The auto-generated docs cover these, but fragments should mention important flags like `--spans`, `--fresh`, `--timeout`, and release subcommand flags for discoverability. At minimum, add `--fresh` to the global options section in `docs/src/fragments/commands/index.md`. + +--- + +## C. Missing Usage Examples + +All 19 fragment files contain bash examples. This section is **clear** — no command fragment lacks examples entirely. However: + +- `sentry release deploys` (list deploys) has no example in `release.md` +- `sentry issue events` / `sentry event list` has no standalone example +- `sentry auth refresh` has only a brief mention, no full example showing the output + +--- + +## D. Stale Descriptions + +| Location | Doc description | Code `brief` | Drift? | +|----------|----------------|--------------|--------| +| README: `sentry cli` | "Upgrade, setup, fix, and send feedback" | Routes: upgrade, feedback, fix, setup | Minor: matches | +| README: `sentry event` | "View event details" | Route has `view` + `list` | **Yes**: `event list` exists but README only says "view" | +| README: `sentry project` | "List, view, create, and delete projects" | Matches | OK | +| README: `sentry log` | "List and view logs (with streaming)" | Matches | OK | + +**Other observations:** +- `DEVELOPMENT.md` lists OAuth scopes as: `project:read`, `project:write`, `project:admin`, `org:read`, `event:read`, `event:write`, `member:read`, `team:read` — **missing `team:write`** which is in the actual code (`src/lib/oauth.ts`). +- `docs/src/content/docs/self-hosted.md` lists token scopes without `team:write`. + +**Source files:** `src/lib/oauth.ts` (line 52–63), `DEVELOPMENT.md` (line 61–67), `self-hosted.md` (line 47) + +--- + +## E. Missing Route Mappings in Skill Generator + +The current `script/generate-skill.ts` uses **automatic 1:1 mapping** — every visible route gets its own reference file. There is no manual `ROUTE_TO_REFERENCE` map to go stale. This section is **clear**. + +--- + +## F. Installation / Distribution Gaps + +### README.md gaps + +| Feature | In code | In README | Gap | +|---------|---------|-----------|-----| +| `yarn` as install method | Yes (getting-started.mdx, upgrade.ts) | **Missing** from package manager examples | Yes | +| `npx` / `pnpm dlx` / `bunx` / `yarn dlx` | Yes (getting-started.mdx) | Only `npx` shown | Minor | +| Nightly builds | Yes (install script `--version nightly`) | **Not mentioned** | Yes | +| `SENTRY_VERSION` env var for install | Yes (install script) | **Not mentioned** | Yes | +| `SENTRY_INIT=1` env var | Yes (install script) | **Not mentioned** anywhere in docs | Yes | +| `SENTRY_INSTALL_DIR` | Yes (binary.ts, install script) | **Not mentioned** in README | Documented in configuration.md | +| `--no-modify-path` / `--no-completions` installer flags | Yes (install script) | **Not mentioned** | Yes | +| Node.js >=22 requirement | Yes (`package.json` engines) | **Not mentioned** in README install section | Only in library-usage.md | +| Supported platforms (darwin/linux/windows, arm64/x64) | Yes (install script) | **Not mentioned** | Yes | + +### getting-started.mdx gaps + +| Feature | In code | In getting-started.mdx | Gap | +|---------|---------|----------------------|-----| +| `SENTRY_INIT=1` env var | Yes (install script) | **Missing** | Yes | +| `--no-modify-path` / `--no-completions` installer flags | Yes (install script) | **Missing** | Yes | +| Supported platforms/architectures | Yes | **Missing** | Yes | +| Windows support notes (x64 only) | Yes (install script) | **Missing** | Yes | + +**Source files:** `install` (bash script), `README.md`, `docs/src/content/docs/getting-started.mdx` + +--- + +## G. Undocumented Environment Variables + +The following `SENTRY_*` variables are used in `src/` but **absent** from `docs/src/content/docs/configuration.md`: + +| Variable | Usage in code | Documented? | +|----------|---------------|-------------| +| `SENTRY_FORCE_ENV_TOKEN` | Forces env token over stored OAuth | **No** | +| `SENTRY_OUTPUT_FORMAT` | Library mode: `"json"` forces JSON output | **No** | +| `SENTRY_MAX_PAGINATION_PAGES` | Caps pagination loops (default 50) | **No** | +| `SENTRY_CLI_NO_AUTO_REPAIR` | Disables DB auto-repair | **No** | +| `SENTRY_INIT` | Install script: runs `sentry init` after install | **No** (not in configuration.md or getting-started.mdx) | + +All other `SENTRY_*` variables (`SENTRY_AUTH_TOKEN`, `SENTRY_TOKEN`, `SENTRY_HOST`, `SENTRY_URL`, `SENTRY_ORG`, `SENTRY_PROJECT`, `SENTRY_DSN`, `SENTRY_CLIENT_ID`, `SENTRY_CONFIG_DIR`, `SENTRY_VERSION`, `SENTRY_PLAIN_OUTPUT`, `SENTRY_CLI_NO_TELEMETRY`, `SENTRY_LOG_LEVEL`, `SENTRY_CLI_NO_UPDATE_CHECK`, `SENTRY_INSTALL_DIR`, `SENTRY_NO_CACHE`, `NO_COLOR`) are documented. + +**Source files:** `src/lib/db/auth.ts`, `src/lib/command.ts`, `src/lib/db/pagination.ts`, `src/lib/db/schema.ts`, `install` + +--- + +## H. Auth / Self-Hosted Gaps + +### OAuth scopes mismatch + +| Source | Scopes listed | +|--------|---------------| +| Code (`src/lib/oauth.ts`) | `project:read`, `project:write`, `project:admin`, `org:read`, `event:read`, `event:write`, `member:read`, `team:read`, **`team:write`** | +| `DEVELOPMENT.md` | Missing `team:write` | +| `self-hosted.md` | Missing `team:write` | + +### Token storage description + +- `getting-started.mdx` correctly says "SQLite database at `~/.sentry/`" +- `configuration.md` correctly describes `cli.db` with WAL side-files and mode 600 +- **Gap:** Neither doc mentions the `.sentryclirc` **legacy file** fallback for token (`[auth] token`), though `configuration.md` documents the `[defaults]` section. The `[auth]` section is documented but the **precedence** between SQLite-stored OAuth token and `.sentryclirc` token is not explicitly spelled out. + +### Self-hosted gaps + +- `self-hosted.md` says "Sentry 26.1.0+" for OAuth but the version requirement is not independently verified in the install/upgrade code — it's a documentation-only claim, which is fine. +- The page correctly documents `SENTRY_HOST` + `SENTRY_CLIENT_ID`. +- **Gap:** No mention of the `SENTRY_FORCE_ENV_TOKEN` variable which is relevant for self-hosted users who want env tokens to take priority over stored OAuth. + +**Source files:** `src/lib/oauth.ts`, `src/lib/db/auth.ts`, `DEVELOPMENT.md`, `self-hosted.md` + +--- + +## I. Plugin/Skills Gaps + +### Supported IDEs + +| IDE/Agent | In code/plugins | In `agentic-usage.md` | In `plugins/README.md` | +|-----------|----------------|----------------------|----------------------| +| Claude Code | Yes (skill install targets `~/.claude/`) | Mentioned as example | Yes (full install instructions) | +| Cursor | Yes (`.cursor/skills/` symlink in repo) | **Not mentioned** | Yes ("automatically available") | +| Other agents | Yes (generic copy instructions) | **Not mentioned** | Yes (generic instructions) | + +### Agentic usage page gaps + +- `agentic-usage.md` only mentions "Claude Code" and a generic "AI coding agents" — **Cursor is not mentioned** despite having first-class support via `.cursor/skills/`. +- The skill installation command shown (`npx skills add https://cli.sentry.dev`) may not match the current plugin installation method (`claude plugin install sentry/cli` in `plugins/README.md`). These appear to be two different systems. +- **Gap:** No mention of `sentry cli setup --no-agent-skills` flag to control skill installation. +- **Gap:** No mention that skills are **embedded at build time** (not fetched from network), which is a meaningful detail for offline/air-gapped environments. + +### plugins/README.md accuracy + +- Generally accurate and well-structured. +- **Gap:** Does not mention that `sentry cli setup` automatically installs skills (only discusses manual plugin installation). + +**Source files:** `src/lib/agent-skills.ts`, `src/commands/cli/setup.ts`, `plugins/README.md`, `docs/src/content/docs/agentic-usage.md` + +--- + +## J. README / DEVELOPMENT.md Drift + +### DEVELOPMENT.md + +| Claim | Code reality | Drift? | +|-------|-------------|--------| +| OAuth scopes missing `team:write` | Code has `team:write` | **Yes** | +| Environment variables table lists only `SENTRY_CLIENT_ID`, `SENTRY_HOST`, `SENTRY_URL` | Many more variables exist | **Yes** — incomplete but not wrong | +| "No client secret is needed" for device flow | Correct | OK | +| "Install dependencies: `bun install`" | Correct | OK | + +### README.md + +| Claim | Code reality | Drift? | +|-------|-------------|--------| +| "Bun v1.0+" in prerequisites | `packageManager: bun@1.3.11` in package.json | **Minor** — works with v1.0 but repo pins 1.3.11 | +| Commands table missing `release`, `repo`, `team`, `trial`, `whoami` | All exist in code | **Yes** | +| `sentry event` described as only "View event details" | Also has `event list` | **Yes** | +| No mention of Node.js >=22 for npm users | `engines.node: ">=22"` | **Yes** | +| Library usage shows `signal` as `AbortSignal` to cancel streaming | Correct per `sdk-types.ts` | OK | +| No `yarn` in package manager examples | Supported in getting-started.mdx and code | **Minor** | + +### contributing.md + +| Claim | Code reality | Drift? | +|-------|-------------|--------| +| Project structure lists only `auth/`, `org/`, `project/`, `issue/`, `event/` under commands | Many more directories exist (trace, span, log, dashboard, cli, release, sourcemap, schema, trial, repo, team, init, api, help) | **Yes** — significantly outdated | +| No mention of `bun run typecheck` | Exists in package.json | **Minor** (it's in the Code Style section) | + +**Source files:** `README.md`, `DEVELOPMENT.md`, `docs/src/content/docs/contributing.md`, `package.json` + +--- + +## Top 5 Most Impactful Fixes (Prioritized) + +### 1. Add missing commands to README.md commands table +**Impact: High** — The README is the first thing users see. Missing `release`, `repo`, `team`, `trial`, and `whoami` makes the CLI appear less capable than it is. Also update `event` description to include `list`. + +### 2. Fix OAuth scope lists (`team:write` missing) +**Impact: High** — `DEVELOPMENT.md` and `self-hosted.md` list OAuth scopes that self-hosted admins copy when creating OAuth apps. Missing `team:write` causes permission errors for team management features. + +### 3. Document missing environment variables in configuration.md +**Impact: Medium-High** — `SENTRY_FORCE_ENV_TOKEN`, `SENTRY_OUTPUT_FORMAT`, `SENTRY_MAX_PAGINATION_PAGES`, `SENTRY_CLI_NO_AUTO_REPAIR`, and `SENTRY_INIT` are used in code but absent from the configuration reference. `SENTRY_INIT` is especially useful for CI/CD pipelines. + +### 4. Update contributing.md project structure +**Impact: Medium** — The project structure in `contributing.md` lists only 5 command directories when 15+ exist. This misleads new contributors about the codebase scope. + +### 5. Add Cursor to agentic-usage.md and document installer flags +**Impact: Medium** — Cursor has first-class skill support but isn't mentioned in the agentic usage docs. The install script accepts `--no-modify-path`, `--no-completions`, and `SENTRY_INIT=1` that are useful for CI but undocumented in getting-started.mdx. diff --git a/README.md b/README.md index b0fff6054..46751f1f2 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,12 @@ brew install getsentry/tools/sentry ```bash npm install -g sentry pnpm add -g sentry +yarn global add sentry bun add -g sentry ``` +> **Note:** The npm package requires Node.js ≥22. + ### Run Without Installing ```bash @@ -74,12 +77,16 @@ sentry issue plan PROJ-ABC | `sentry org` | List and view organizations | | `sentry project` | List, view, create, and delete projects | | `sentry issue` | List, view, explain, and plan issues | -| `sentry event` | View event details | +| `sentry event` | List and 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 release` | Create, finalize, deploy, and manage releases | | `sentry dashboard` | List, view, and create dashboards with 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/agentic-usage.md b/docs/src/content/docs/agentic-usage.md index add0f74d2..5d91d66dd 100644 --- a/docs/src/content/docs/agentic-usage.md +++ b/docs/src/content/docs/agentic-usage.md @@ -3,17 +3,30 @@ title: Agentic Usage description: Enable AI coding agents to use the Sentry CLI --- -AI coding agents like Claude Code can use the Sentry CLI through the skill system. This allows agents to interact with Sentry directly from your development environment. +AI coding agents like Claude Code and Cursor can use the Sentry CLI through the skill system. This allows agents to interact with Sentry directly from your development environment. ## Adding the Skill -Add the Sentry CLI skill to your agent: +### Claude Code + +Install the Sentry CLI plugin: ```bash -npx skills add https://cli.sentry.dev +claude plugin marketplace add getsentry/cli +claude plugin install sentry/cli ``` -This registers the Sentry CLI as a skill that your agent can invoke when needed. +### Cursor + +Skills are automatically available for Cursor users. The CLI ships with a `.cursor/skills/` directory that Cursor picks up when the repo is opened. Running `sentry cli setup` also installs skills to the local config. + +### Other Agents + +Copy the `plugins/sentry-cli/skills/` directory to your agent's skills location, or reference the SKILL.md files directly according to your agent's documentation. + +### Automatic Installation + +Running `sentry cli setup` installs agent skills automatically. Use `--no-agent-skills` to skip this step. ## Capabilities @@ -43,4 +56,4 @@ The skill uses your existing CLI authentication, so you'll need to run `sentry a ## Requirements - An authenticated Sentry CLI installation (`sentry auth login`) -- An AI coding agent that supports the skills system (e.g., Claude Code) +- An AI coding agent that supports skills (e.g., Claude Code, Cursor) diff --git a/docs/src/content/docs/configuration.md b/docs/src/content/docs/configuration.md index 9cfe7807a..926d1c0ca 100644 --- a/docs/src/content/docs/configuration.md +++ b/docs/src/content/docs/configuration.md @@ -213,6 +213,38 @@ Disable API response caching. When set, the CLI will not cache API responses and export SENTRY_NO_CACHE=1 ``` +### `SENTRY_FORCE_ENV_TOKEN` + +When set, environment variable tokens (`SENTRY_AUTH_TOKEN` / `SENTRY_TOKEN`) take precedence over the stored OAuth token from `sentry auth login`. Useful for self-hosted setups or CI environments where you want to ensure the env token is always used. + +```bash +export SENTRY_FORCE_ENV_TOKEN=1 +``` + +### `SENTRY_OUTPUT_FORMAT` + +Force the output format for all commands. Currently only `json` is supported. This is primarily used by the library API (`createSentrySDK()`) to get JSON output without passing `--json` flags. + +```bash +export SENTRY_OUTPUT_FORMAT=json +``` + +### `SENTRY_MAX_PAGINATION_PAGES` + +Cap the maximum number of pages fetched during auto-pagination. Defaults to 50. Useful for limiting API calls when using large `--limit` values. + +```bash +export SENTRY_MAX_PAGINATION_PAGES=10 +``` + +### `SENTRY_INIT` + +Used with the install script. When set to `1`, the installer runs `sentry init` after installing the binary to guide you through project setup. + +```bash +SENTRY_INIT=1 curl https://cli.sentry.dev/install -fsS | bash +``` + ## 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/contributing.md b/docs/src/content/docs/contributing.md index 9bf97e350..756e71cb9 100644 --- a/docs/src/content/docs/contributing.md +++ b/docs/src/content/docs/contributing.md @@ -48,16 +48,31 @@ cli/ │ ├── app.ts # Stricli application setup │ ├── context.ts # Dependency injection context │ ├── commands/ # CLI commands -│ │ ├── auth/ # Authentication commands -│ │ ├── org/ # Organization commands -│ │ ├── project/ # Project commands -│ │ ├── issue/ # Issue commands -│ │ └── event/ # Event commands +│ │ ├── auth/ # login, logout, status, refresh, token, whoami +│ │ ├── org/ # list, view +│ │ ├── project/ # list, view, create, delete +│ │ ├── issue/ # list, view, explain, plan, events +│ │ ├── event/ # list, view +│ │ ├── trace/ # list, view, logs +│ │ ├── span/ # list, view +│ │ ├── log/ # list, view +│ │ ├── release/ # list, view, create, finalize, delete, deploy, set-commits +│ │ ├── dashboard/ # list, view, create, widget (add, edit, delete) +│ │ ├── sourcemap/ # inject, upload +│ │ ├── team/ # list +│ │ ├── repo/ # list +│ │ ├── trial/ # list, start +│ │ ├── cli/ # upgrade, setup, fix, feedback +│ │ ├── api.ts # Direct API access +│ │ ├── init.ts # Project initialization wizard +│ │ ├── schema.ts # API schema browser +│ │ └── help.ts # Help command │ ├── lib/ # Shared utilities │ └── types/ # TypeScript types and Zod schemas -├── test/ # Test files -├── script/ # Build scripts -└── docs/ # Documentation site +├── test/ # Test files (mirrors src/ structure) +├── script/ # Build and utility scripts +├── plugins/ # Agent skill files +└── docs/ # Documentation site (Astro + Starlight) ``` ## Building diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx index 3f697471e..bd97c34b1 100644 --- a/docs/src/content/docs/getting-started.mdx +++ b/docs/src/content/docs/getting-started.mdx @@ -36,6 +36,21 @@ 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 Options + +The install script accepts these flags and environment variables: + +| Flag / Variable | Description | +|----------------|-------------| +| `--version ` | Install a specific version or `nightly` | +| `--no-modify-path` | Skip adding the install directory to your shell PATH | +| `--no-completions` | Skip installing shell completions | +| `SENTRY_VERSION` | Same as `--version` (flag takes precedence) | +| `SENTRY_INSTALL_DIR` | Override the install directory (default: `~/.local/bin` or `~/.sentry/bin`) | +| `SENTRY_INIT=1` | Run `sentry init` after installing to set up your project | + +**Supported platforms:** macOS (Apple Silicon, Intel), Linux (x64, arm64), Windows (x64). + ### 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