Skip to content
DocsGitHub

cli

CLI-related commands

View and manage default settings

Arguments:

Argument Description
<key value...> Setting key and optional value

Options:

Option Description
--clear Clear the specified default, or all defaults if no key is given
-y, --yes Skip confirmation prompt
-f, --force Force the operation without confirmation

Send feedback about the CLI

Arguments:

Argument Description
<message...> Your feedback message

Diagnose and repair CLI database issues

Options:

Option Description
--dry-run Show what would be fixed without making changes

Import settings from legacy .sentryclirc files

Options:

Option Description
-y, --yes Skip confirmation prompt
-n, --dry-run Show what would happen without making changes
--url <url> Explicitly trust this URL (bypasses same-file trust check)
--skip-validation Skip token validation against the Sentry API

Configure shell integration

Options:

Option Description
--install Install the binary from a temp location to the system path
--method <method> Installation method (curl, npm, pnpm, bun, yarn)
--channel <channel> Release channel to persist (stable or nightly)
--no-modify-path Skip PATH modification
--no-completions Skip shell completion installation
--no-agent-skills Skip agent skill installation for AI coding assistants
--quiet Suppress output (for scripted usage)

Uninstall Sentry CLI

Options:

Option Description
--keep-config Keep the config directory (~/.sentry) and auth tokens
-y, --yes Skip confirmation prompt
-f, --force Force the operation without confirmation
-n, --dry-run Show what would happen without making changes

Update the Sentry CLI to the latest version

Arguments:

Argument Description
<version> Specific version (e.g. 0.5.0), or "nightly"/"stable" to switch channel; omit to update within current channel

Options:

Option Description
--check Check for updates without installing
--force Force upgrade even if already on the latest version
--offline Upgrade using only cached version info and patches (no network)
--method <method> Installation method to use (curl, brew, npm, pnpm, bun, yarn)

All commands support --json for machine-readable output and --fields to select specific JSON fields.

Terminal window
sentry cli upgrade --check
Installation method: curl
Current version: 0.4.0
Channel: stable
Latest version: 0.5.0
Run 'sentry cli upgrade' to update.
Terminal window
# Upgrade to latest stable
sentry cli upgrade
# Upgrade to a specific version
sentry cli upgrade 0.5.0
# Force re-download
sentry cli upgrade --force
Terminal window
# Switch to nightly builds
sentry cli upgrade nightly
# Switch back to stable
sentry cli upgrade stable

After switching, bare sentry cli upgrade will continue tracking that channel.

Channel Description
stable Latest stable release (default)
nightly Built from main, updated on every commit

The CLI detects how it was installed and uses the appropriate upgrade method:

Method Detection
curl Binary in ~/.sentry/bin (installed via cli.sentry.dev)
brew Binary in a Homebrew Cellar (brew install getsentry/tools/sentry)
npm Globally installed via npm install -g sentry
pnpm Globally installed via pnpm add -g sentry
bun Globally installed via bun install -g sentry

Nightly builds are only available as standalone binaries (via the curl install method). Switching to nightly from a package manager install will automatically migrate to a standalone binary.

Terminal window
# Show all current defaults
sentry cli defaults
# Set default organization
sentry cli defaults org my-org
# Set default project
sentry cli defaults project my-project
# Set default Sentry URL (self-hosted)
sentry cli defaults url https://sentry.example.com
# Set custom HTTP headers (self-hosted, e.g. for IAP/proxies)
sentry cli defaults headers "X-IAP: token"
# Set a custom CA certificate (self-hosted, behind a TLS proxy)
sentry cli defaults ca-cert /path/to/ca.pem
# Disable telemetry
sentry cli defaults telemetry off
# Clear a single default
sentry cli defaults org --clear
# Clear all defaults
sentry cli defaults --clear

Import settings from .sentryclirc files used by the legacy sentry-cli:

Terminal window
# Auto-detect and import .sentryclirc
sentry cli import
# Preview what would be imported
sentry cli import --dry-run
# Skip confirmation prompt
sentry cli import --yes
# Explicitly trust a self-hosted URL
sentry cli import --url https://sentry.example.com
# Skip API validation of the imported token
sentry cli import --skip-validation
Terminal window
# Send positive feedback
sentry cli feedback i love this tool
# Report an issue
sentry cli feedback the issue view is confusing

Feedback is sent via Sentry's telemetry system. If telemetry is disabled (SENTRY_CLI_NO_TELEMETRY=1), feedback cannot be sent.

Terminal window
sentry cli fix
Terminal window
# Run full setup (PATH, completions, agent skills)
sentry cli setup
# Skip agent skill installation
sentry cli setup --no-agent-skills
# Skip PATH and completion modifications
sentry cli setup --no-modify-path --no-completions
Terminal window
# Show what would be removed (dry run)
sentry cli uninstall --dry-run
# Uninstall, keeping config directory
sentry cli uninstall --yes --keep-config
# Full uninstall with confirmation
sentry cli uninstall