Command Line Interface
The command line interface to DeepSource. The DeepSource CLI requires you to authenticate with your account before using it. At the moment, the CLI is used to report artifacts to the analyzer.
curl https://deepsouce.io/cli | sh
This script will detect the operating system and architecture and puts
deepsource binary in
Supported operating systems: linux, darwin, freebsd, openbsd, netbsd.
Supported architectures: i386, x86_64.
DEEPSOURCE_DSNenvrionment variable. It will be available under 'Settings' tab of the repository page.
The CLI should be run from repository root which has
./bin/deepsource <command> [<arguments>]
./bin/deepsource <command> --help to read about a specific subcommand or concept right from the CLI.
Reports an artifact to the analyzer. Some analyzers requires artifacts to be pushed.
--analyzerShortcode of the analyzer. Refer analyzer list for respective shortcode.
--keyName of the artifact.
--valueValue of the artifact.
--value-filePath to the artifact value file.
Refer respective analyzer's documentation for supported keys and values.
To report python test coverage artifact to test-coverage analyzer, run,
./bin/deepsource report --analyzer test-coverage --key python --value-file ./coverage.xml