![\"Sentry](\".github/assets/banner.png\")
\n\n \n
\n The command-line interface for Sentry. Built for developers and AI agents.\n
\n\n\n Documentation |\n Getting Started |\n Commands\n
\n\n---\n\n## Installation\n\n### Install Script (Recommended)\n\n```bash\ncurl https://cli.sentry.dev/install -fsS | bash\n```\n\n### Homebrew\n\n```bash\nbrew install getsentry/tools/sentry\n```\n\n### Package Managers\n\n```bash\nnpm install -g sentry\npnpm add -g sentry\nbun add -g sentry\n```\n\n### Run Without Installing\n\n```bash\nnpx sentry@latest\n```\n\n## Quick Start\n\n```bash\n# Authenticate with Sentry\nsentry auth login\n\n# List issues (auto-detects project from your codebase)\nsentry issue list\n\n# Get AI-powered root cause analysis\nsentry issue explain PROJ-ABC\n\n# Generate a fix plan\nsentry issue plan PROJ-ABC\n```\n\n## Features\n\n- **DSN Auto-Detection** - Automatically detects your project from `.env` files or source code. No flags needed.\n- **Seer AI Integration** - Get root cause analysis and fix plans directly in your terminal.\n- **Monorepo Support** - Works with multiple projects, generates short aliases for easy navigation.\n- **JSON Output** - All commands support `--json` for scripting and pipelines.\n- **Open in Browser** - Use `-w` flag to open any resource in your browser.\n\n## Commands\n\nRun `sentry --help` to see all available commands, or browse the [command reference](https://cli.sentry.dev/commands/).\n\n## Configuration\n\nCredentials are stored in `~/.sentry/` with restricted permissions (mode 600).\n\n## Library Usage\n\n\nUse Sentry CLI programmatically in Node.js (≥22.12) or Bun without spawning a subprocess:\n\n\n```typescript\nimport createSentrySDK from \"sentry\";\n\nconst sdk = createSentrySDK({ token: \"sntrys_...\" });\n\n// Typed methods for every CLI command\nconst orgs = await sdk.org.list();\nconst issues = await sdk.issue.list({ orgProject: \"acme/frontend\", limit: 5 });\nconst issue = await sdk.issue.view({ issue: \"ACME-123\" });\n\n// Nested commands\nawait sdk.dashboard.widget.add({ display: \"line\", query: \"count\" }, \"my-org/my-dashboard\");\n\n// Escape hatch for any CLI command\nconst version = await sdk.run(\"--version\");\nconst text = await sdk.run(\"issue\", \"list\", \"-l\", \"5\");\n```\n\nOptions (all optional):\n- `token` — Auth token. Falls back to `SENTRY_AUTH_TOKEN` / `SENTRY_TOKEN` env vars.\n- `url` — Sentry instance URL for self-hosted (e.g., `\"sentry.example.com\"`).\n- `org` — Default organization slug (avoids passing it on every call).\n- `project` — Default project slug.\n- `text` — Return human-readable string instead of parsed JSON (affects `run()` only).\n- `cwd` — Working directory for DSN auto-detection. Defaults to `process.cwd()`.\n- `signal` — `AbortSignal` to cancel streaming commands (`--follow`, `--refresh`).\n\nStreaming commands return `AsyncIterable` — use `for await...of` and `break` to stop.\n\nErrors are thrown as `SentryError` with `.exitCode` and `.stderr`.\n\n---\n\n## Development\n\n### Prerequisites\n\n\n- [Bun](https://bun.sh) v1.3+\n\n\n### Setup\n\n```bash\ngit clone https://github.com/getsentry/cli.git\ncd cli\nbun install\n```\n\n### Running Locally\n\n```bash\n# Run CLI in development mode\nbun run dev --help\n\n# With environment variables\nbun run --env-file=.env.local src/bin.ts --help\n```\n\n### Scripts\n\n\n```bash\nbun run build # Build for current platform\nbun run typecheck # Type checking\nbun run lint # Check for issues\nbun run lint:fix # Auto-fix issues\nbun run test:unit # Run unit tests\nbun run test:e2e # Run end-to-end tests\nbun run generate:docs # Regenerate command docs and skills\n```\n\n\nSee [DEVELOPMENT.md](DEVELOPMENT.md) for detailed setup and [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.\n\n## License\n\n[FSL-1.1-Apache-2.0](LICENSE.md)\n","readmeFilename":"README.md"}