cli

README

Documentation | Get Started | Community

The Code Health Platform

---

CLI

Command line interface to DeepSource

Installation

macOS

DeepSource CLI is available on macOS via Homebrew:

brew install deepsourcelabs/cli/deepsource

Binary Installation

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

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

Configuring DSN

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.

Usage

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> [<arguments>]

Available commands are:
    report      Report an artifact to an analyzer
    config      Generate and Validate DeepSource config
    help        Help about any command
    issues      Show the list of issues in a file in a repository
    repo        Operations related to the project repository
    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.

Documentation

For complete documentation, refer to the CLI Documentation

Feedback/Support

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

License

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