Documentation Get started with scancodebase
Five ways to scan a repository: the browser, the command line, a git push, your CI pipeline and the API. All of them end in the same report.
Choose how to scan
- No account
Browser
Type the name on the home page. Good for trying it on one repository.
- Free account
Command line
Install sc and scan with one command. Good for daily work on your own machine.
- Free account
git push
Use the tool you already have. Good for machines where you cannot install anything.
- Skipper and above
CI pipeline
Check every change before it merges and stop the pipeline on serious findings.
- Fleet
API
Start scans and read reports from your own tools and dashboards.
- All plans
Reports
Read them in the browser or the terminal, and download them as PDF, JSON or SARIF.
How a scan works
- You send the repositoryFrom the browser, the command line, a push, your pipeline or the API.
- We read every fileNothing is executed. The analysis runs in an isolated worker in the European Union.
- You get a verdictReady, almost ready or not ready, with the fixes in order of importance.
- What you sent is deletedOnly the report stays in your account, until you delete it.
Quick start
Install the command line tool, sign in and run your first scan. It takes about a minute.
curl -fsSL https://scancodebase.com/install.sh | sh
sc login
sc code .The result is printed in your terminal and the report is saved in your account.
On Windows, use the PowerShell installer from the command line page.
Scan from the browser
- Open the home page and paste the URL of the repository in the box.
- For a private repository, choose Private repository and connect GitHub, GitLab, Bitbucket or Azure DevOps.
- To scan a file from your device, choose Upload a file and pick it.
- Press the button. The report opens when the analysis ends.
Access tokens
An access token lets the command line, your CI pipeline and the API act for your account without your password.
- Create it in the platform, in your account settings.
- It is shown only once. Keep it in a password manager or as a secret in your CI system.
- You can revoke it at any time. Scans that use a revoked token are rejected.
Limits
- Without an account: 1 scan a day.
- Free account: 5 scans a day, up to 30 a month.
- Paid plans: a monthly pool of scans. Extra scans are billed per 100.
Your data
The repositories you send are deleted when the analysis ends. Only the report is kept. Everything is stored and processed in the European Union: Spain is the primary region and Germany the secondary one.
Common questions
Do I need an account?
Not for the first try: the browser gives you 1 scan a day without an account. The command line, the push and the scan history need a free account.
Do I have to install anything?
No. You can scan from the browser or with a git push. The sc command line is optional and is a single file.
Is the command line free?
Yes. It works with a free account, within the limits of your plan.
Can I scan something private?
Yes. The command line scans any folder on your machine. For a private repository by URL, connect your code platform in your account first.
Can I download the report?
Yes: from your account, with sc download or through the API. The formats depend on your plan.
Where does my data go?
To servers in the European Union: Spain is the primary region and Germany the secondary one. What you send is deleted when the analysis ends.