Skip to content

Commit 6ebb57c

Browse files
chore: regenerate docs
1 parent f4751ee commit 6ebb57c

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Best practices and operational guidance for AI coding agents using the Sentry CL
2121

2222
- **Just run the command** — the CLI handles authentication and org/project detection automatically. Don't pre-authenticate or look up org/project before running commands. The CLI prompts for login if needed.
2323
- **Prefer CLI commands over raw API calls** — the CLI has dedicated commands for most tasks. Reach for `sentry issue view`, `sentry issue list`, `sentry trace view`, etc. before constructing API calls manually or fetching external documentation.
24+
- **Use `sentry docs` for setup questions** — if you need to know how to configure a Sentry SDK or feature, run `sentry docs "your question"` to query the documentation directly. This is faster and more accurate than fetching docs externally.
2425
- **Use `sentry schema` to explore the API** — if you need to discover API endpoints, run `sentry schema` to browse interactively or `sentry schema <resource>` to search. This is faster than fetching OpenAPI specs externally.
2526
- **Use `sentry issue view <id>` to investigate issues** — when asked about a specific issue (e.g., `CLI-G5`, `PROJECT-123`), use `sentry issue view` directly.
2627
- **Use `--json` for machine-readable output** — pipe through `jq` for filtering. Human-readable output includes formatting that is hard to parse.
@@ -147,6 +148,26 @@ sentry local -f ai
147148
# Sentry.init({ spotlight: process.env.NEXT_PUBLIC_SENTRY_SPOTLIGHT ?? false })
148149
```
149150

151+
#### Query Sentry Documentation
152+
153+
```bash
154+
# Ask a documentation question
155+
sentry docs "How do I configure tracing in Next.js?"
156+
157+
# Search the documentation index
158+
sentry docs list "source maps"
159+
```
160+
161+
#### Check Sentry Service Status
162+
163+
```bash
164+
# Show current status of Sentry services
165+
sentry status
166+
167+
# Machine-readable status
168+
sentry status --json
169+
```
170+
150171
#### Explore the API Schema
151172

152173
```bash
@@ -285,6 +306,7 @@ When querying the Events API (directly or via `sentry api`), valid dataset value
285306
- **Confusing `--query` syntax**: The `--query` flag uses Sentry search syntax (e.g., `is:unresolved`, `assigned:me`), not free text search.
286307
- **Not using `--web`**: View commands support `-w`/`--web` to open the resource in the browser — useful for sharing links.
287308
- **Fetching API schemas instead of using the CLI**: Prefer `sentry schema` to browse the API and `sentry api` to make requests — the CLI handles authentication and endpoint resolution, so there's rarely a need to download OpenAPI specs separately.
309+
- **Fetching Sentry docs externally**: Use `sentry docs "your question"` to query Sentry's documentation from the CLI — this returns concise answers with source links, without needing to fetch or parse documentation pages.
288310
- **Release version mismatch**: The `org/version` positional is `<org-slug>/<version>`, where `org/` is the org, not part of the version. `sentry release create sentry/1.0.0` creates version `1.0.0` in org `sentry`. If your `Sentry.init()` uses `release: "1.0.0"`, this is correct. Don't double-prefix like `sentry/myapp/1.0.0`.
289311
- **Running `set-commits --auto` without a git checkout**: `--auto` needs a local git repo to discover the origin remote URL and HEAD commit. In CI, ensure `actions/checkout` with `fetch-depth: 0` runs before `set-commits --auto`.
290312
- **Using `sentry api` when CLI commands suffice**: `sentry issue list --json` and `sentry issue view --json` already include `shortId`, `title`, `count`, `userCount`, `priority`, `level`, `status`, `permalink`, and other fields at the top level. When using `--fields` to select specific fields like `count` or `userCount`, the CLI automatically ensures these fields are present in the API response. Use `--fields` to select specific fields and `--help` to see all available fields. Only fall back to `sentry api` for data the CLI doesn't expose.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,12 @@ Refresh your OAuth access token
6464

6565
```bash
6666
sentry auth refresh
67+
68+
# Refresh with read-only scopes
69+
sentry auth refresh --read-only
70+
71+
# Refresh with specific scopes
72+
sentry auth refresh --scope project:read --scope org:read
6773
```
6874

6975
### `sentry auth status`

0 commit comments

Comments
 (0)