Documentación La línea de comandos sc
Un comando analiza un repositorio. Otros dos muestran el informe y lo descargan.
Instalación
macOS
Intel y Apple silicon. Ejecútalo en Terminal.
curl -fsSL https://scancodebase.com/install.sh | shLinux
x86-64 y ARM64. Cualquier distribución.
curl -fsSL https://scancodebase.com/install.sh | shWindows
Windows 10 y 11. Ejecútalo en PowerShell.
irm https://scancodebase.com/install.ps1 | iex
El instalador detecta tu sistema, descarga un único fichero llamado sc y lo añade a tu PATH. No necesita nada más: ni Docker ni ningún runtime.
Abre una terminal nueva y comprueba que funciona.
sc versionEntrar
sc login # Opens the browser to sign in
sc whoami # Shows the account and the plan
sc logout # Removes the session from this machineEn una máquina sin navegador, como un runner de CI, usa un token de acceso. Ponlo en la variable de entorno SC_TOKEN y sc lo usa sin preguntar.
Analizar tu código
Pasa a sc code una carpeta o la URL de un repositorio.
sc code . # The project in the current folder
sc code ./services/api # One folder of a larger project
sc code https://github.com/you/myapp # A repository by its URL
sc code ./myapp.zip # A zip file of the code- Los ficheros de tu .gitignore se dejan fuera.
- Tu código se lee, nunca se ejecuta.
- Para un repositorio privado por URL, conecta antes tu plataforma de código en tu cuenta. Una carpeta local no necesita conexión.
- El código se borra al terminar el análisis.
Lo que ves
El análisis termina con un veredicto, los arreglos por orden de importancia y el enlace al informe.
$ sc code .
myapp
Almost ready. Fix 3 things first.
1. Fix the query in users.js
Line 43 builds a SQL query by joining strings with user input.
db.query('SELECT * FROM users WHERE id = ?', [id])
2. Take the key out of users.js
Line 41 has it written in the code, so it is in every copy of the repo.
const KEY = process.env.API_KEY
3. Update lodash
Line 40 imports a version with known vulnerabilities.
npm install lodash@latest
31 low-risk notes can wait.
Report https://platform.scancodebase.com/reports/r_8f3k2a
Download sc download r_8f3k2a --format pdf
Opciones
| Opción | Qué hace |
|---|---|
--fail-on <level> | Termina con el código de salida 1 cuando hay un hallazgo de este nivel o superior: critical, high, medium o low. Sirve para parar un pipeline. |
--format <format> | Muestra el resultado como text, json o sarif. Por defecto, text. |
--output <file> | Escribe el resultado en un fichero en vez de en la terminal. |
--no-wait | Lanza el análisis y vuelve al momento con el ID del informe. |
--quiet | Muestra solo el veredicto y el enlace al informe. |
--help | Muestra la ayuda de cualquier comando. |
Fichero de ajustes
Para no repetir opciones, ponlas en un fichero llamado .sc.yml en la carpeta donde ejecutas sc. Las opciones de la línea de comandos mandan sobre el fichero.
# .sc.yml
fail-on: high # Same as --fail-on high
format: text # text, json or sarif
exclude: # Folders and files to leave out
- docs/
- "**/*.test.js"Salida para otras herramientas
Con el formato json, sc muestra los mismos datos que devuelve la API, listos para jq o para tus propios scripts.
sc code . --format json{
"id": "r_8f3k2a",
"target": "myapp",
"created": "2026-11-17T10:42:00Z",
"verdict": "almost_ready",
"findings": {"critical": 1, "high": 2, "medium": 0, "low": 31},
"fix_first": [
{"title": "Fix the query in users.js", "fix": "db.query('SELECT * FROM users WHERE id = ?', [id])"}
],
"url": "https://platform.scancodebase.com/reports/r_8f3k2a"
}
Ver tus informes
sc reports # Lists your latest reports
sc report last # Shows the latest report in the terminal
sc report r_8f3k2a # Shows one report by its ID
sc report r_8f3k2a --open # Opens it in the browser$ sc reports
ID DATE TARGET VERDICT
r_8f3k2a 2026-11-17 10:42 myapp Almost ready
r_7c1m9d 2026-11-16 18:05 billing-api Ready
r_5t0q2x 2026-11-14 09:30 web-shop Not ready
Descargar un informe
sc download last --format pdf # Saves the latest report as PDF
sc download r_8f3k2a --format json # Saves one report as JSON
sc download r_8f3k2a --format sarif --output scan.sarif # Chooses the file name| Formato | Qué te da |
|---|---|
pdf | El informe como documento para enviar o archivar. |
html | El informe como una sola página que se abre en cualquier navegador. |
json | Todos los hallazgos como datos, para tus propias herramientas. |
sarif | Los hallazgos para el análisis de código de GitHub, GitLab y Azure DevOps. |
Los formatos que puedes descargar dependen de tu plan. Las cuentas gratuitas reciben el informe sencillo.
Otros comandos
| Comando | Qué hace |
|---|---|
sc usage | Muestra los análisis usados y los que quedan este mes. |
sc delete r_8f3k2a | Borra un informe de tu cuenta de forma definitiva. |
sc completion zsh | Muestra el script de autocompletado para tu shell: bash, zsh, fish o powershell. |
sc update | Actualiza sc a la última versión. |
sc version | Muestra la versión instalada. |
Códigos de salida
| Código | Significado |
|---|---|
0 | El análisis ha terminado y nada ha llegado al nivel fijado con --fail-on. |
1 | El análisis ha terminado y al menos un hallazgo ha llegado a ese nivel. |
2 | El análisis no se ha podido ejecutar: argumentos incorrectos, sin sesión o sin red. |
3 | Se ha alcanzado el límite de tu plan. |
Variables de entorno
| Variable | Qué hace |
|---|---|
SC_TOKEN | El token de acceso que se usa en lugar de la sesión de sc login. |
NO_COLOR | Quita los colores de la salida. |
Recetas
# Scan before every push: save this as .git/hooks/pre-push
#!/bin/sh
sc code . --fail-on high --quiet
# Scan only one service of a monorepo
sc code ./services/api --fail-on high
# Keep a PDF of every scan
sc code . && sc download last --format pdf --output scan.pdfUna herramienta para imágenes y código
La misma herramienta funciona con scancontainer y con scancodebase: sc image analiza una imagen de contenedor y sc code analiza código fuente.
Si algo va mal
| Lo que ves | Qué hacer |
|---|---|
| command not found: sc | Abre una terminal nueva. Si sigue sin aparecer, ejecuta el instalador otra vez. |
| Sin sesión | Ejecuta sc login, o comprueba que SC_TOKEN está definido y no se ha revocado. |
| Límite alcanzado | Ejecuta sc usage para ver lo que queda. El análisis se lanza cuando el límite se reinicia o cuando añades análisis. |
| No se puede leer el repositorio | Revisa la ruta, o la URL y que tu plataforma de código esté conectada. |
| No se ha podido leer parte del repositorio | El informe lo señala como hueco en vez de darlo por limpio. |