Documentation Scan with git push
Nothing to install. Add scancodebase as a git remote and push the branch you want to scan. The push starts the scan.
Before you start
- An account. A free one is enough.
- An access token from your account settings. It is the password for the commands below.
The commands
Add scancodebase as a git remote and push the branch you want to scan. Git asks for your account name and an access token from the platform. The push starts the scan and the report appears in your account.
git remote add scancodebase https://scancodebase.com/your-user/myapp.git
git push scancodebase mainReplace your-user with your account name and myapp with the name of your repository.
After the push
- The scan starts when the push ends.
- The report appears in your account when the analysis ends.
- The copy you pushed is deleted. Your code and your other remotes do not change.
If you have the command line tool, these two commands show and download the report of that push.
sc report last
sc download last --format pdfIf something goes wrong
- If the push is rejected, check the access token and that the remote address ends with your account name and the repository name.
- If you have reached the limit of your plan, the scan waits until the limit resets or until you add scans.
- The push does not change your code or your other remotes. It only sends a copy to be read.