README.md

Sentry CLI Documentation

The CLI lives in packages/cli/. Its published user guide and command reference are at https://cli.sentry.dev/. The site source lives in apps/cli-docs/, and CLI releases build it from that workspace. Start here for repository guides:

• Getting started, features, and self-hosted use — hand-written user guides.
• Contributing to the CLI — setup, generated project layout, testing, and builds.
• CLI development notes and command conventions — implementation details and command design.
• CLI build workflow and release configuration — binaries, npm packaging, and release-gated website artifacts.
• CLI nightly watchdog — hourly and after each main Build, checks for stuck or failed Build runs and a GHCR nightly that lags main. It keeps one open alert issue while unhealthy, closes it on recovery, and posts both to Slack when the CLI_NIGHTLY_ALERT_SLACK_WEBHOOK_URL secret is set.
• CLI AGENTS.md — package-specific coding and testing rules.
• CLI docs fragments — hand-written additions to generated command pages. Command metadata and examples belong to the commands; the generated pages are not checked in.
• CLI overview — installation, supported platforms, and library use.

Run CLI commands from packages/cli/ or use pnpm --filter sentry run <script> at the repository root. Check packages/cli/package.json for current scripts before running them. The CLI docs workspace uses pnpm --filter sentry-cli-docs and depends on generated CLI documentation. The root coding guidelines and quality checks apply alongside the CLI's own rules.

• Local daemon and browser viewer — scoped telemetry sessions and viewer development.

For viewer development and envelope replay, see the Local viewer guide.