Skip to content
Sentry CLI
Docs GitHub
Getting Started

Installation

Installation

Section titled “Installation”

Install Script

Section titled “Install Script”

Install the latest stable release:

Terminal window
curl https://cli.sentry.dev/install -fsS | bash

Install the nightly build (built from main, updated on every commit):

Terminal window
curl https://cli.sentry.dev/install -fsS | bash -s -- --version nightly

You can also use the SENTRY_VERSION environment variable to pin a version, which is especially useful in CI/CD pipelines and Dockerfiles:

Terminal window
# Pin to a specific stable version
SENTRY_VERSION=0.19.0 curl https://cli.sentry.dev/install -fsS | bash


# Pin to nightly
SENTRY_VERSION=nightly curl https://cli.sentry.dev/install -fsS | bash

The --version flag takes precedence over SENTRY_VERSION if both are set. The chosen channel is persisted so that sentry cli upgrade automatically tracks the same channel on future updates.

Homebrew

Section titled “Homebrew”
Terminal window
brew install getsentry/tools/sentry

Package Managers

Section titled “Package Managers”

Install globally with your preferred package manager:

npm install -g sentry

Or run directly without installing:

npx sentry --help

Authentication

Section titled “Authentication”
Section titled “OAuth Device Flow (Recommended)”

The easiest way to authenticate is via OAuth device flow:

Terminal window
sentry auth login

You'll be given a URL and a code to enter. Once you authorize the application in your browser, the CLI will automatically receive your token.

API Token

Section titled “API Token”

Alternatively, you can use an API token directly:

Terminal window
sentry auth login --token YOUR_SENTRY_API_TOKEN

You can create API tokens in your Sentry account settings.

Check Auth Status

Section titled “Check Auth Status”

Verify your authentication status:

Terminal window
sentry auth status

Logout

Section titled “Logout”

To remove stored credentials:

Terminal window
sentry auth logout

Self-Hosted Sentry

Section titled “Self-Hosted Sentry”

Using a self-hosted Sentry instance? Set SENTRY_URL to point at it:

Terminal window
SENTRY_URL=https://sentry.example.com sentry auth login

See the Self-Hosted guide for full setup details.

Configuration

Section titled “Configuration”

Credentials are stored in a SQLite database at ~/.sentry/ with restricted file permissions (mode 600) for security. See Configuration for environment variables and customization options.

Next Steps

Section titled “Next Steps”

Once authenticated, you can start using the CLI: