Skip to content
Sentry CLI
DocsGitHub
Resources

Contributing

We welcome contributions to the Sentry CLI! This guide will help you get started.

Development Setup

Section titled “Development Setup”

Prerequisites

Section titled “Prerequisites”
  • Git

Getting Started

Section titled “Getting Started”
Terminal window
# Clone the repository
git clone https://github.com/getsentry/cli.git
cd cli


# Install dependencies
pnpm install


# Generate build-time files (API schema, search parser, docs, skills)
pnpm run generate:schema
pnpm run generate:docs


# Run CLI in development mode
pnpm run cli --help


# Run tests
pnpm run test

Environment Variables

Section titled “Environment Variables”

Create a .env.local file for development:

Terminal window
cp packages/cli/.env.example packages/cli/.env.local

Edit .env.local with your development credentials. pnpm run cli loads it automatically. See DEVELOPMENT.md for when SENTRY_CLIENT_ID is needed.

Project Structure

Section titled “Project Structure”

The repository is a pnpm workspace. The CLI lives in packages/cli/, the documentation site (Astro + Starlight) in apps/cli-docs/, and the Sentry Local UI in apps/local/.

packages/cli/
├── src/
│   ├── bin.ts          # Entry point
│   ├── app.ts          # Stricli application setup
│   ├── context.ts      # Dependency injection context
│   ├── commands/       # CLI commands
│   │   ├── agent-conversation/# list, view
│   │   ├── alert/       # create, delete, edit, list, view
│   │   ├── auth/        # login, logout, refresh, status, token, whoami
│   │   ├── build/       # download, upload
│   │   ├── cli/         # completion, defaults, feedback, fix, import, setup, uninstall, upgrade
│   │   ├── code-mappings/# upload
│   │   ├── dart-symbol-map/# upload
│   │   ├── dashboard/   # add, create, delete, edit, list, restore, revisions, view
│   │   ├── debug-files/ # bundle-jvm, bundle-sources, check, find, print-sources, upload
│   │   ├── docs/        # list, query
│   │   ├── event/       # list, send, view
│   │   ├── feedback/    # list, view
│   │   ├── issue/       # archive, events, explain, list, merge, plan, resolve, unresolve, view
│   │   ├── local/       # run, serve
│   │   ├── log/         # list, view
│   │   ├── monitor/     # list, run
│   │   ├── org/         # list, view
│   │   ├── platform/    # list
│   │   ├── proguard/    # upload, uuid
│   │   ├── project/     # create, delete, list, view
│   │   ├── react-native/# gradle, xcode
│   │   ├── release/     # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│   │   ├── replay/      # list, view
│   │   ├── repo/        # list
│   │   ├── snapshots/   # diff, download, upload
│   │   ├── sourcemap/   # inject, resolve, upload
│   │   ├── span/        # list, view
│   │   ├── status/      # show
│   │   ├── team/        # list
│   │   ├── trace/       # list, logs, view
│   │   ├── trial/       # list, start
│   │   ├── api.ts       # Make an authenticated API request
│   │   ├── explore.ts   # Query aggregate event data (Explore)
│   │   ├── help.ts      # Help command
│   │   ├── info.ts      # Print configuration and verify authentication
│   │   ├── init.ts      # Initialize Sentry in your project (experimental)
│   │   ├── schema.ts    # Browse the Sentry API schema
│   │   └── wasm-split.ts# Add build ids to WebAssembly modules and split out debug data
│   ├── lib/            # Shared utilities
│   └── types/          # TypeScript types and Valibot schemas
├── test/               # Test files (mirrors src/ structure)
├── script/             # Build and utility scripts
└── plugins/            # Agent skill files

Building

Section titled “Building”
Terminal window
# Build for current platform (uses esbuild + fossilize for Node SEA packaging)
pnpm run build


# Build for all platforms
pnpm run build:all


# Create npm bundle
pnpm run bundle

Testing

Section titled “Testing”
Terminal window
# Run all unit tests (regenerates docs and the SDK first, with coverage)
pnpm run test


# Run a specific test file (path relative to packages/cli; skips the
# generate steps, so run `pnpm run test` once first)
pnpm --filter sentry exec vitest run test/path/to/test.ts


# Run in watch mode
pnpm --filter sentry exec vitest


# Run end-to-end tests
pnpm run test:e2e

Code Style

Section titled “Code Style”

The project uses Ultracite for linting and formatting:

Terminal window
# Check for issues
pnpm run lint


# Auto-fix issues
pnpm run lint:fix


# Type checking
pnpm run typecheck

Submitting Changes

Section titled “Submitting Changes”
  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/my-feature
  3. Make your changes
  4. Run tests and linting: pnpm run test && pnpm run lint
  5. Commit with conventional commits: git commit -m "feat: add new feature"
  6. Push and create a pull request

Conventional Commits

Section titled “Conventional Commits”

We use conventional commits for automatic changelog generation:

  • feat: - New features
  • fix: - Bug fixes
  • docs: - Documentation changes
  • refactor: - Code refactoring
  • test: - Test changes
  • chore: - Maintenance tasks

Getting Help

Section titled “Getting Help”