Usage

You can use any of the available commands with the following syntax:

./bin/deepsource <command> [<arguments>]

See ./bin/deepsource <command> --help to read about a specific subcommand or concept right from the CLI.

Commands

help

The --help flag can be used with any command to display the help for that command.

When used alone, the help command displays general help for the entire CLI.

config

Sub-commands

  • generate: Generate starter configuration file, .deepsource.toml, for a repository
  • validate: Validate the .deepsource.toml config file

auth

Sub-commands

  • login: Authenticate with your DeepSource account or create a new one
  • logout: Log out of your active DeepSource account
  • refresh: Refresh the stored authentication credentials
  • status: View the authentication status

repo

Sub-commands

  • status: Show the activation status of a repository on DeepSource
  • view: Open the DeepSource dashboard of a repository

Flags

  • --repo/-r: URL of the repository. If not specified, the repo command respects the repository corresponding to the current working directory.

issues

Sub-commands

  • list <file_path>: Show the list of issues in a file in a repository.

Flags

  • --repo/-r: URL of the repository to fetch issues from
  • --limit/-l: Number of issues to display at once. By default, the limit is set to 30.

report

Report artifacts to DeepSource.

Flags

  • --key: Shortcode of the language (example: python, go, javascript, ruby, java, scala, php, csharp, cxx, rust)
  • --analyzer: Name of the analyzer (example: test-coverage)
  • --value: Value of the artifact
  • --value-file: Path to the artifact value file
Configuration SAML SSO & SCIM