Compatibilidad de Snyk Code con la CLI: ahora en beta pública
Frank Fischer
21 de septiembre de 2021
0 minutos de lecturaLa misión de Snyk es hacer que las herramientas de pruebas de seguridad de aplicaciones estáticas (SAST) funcionen para los desarrolladores a lo largo del pipeline de DevOps. Snyk Code analiza el código en tiempo real con gran precisión y lo hace directamente desde las herramientas y los flujos de trabajo que los desarrolladores ya usan. Por ejemplo, los plugins de IDE para IntelliJ, PyCharm, WebStorm y Visual Studio Code facilitan programar, analizar y corregir problemas incluso antes de que el código llegue al sistema de control de versiones. Además, con la interfaz de usuario web, los desarrolladores pueden analizar código heredado o hacer revisiones de código.
Además de todo esto, nos complace anunciar que Snyk Code ya forma parte de la interfaz de línea de comandos de Snyk (Snyk CLI) en beta pública. Ahora puedes integrar fácilmente Snyk Code en el proceso de CI/CD, con la flexibilidad de iniciar un análisis y trabajar con los resultados de forma automática.
Snyk ofrece una CLI para interactuar con cualquier elemento de la plataforma de Snyk. Snyk Code amplía la funcionalidad de la CLI existente. Este artículo te ayudará a comenzar; para profundizar, te invitamos a consultar nuestra documentación de la CLI de Snyk Code.
Como recordatorio, por ahora la compatibilidad con la CLI está en beta. Pruébala y envíanos tus comentarios para que podamos mejorarla.
Instalación y configuración de Snyk CLI
Snyk CLI es una aplicación de Node.js y, por lo tanto, puede ejecutarse en cualquier sistema compatible con Node.js. Además, es fácil de instalar y configurar.
Puedes instalarla con npm ejecutando: npm install -g snyk
Para conocer otras formas de instalarla y obtener más información sobre la instalación con npm, consulta nuestra documentación completa de la CLI de Snyk Code.
Una vez instalada, el siguiente paso es autenticarse. Para ello, ejecuta: snyk auth.
Esto iniciará un proceso de autenticación y guardará un token de identificación que podrás usar con la CLI de ahora en adelante.
Consejo: La CLI busca actualizaciones cada vez que se ejecuta. Si hay una actualización, te lo notificará e indicará el comando necesario. Para asegurarte de tener la versión más reciente, también puedes actualizarla manualmente ejecutando npm update -g snyk.
Analizar un proyecto o una carpeta
Para iniciar un análisis de Snyk Code con la CLI, ejecuta: snyk code test [my-folder-path]
Si no proporcionas el parámetro de ruta, la CLI analizará la carpeta actual. Y sí, recorrerá el árbol de directorios y analizará su contenido. Hay muchos otros comandos y parámetros disponibles; puedes consultarlos en nuestra documentación.
Si ya usas la CLI, ten en cuenta que esta beta no admite el comando monitor para Snyk Code.
Nota: La CLI agrupa los archivos de código fuente compatibles y los carga en Snyk para analizarlos. Ten en cuenta que, aunque los datos en tránsito y en reposo están cifrados, el código fuente saldrá de tus instalaciones. Antes de ejecutar la CLI en un repositorio, asegúrate de estar de acuerdo con esto.
Opciones de formato de resultados
La CLI puede presentar los resultados de tres maneras. La primera, y una buena forma de empezar a usarla, es simplemente ejecutarla. Esto generará un informe en un formato fácil de leer.
El nivel de gravedad se indica con colores y el resultado incluye una explicación de la vulnerabilidad, además de una solución recomendada.
Consejo: Snyk Code es muy rápido. Elige cualquier proyecto (o un repositorio de código abierto clonado) y simplemente ejecuta el análisis para comprobar que el sistema funciona.
Luego, la CLI ofrece un formato de datos llamado SARIF. Para obtenerlo, ejecuta snyk code test --sarif:
Este resultado es detallado y contiene todo —e incluso un poco más— de lo que puedes ver en la interfaz de Snyk Code. También incluye las correcciones de ejemplo y la puntuación de prioridad.
Consejo: Prepárate un café y explora el archivo SARIF. Como es JSON, en realidad no es tan difícil de entender. Contiene muchísima información y te aseguro que te dará muchas ideas sobre cómo usarla en tus procesos o para recopilar estadísticas.
Por último, la CLI proporciona un código de salida que puedes usar, por ejemplo, para dirigir un proceso de CI/CD. Estos son los códigos de salida que puedes esperar:
3: error: no se encontraron proyectos compatibles
2: error: vuelve a ejecutar el comando
1: se requiere una acción: se encontraron vulnerabilidades
0: éxito: no se encontraron vulnerabilidades
Puedes filtrar por nivel de gravedad usando el parámetro --severity-threshold=<low|medium|high> en el comando.
Prueba la beta de Snyk Code CLI
La CLI es una herramienta potente y queremos invitar a todas las personas a participar en la beta pública. Solo asegúrate de tener instalada la versión más reciente de Snyk CLI, de que Snyk Code esté habilitado para tu organización y ¡pruébala! Como está en beta, nos encantaría que la usaras y nos enviaras tus comentarios.
Y si recién conoces Snyk, el primer paso es crear una cuenta de Snyk con Snyk Code activado. Regístrate gratis hoy.
Comienza con Capture the Flag
Aprende a resolver desafíos de Capture the Flag con nuestro taller virtual 101 a pedido.

