Docs

Referencia de la CLI

El comando sypnia: cómo instalarlo, qué variables lee, qué significan sus códigos de salida y dónde está documentado cada comando.

Aplica a MotorNube Al lanzar

Ver como Markdown
En esta página
  1. Instalar
  2. Di dónde y quién
  3. Salida
  4. Códigos de salida
  5. Comandos

Motor Nube sypnia es un solo programa. Es el motor mismo (sypnia serve) y la herramienta que usas a su alrededor: crear proyectos y tokens, subir source maps desde tu build, leer problemas desde una terminal.

QuieresComandoFunciona con
Correr el motor en tu propio servidorsypnia serve, migrate, doctor, aggregateUn motor alojado por ti
Crear proyectos, llaves de ingesta y tokens de APIsypnia project, key, tokenUn motor alojado por ti. key y token también en Sypnia Cloud
Subir source maps en tu buildsypnia sourcemaps uploadLos dos
Ver qué está fallando, desde una terminalsypnia problems, sypnia problemLos dos

Si usas Sypnia Cloud y un SDK de framework como @sypnia/next, puede que nunca necesites la CLI: el SDK sube los source maps por su cuenta y la app hace el resto.

Instalar

Script

Terminal
curl -fsSL https://sypnia.com/install.sh | sh

Linux y macOS, x86-64 y ARM. Se instala en ~/.local/bin/sypnia.

Compruébalo:

Terminal
sypnia version
Deberías ver
sypnia 1.0.0 (a1c9e3f, 2026-03-01) schema 12

Di dónde y quién

Los comandos que hablan con la API necesitan saber cuál motor y cuál credencial. Los leen del entorno.

VariableLa usanQué es
SYPNIA_BASE_URLadmin, clientDónde está la API. Para un motor alojado por ti, su URL base, sin /v1. En la máquina del propio motor es además el ajuste que dice la dirección pública del motor. Por defecto: https://api.sypnia.com.
SYPNIA_API_TOKENadmin, clientUn token de API (sps_…). read para problems y problem; admin para sourcemaps upload, key y token.
SYPNIA_ROOT_TOKENadminEl token raíz de un motor alojado por ti. Hace falta para project create y project delete. Cuando los dos tokens están definidos, los comandos de administración usan el token raíz.
SYPNIA_PROJECTadmin, clientEl id o el slug de un proyecto. Solo hace falta con el token raíz; un token de API ya pertenece a un proyecto. Igual que --project.
SYPNIA_CONFIGengineRuta del archivo de configuración. Igual que --config.
SYPNIA_…engineCada ajuste del motor. Mira la referencia de configuración.
Contra Sypnia Cloud
export SYPNIA_API_TOKEN=<tu token de API>
sypnia problems
Contra tu propio motor
export SYPNIA_BASE_URL=https://sypnia.example.com
export SYPNIA_API_TOKEN=<tu token de API>
sypnia problems

La CLI nunca guarda un token. No tiene comando login y no escribe ningún archivo de configuración propio.

Salida

Por defecto la CLI imprime para personas: tablas, colores, frases cortas. Agrega --json a cualquier comando que lea datos e imprime exactamente lo que devuelve la API HTTP, para que un script lo use:

Terminal
sypnia problems --json | jq '.data[].slug'

Los errores van a la salida de error, en una línea: el code y el message de la API.

Códigos de salida

Los mismos en todos los comandos, para que un script sepa qué salió mal.

CódigoQué significa
0Todo salió bien.
1El comando corrió y la respuesta es no: una comprobación de doctor falló, una subida falló, la API respondió un error que no está en esta lista.
2Mal uso: una opción desconocida, un argumento que falta. No se hizo nada.
3Mala configuración: falta un ajuste obligatorio o no es válido, o el esquema de la base de datos es más viejo que el binario (corre sypnia migrate).
4No se pudo llegar a algo: la base de datos, el almacenamiento, la API o la red. Se puede reintentar sin riesgo.
5No permitido: falta el token, es desconocido, está revocado o no tiene el permiso (401, 403).
6No existe: no hay tal proyecto, problema, llave o token (404).

Comandos

Secciones

Empieza aquíQué es Sypnia, cómo funciona, qué es código abierto y qué es la nube de pago, y las dos maneras de recibir tu primer problema en palabras claras.ConceptosLas diez ideas de las que está hecho Sypnia, cada una definida con precisión, desde un proyecto y sus llaves hasta los problemas, las trazas y las alertas.SDKCómo envía tu app los datos a Sypnia. Un SDK para el navegador, uno para Node, uno para Next.js, y la entrada de OpenTelemetry para cualquier otro backend.El agenteCómo analiza Sypnia un problema, qué escribe, qué le envía a un modelo y qué nunca hace.MCP y skillsConecta tu agente de código a Sypnia para que pregunte qué está fallando en producción, lea lo que necesita para arreglarlo y configure Sypnia por ti.Referencia de la APILa API HTTP de Sypnia: una sola API para el motor de código abierto y para Sypnia Cloud, con cada endpoint, parámetro, respuesta y error.Referencia de la CLIEl comando sypnia: cómo instalarlo, qué variables lee, qué significan sus códigos de salida y dónde está documentado cada comando.Alojamiento propioQué corres cuando alojas tú mismo el motor de Sypnia, qué necesitas, cuánto cuesta y qué no tienes frente a Sypnia Cloud.Cómo está construido el motorTodo el motor de Sypnia en una página, desde un clic en tu app hasta la frase que lee tu agente de código, con las reglas de diseño y el código que las sostiene.Sypnia CloudCómo funciona el servicio pago, desde las organizaciones y los roles hasta los planes, los límites, la facturación, dónde viven tus datos, la GitHub App y el soporte.Privacidad y seguridadQué recoge Sypnia de tu app y de sus usuarios, qué no recoge nunca, cómo funciona el enmascarado, cómo eliminar datos y cómo se protege el servicio.LicenciasQué licencia cubre cada parte de Sypnia, qué puedes hacer con ella, cómo se puede usar el nombre, y los términos de una contribución.GuíasRecetas paso a paso para las formas comunes de usar Sypnia, desde apps hechas con constructores de IA y Next.js en Vercel hasta Supabase, source maps en CI, correos de alerta desde tu propio motor, y venir desde Sentry.ReferenciaLas páginas donde se consulta, desde el esquema de eventos y el glosario hasta lo planeado, el registro de cambios y las preguntas frecuentes.
↑↓ para moverte↵ para abrirEsc para cerrar