Getting Started

Requirements

Login

Once you have a GitHub account, you can login immediately.

1. Click Log in with GitHub button.
2. When you are redirected to GitHub, enter your GitHub account.
3. DeepScan needs to access your e-mail address and repositories. Authorize these permissions.

Note: DeepScan by default expires the login session in 14 days since last access.

Adding a project

After login, you have a default team and can add a project to analyze. Note that you can add only repositories for which you have an owner permission.

1. To add a project, click Add Project button in the dashboard.
2. You can see your repositories on GitHub. Click Add Project button for the repository to analyze. For the private project, you can start your free trial.
3. A progress screen will be displayed during the analysis. It can take a few minutes when the repository is large or the service is busy for other requests. Please be patient.
4. When analysis is finished, you can find the result of your project.

Viewing the result

Once this analysis has been completed, you can see the result in the project page. You can see an overview of your project quality status and detailed issues.

For detailed issues, move to Issues view. Each issue is shown with a message, code snippet, status and rule. And you can filter issues by the condition you want.

Viewing your team status

Basically, you can browse/add projects for your team in the Team Dashboard.

Also as of paid plans, Team Dashboard provides more metrics for your team: overall quality status and team activity.

Introductory Videos

This video gives you a quick overview of the basic features of DeepScan.

More resources