Skip to Content
SecaniDocumentación

Secani CLI

Trabaje con su SGSI de Secani desde el terminal, en scripts y desde agentes de programación.

La CLI de Secani, secani, lleva sus riesgos, tareas, hallazgos, medidas e incidentes al terminal. Las personas la usan para consultas y cambios rápidos, los scripts de shell leen su salida JSON y los agentes de programación como Claude Code, Codex o Cursor pueden trabajar con su SGSI sin configurar MCP por su cuenta. Se comunica con Secani MCP y tiene los mismos permisos que su cuenta.

Instalación

npm install --global secani

O ejecútela sin instalarla:

npx secani login

La CLI necesita Node.js 22.12 o posterior y una cuenta de Secani. Es de código abierto con la licencia Apache-2.0: github.com/secani/cli.

Iniciar sesión

secani login

La CLI muestra una página de inicio de sesión y un código, y abre la página en su navegador. Inicie sesión con su cuenta de Secani y confirme el código en un plazo de cinco minutos. Por SSH o en un contenedor, use secani login --no-open y abra la página en cualquier dispositivo.

La sesión se guarda solo para su usuario, en ~/.config/secani/auth.json (cambie el directorio con SECANI_CONFIG_DIR), y se renueva sola. secani whoami muestra la cuenta y el espacio de trabajo actual, y secani logout elimina la sesión de este equipo.

La conexión empieza en solo lectura. Para crear o cambiar registros, permita la escritura para Secani CLI en la aplicación de Secani, en Configuración > Integraciones. En la misma página puede terminar la conexión.

Elegir un espacio de trabajo

secani workspaces list
secani workspaces switch acme/isms

Los espacios de trabajo se nombran <organización>/<espacio>. Use --workspace acme/isms o defina SECANI_WORKSPACE para elegir uno en un solo comando. Si solo tiene uno, la CLI lo usa automáticamente.

Comandos

ComandoQué hace
secani login, logout, whoamiIniciar y cerrar sesión, mostrar la cuenta y el espacio de trabajo actual
secani workspaces list, switchListar espacios de trabajo y elegir el actual
secani risks list, inspect, create, update, deleteEl registro de riesgos
secani controls list, inspectMedidas (controles)
secani findings list, inspectHallazgos de auditorías y evaluaciones
secani tasks list, inspect, create, update, archive, restoreTareas
secani incidents list, create, updateIncidentes de seguridad
secani search <consulta>Activos, tareas, requisitos y evidencias
secani tools list, inspect, callCualquier herramienta de Secani MCP

Cada comando explica sus opciones con --help, y secani help search <palabras> encuentra el comando para una tarea. Algunos ejemplos:

secani tasks list --assignee me --open
secani risks list --min-level high
secani tasks update TASK-12 --status done
secani incidents create --title "Correo de phishing abierto" --severity high
secani search backup --framework "ISO 27001"

Los comandos que trabajan en un framework, como crear un riesgo o buscar requisitos, aceptan --framework con el nombre o el ID del framework, o usan el único framework del espacio de trabajo.

Scripts y agentes de programación

  • --json imprime exactamente un documento JSON y nunca hace preguntas. Las listas devuelven los registros y un cursor pagination.next; los cambios devuelven el registro, un outcome como created o updated y el comando para consultarlo.
  • Los errores son una única línea JSON en stderr con un reason estable, por ejemplo login_required o missing_workspace, y status: "action_required" cuando un dato o la aprobación de una persona permitiría ejecutar el comando.
  • La salida redirigida está separada por tabulaciones, con una fila de encabezado y fechas ISO. Un cambio redirigido solo imprime el ID del registro.
  • Los agentes de programación se reconocen automáticamente: nunca reciben preguntas y siempre indican el espacio de trabajo con --workspace o SECANI_WORKSPACE.
  • Eliminar un riesgo, archivar una tarea y las herramientas MCP destructivas piden confirmación. Sin terminal necesitan --yes, que un agente solo debe añadir tras la aprobación de una persona.
  • Cada cambio lleva una clave de idempotencia. Si la conexión se corta después de enviar un cambio, la CLI muestra el comando para repetirlo con --request-id; Secani lo aplica como máximo una vez.
  • --limit es el número total de resultados en todas las páginas, y --next <cursor> continúa una lista con los mismos filtros.

Códigos de salida: 0 hecho (también resultados vacíos y nada que hacer), 1 fallido, 2 uso incorrecto o falta un dato, 130 cancelado.

Variables de entorno

VariableEfecto
SECANI_WORKSPACEEspacio de trabajo para cada comando; debe coincidir con --workspace si ambos están definidos
SECANI_TOKENUn token de acceso para Secani MCP en lugar de la sesión guardada. Los tokens duran poco
SECANI_CONFIG_DIRDirectorio de la sesión y la configuración
SECANI_ACCESSIBLE=1Palabras en lugar de símbolos
SECANI_GUIDANCE_DISABLED=1Sin pasos siguientes opcionales
NO_COLOR, FORCE_COLORDesactivar o forzar el color
CIEjecutar sin preguntas

Código fuente y comentarios

La CLI se desarrolla de forma abierta en github.com/secani/cli y se publica en npm como secani. Informe de errores e ideas como issues de GitHub, y de problemas de seguridad de forma privada en la pestaña Security del repositorio.