https://github.com/deepsourcecorp/cli
Command line interface to DeepSource
https://github.com/deepsourcecorp/cli
Last synced: 12 months ago
JSON representation
Command line interface to DeepSource
- Host: GitHub
- URL: https://github.com/deepsourcecorp/cli
- Owner: DeepSourceCorp
- License: bsd-2-clause
- Created: 2018-12-04T12:20:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T08:16:07.000Z (over 1 year ago)
- Last Synced: 2025-04-02T03:59:17.201Z (12 months ago)
- Language: Go
- Homepage: https://deepsource.com
- Size: 21.3 MB
- Stars: 50
- Watchers: 3
- Forks: 18
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Docs |
Get Started |
Discuss
The Code Health Platform
---
# CLI
Command line interface to DeepSource
## Installation
### macOS
DeepSource CLI is available on macOS via [Homebrew](https://brew.sh/):
```sh
brew install deepsourcelabs/cli/deepsource
```
### Binary Installation
```sh
curl https://deepsource.com/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 []
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 --help/-h' for more information about the command.
```
## Documentation
For complete documentation, refer to the [CLI Documentation](https://docs.deepsource.com/docs/cli)
## Feedback/Support
Want to share any feedback or need any help regarding the CLI? Feel free to
open a discussion in the [community forum](https://discuss.deepsource.com)
## License
Licensed under the [BSD 2-Clause "Simplified" License](https://github.com/deepsourcelabs/cli/blob/master/LICENSE).