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/deepsourcecurl https://deepsource.com/cli | shThis 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.
Log in to DeepSource using the CLI:
# Browser-based login (interactive)
deepsource auth login
# Token-based login (for CI/CD or non-interactive environments)
deepsource auth login --with-token
# For DeepSource Enterprise instances
deepsource auth login --hostname HOSTNAMEFor GitHub Actions, the report command supports OIDC authentication:
deepsource report --analyzer test-coverage --key go --value-file ./cover.out --use-oidcThe CLI provides access to a wide range of commands. Here is a list of the commands along with their brief description.
Usage:
deepsource <command> [<arguments>]
Available commands are:
auth Authenticate with DeepSource
login Log in to DeepSource
logout Logout of your account
refresh Refresh authentication credentials
status View authentication status
config Generate and Validate DeepSource config
generate Generate .deepsource.toml config
validate Validate existing config
issues Show the list of issues in a repository
list List issues (supports --json, --csv, --sarif export)
repo Operations related to the repository
status View activation status
view Open DeepSource dashboard in browser
report Report artifacts to DeepSource
version Get the version of the DeepSource CLI
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.