Docs | Get Started | Discuss

The Code Health Platform

Command line interface to DeepSource

DeepSource CLI is available on macOS via Homebrew:

brew install deepsourcelabs/cli/deepsource

curl https://deepsource.com/cli | sh

This script will detect the operating system and architecture and puts deepsource binary in ./bin/deepsource.

In order to report test-coverage to DeepSource using the report command, an environment variable named as DEEPSOURCE_DSN has to be set. It's value will be available under 'Settings' tab of the repository page.

deepsource auth login

deepsource auth login --token <your-token>

deepsource auth login --host your-enterprise.deepsource.com

deepsource report --analyzer test-coverage --key go --value-file ./coverage.out --use-oidc

The CLI provides access to a wide range of commands. Here is a list of the commands along with their brief description.

Usage:
    deepsource <command> [flags]

Available commands are:
    auth                Authentication commands (login, logout, refresh, status)
    analysis            View analysis runs
    issues              View issues in a repository
    repo                Operations related to the project repository (status, view)
    report              Report artifacts to DeepSource
    metrics             View repository metrics
    vulnerabilities     View vulnerabilities in a repository

Help:
    Use 'deepsource <command> --help/-h' for more information about the command.

For complete documentation, refer to the CLI Documentation

Want to share any feedback or need any help regarding the CLI? Feel free to open a discussion in the community forum

Licensed under the BSD 2-Clause "Simplified" License.