Sentry CLI Usage Guide

Help users interact with Sentry from the command line using the sentry CLI.

Core rule for agents: just run the command. The sentry CLI auto-detects your org and project (from .sentryclirc, DSNs in .env/source, and the directory name), so do not list organizations and then list their projects to work out which one this checkout maps to — that manual discovery only duplicates work the CLI already does on every command. Pass an explicit <org>/<project> only when the CLI reports it can't detect the target or picks the wrong one.

Agent Guidance

Best practices and operational guidance for AI coding agents using the Sentry CLI.

Key Principles

• 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.
• 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.
• 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.
• 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.
• Use --json for machine-readable output — pipe through jq for filtering. Human-readable output includes formatting that is hard to parse.
• The CLI auto-detects org/project — don't discover it yourself — most commands work without explicit targets by checking .sentryclirc config files, scanning for DSNs in .env files and source code, and matching directory names. Do not run sentry org list and then sentry project list to figure out which project this checkout belongs to — that manual fan-out just replicates the detection the CLI already runs on every command. Only specify <org>/<project> when the CLI reports it can't detect the target or detects the wrong one.