Welcome to DeepSource documentation.
Under this banner, we cover everything about the product and how to customize it per your needs.
To get started with DeepSource, make sure you have
- A GitHub account.
- Owner permissions for the repository hosted on GitHub.
This procedure assumes you have a project with one of the list of supported languages.
- Go to deepsource.io and click
Sign up with Github.
- You will be taken to the GitHub permissions page. Click
Authorize DeepSource HQto proceed with the sign-up.
GitHub / Authorize DeepSource
- Install DeepSource GitHub app by clicking
Connect with GitHub. This step will allow DeepSource to access your code on GitHub. Don't worry, we don't store your source code permanently. You can read about our strict security policies at -- deepsource.io/security
DeepSource / Connect with GitHub
GitHub / Install DeepSource
If you would like to run DeepSource analysis on only specific repositories, click
Only select repositories.
Choose an appropriate plan depending on your needs. You will be taken to DeepSource dashboard which shows all the repositories DeepSource can run analysis on.
The dashboard will onboard you to activate analysis on a repository.
🎉 You should see the issues the analyzer raised against your source code.
Dashboard / Repository / Issues
Dashboard / Repository / Metrics