Documentación Empieza con scancodebase

Cinco formas de analizar un repositorio: el navegador, la línea de comandos, un git push, tu pipeline de CI y la API. Todas terminan en el mismo informe.

Elige cómo analizar

  • Sin cuenta

    Navegador

    Escribe la URL en la portada. Va bien para probarlo con un repositorio.

  • Cuenta gratuita

    Línea de comandos

    Instala sc y analiza con un comando. Va bien para el trabajo diario en tu máquina.

  • Cuenta gratuita

    git push

    Usa la herramienta que ya tienes. Va bien en máquinas donde no puedes instalar nada.

  • Skipper y superiores

    Pipeline de CI

    Revisa cada cambio antes del merge y para el pipeline si hay hallazgos graves.

  • Fleet

    API

    Lanza análisis y lee informes desde tus propias herramientas y paneles.

  • Todos los planes

    Informes

    Léelos en el navegador o en la terminal, y descárgalos en PDF, JSON o SARIF.

Cómo funciona un análisis

  1. Envías el repositorioDesde el navegador, la línea de comandos, un push, tu pipeline o la API.
  2. Leemos cada ficheroNo se ejecuta nada. El análisis corre en un worker aislado en la Unión Europea.
  3. Recibes un veredictoLista, casi lista o no lista, con los arreglos por orden de importancia.
  4. Lo que enviaste se borraSolo el informe se queda en tu cuenta, hasta que lo borres.

Inicio rápido

Instala la línea de comandos, inicia sesión y lanza tu primer análisis. Se tarda más o menos un minuto.

curl -fsSL https://scancodebase.com/install.sh | sh
sc login
sc code .

El resultado sale en tu terminal y el informe se guarda en tu cuenta.

En Windows, usa el instalador de PowerShell de la página de la línea de comandos.

Analizar desde el navegador

  1. Abre la página de inicio y pega la URL del repositorio en la caja.
  2. Para un repositorio privado, elige Repositorio privado y conecta GitHub, GitLab, Bitbucket o Azure DevOps.
  3. Para analizar un fichero de tu equipo, elige Subir un fichero y selecciónalo.
  4. Pulsa el botón. El informe se abre cuando termina el análisis.

Tokens de acceso

Un token de acceso permite que la línea de comandos, tu pipeline de CI y la API actúen en nombre de tu cuenta sin tu contraseña.

  • Créalo en la plataforma, en los ajustes de tu cuenta.
  • Solo se muestra una vez. Guárdalo en un gestor de contraseñas o como secreto en tu sistema de CI.
  • Puedes revocarlo cuando quieras. Los análisis que usen un token revocado se rechazan.

Límites

  • Sin cuenta: 1 análisis al día.
  • Cuenta gratuita: 5 análisis al día, hasta 30 al mes.
  • Planes de pago: un cupo mensual de análisis. Los análisis extra se cobran por cada 100.

Tus datos

Los repositorios que envías se borran al terminar el análisis. Solo se guarda el informe. Todo se almacena y se procesa en la Unión Europea: España es la región principal y Alemania la secundaria.

Preguntas habituales

¿Necesito una cuenta?

Para la primera prueba no: el navegador te da 1 análisis al día sin cuenta. La línea de comandos, el push y el historial necesitan una cuenta gratuita.

¿Tengo que instalar algo?

No. Puedes analizar desde el navegador o con un git push. La línea de comandos sc es opcional y es un único fichero.

¿La línea de comandos es gratis?

Sí. Funciona con una cuenta gratuita, dentro de los límites de tu plan.

¿Puedo analizar algo privado?

Sí. La línea de comandos analiza cualquier carpeta de tu máquina. Para un repositorio privado por URL, conecta antes tu plataforma de código.

¿Puedo descargar el informe?

Sí: desde tu cuenta, con sc download o por la API. Los formatos dependen de tu plan.

¿Adónde van mis datos?

A servidores en la Unión Europea: España es la región principal y Alemania la secundaria. Lo que envías se borra al terminar el análisis.

Más información

Escanea el tuyo antes del próximo merge.