Home Original page

Installation | DeepSource Docs

Install DeepSource CLI to interact with DeepSource from your terminal.

DeepSource CLI helps you access and interact with DeepSource from your terminal. This guide walks you through installation, verification, and authentication.

Operating SystemArchitectures
Linuxamd64, arm64
macOS (Darwin)amd64, arm64
Windowsamd64

Verify the installation

Confirm the CLI is installed and accessible:

deepsource --version

You should see the version number.

Authenticate

The quickest way to authenticate is with browser-based login:

deepsource auth login

This opens a browser window where you authenticate with your DeepSource account. Once complete, the CLI stores your credentials locally.

For reporting code coverage in CI environments, you don't need to authenticate interactively. Instead, use the DEEPSOURCE_DSN environment variable or OIDC-based authentication (GitHub Actions only). See the report command for details.

Enable tab completions for the deepsource command in your shell:

deepsource completion

Shell completions are available on macOS and Linux only. The completion command supports bash, zsh, and fish.

The install script automatically sets up shell completions. You only need to run this manually if you installed the binary without the install script or if completions weren't set up automatically.

The CLI checks for new versions in the background. When an update is available, you'll see a notification banner the next time you run any command:

Update available: v2.0.50 → v2.0.54, run 'deepsource update' to install.

To apply the update:

deepsource update

Update checks are automatically skipped in CI environments.