You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pr-preview/pr-685/.well-known/skills/sentry-cli/SKILL.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Best practices and operational guidance for AI coding agents using the Sentry CL
22
22
-**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.
23
23
-**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.
24
24
-**Use `--json` for machine-readable output** — pipe through `jq` for filtering. Human-readable output includes formatting that is hard to parse.
25
-
-**The CLI auto-detects org/project** — most commands work without explicit targets by scanning for DSNs in `.env` files, source code, config defaults, and directory names. Only specify `<org>/<project>` when the CLI reports it can't detect the target or detects the wrong one.
25
+
-**The CLI auto-detects org/project** — most commands work without explicit targets by checking `.sentryclirc` config files, scanning for DSNs in `.env` files and source code, and matching directory names. Only specify `<org>/<project>` when the CLI reports it can't detect the target or detects the wrong one.
26
26
27
27
### Design Principles
28
28
@@ -223,7 +223,7 @@ When querying the Events API (directly or via `sentry api`), valid dataset value
223
223
-**Wrong issue ID format**: Use `PROJECT-123` (short ID), not the numeric ID `123456789`. The short ID includes the project prefix.
224
224
-**Pre-authenticating unnecessarily**: Don't run `sentry auth login` before every command. The CLI detects missing/expired auth and prompts automatically. Only run `sentry auth login` if you need to switch accounts.
225
225
-**Missing `--json` for piping**: Human-readable output includes formatting. Use `--json` when parsing output programmatically.
226
-
-**Specifying org/project when not needed**: Auto-detection resolves org/project from DSNs, env vars, config defaults, and directory names. Let it work first — only add `<org>/<project>` if the CLI says it can't detect the target or detects the wrong one.
226
+
-**Specifying org/project when not needed**: Auto-detection resolves org/project from `.sentryclirc` config files, DSNs, env vars, and directory names. Let it work first — only add `<org>/<project>` if the CLI says it can't detect the target or detects the wrong one.
227
227
-**Confusing `--query` syntax**: The `--query` flag uses Sentry search syntax (e.g., `is:unresolved`, `assigned:me`), not free text search.
228
228
-**Not using `--web`**: View commands support `-w`/`--web` to open the resource in the browser — useful for sharing links.
229
229
-**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.
@@ -346,8 +346,8 @@ Manage Sentry dashboards
346
346
347
347
Work with Sentry releases
348
348
349
-
-`sentry release list <org/project>` — List releases
<li><strong>Use <codedir="auto">sentry schema</code> to explore the API</strong> — if you need to discover API endpoints, run <codedir="auto">sentry schema</code> to browse interactively or <codedir="auto">sentry schema <resource></code> to search. This is faster than fetching OpenAPI specs externally.</li>
160
160
<li><strong>Use <codedir="auto">sentry issue view <id></code> to investigate issues</strong> — when asked about a specific issue (e.g., <codedir="auto">CLI-G5</code>, <codedir="auto">PROJECT-123</code>), use <codedir="auto">sentry issue view</code> directly.</li>
161
161
<li><strong>Use <codedir="auto">--json</code> for machine-readable output</strong> — pipe through <codedir="auto">jq</code> for filtering. Human-readable output includes formatting that is hard to parse.</li>
162
-
<li><strong>The CLI auto-detects org/project</strong> — most commands work without explicit targets by scanning for DSNs in <codedir="auto">.env</code> files, source code, config defaults, and directory names. Only specify <codedir="auto"><org>/<project></code> when the CLI reports it can't detect the target or detects the wrong one.</li>
162
+
<li><strong>The CLI auto-detects org/project</strong> — most commands work without explicit targets by checking <codedir="auto">.sentryclirc</code> config files, scanning for DSNs in <codedir="auto">.env</code> files and source code, and matching directory names. Only specify <codedir="auto"><org>/<project></code> when the CLI reports it can't detect the target or detects the wrong one.</li>
163
163
</ul>
164
164
<h2id="design-principles">Design Principles</h2>
165
165
<p>The <codedir="auto">sentry</code> CLI follows conventions from well-known tools — if you're familiar with them, that knowledge transfers directly:</p>
<li><strong>Wrong issue ID format</strong>: Use <codedir="auto">PROJECT-123</code> (short ID), not the numeric ID <codedir="auto">123456789</code>. The short ID includes the project prefix.</li>
354
354
<li><strong>Pre-authenticating unnecessarily</strong>: Don't run <codedir="auto">sentry auth login</code> before every command. The CLI detects missing/expired auth and prompts automatically. Only run <codedir="auto">sentry auth login</code> if you need to switch accounts.</li>
355
355
<li><strong>Missing <codedir="auto">--json</code> for piping</strong>: Human-readable output includes formatting. Use <codedir="auto">--json</code> when parsing output programmatically.</li>
356
-
<li><strong>Specifying org/project when not needed</strong>: Auto-detection resolves org/project from DSNs, env vars, config defaults, and directory names. Let it work first — only add <codedir="auto"><org>/<project></code> if the CLI says it can't detect the target or detects the wrong one.</li>
356
+
<li><strong>Specifying org/project when not needed</strong>: Auto-detection resolves org/project from <codedir="auto">.sentryclirc</code> config files, DSNs, env vars, and directory names. Let it work first — only add <codedir="auto"><org>/<project></code> if the CLI says it can't detect the target or detects the wrong one.</li>
357
357
<li><strong>Confusing <codedir="auto">--query</code> syntax</strong>: The <codedir="auto">--query</code> flag uses Sentry search syntax (e.g., <codedir="auto">is:unresolved</code>, <codedir="auto">assigned:me</code>), not free text search.</li>
358
358
<li><strong>Not using <codedir="auto">--web</code></strong>: View commands support <codedir="auto">-w</code>/<codedir="auto">--web</code> to open the resource in the browser — useful for sharing links.</li>
359
359
<li><strong>Fetching API schemas instead of using the CLI</strong>: Prefer <codedir="auto">sentry schema</code> to browse the API and <codedir="auto">sentry api</code> to make requests — the CLI handles authentication and endpoint resolution, so there's rarely a need to download OpenAPI specs separately.</li>
0 commit comments