Referencia del CLI
Referencia completa del CLI sureva. Todos los comandos devuelven JSON por defecto. Usá --output table para salida legible en terminal.
Flags globales
Sección titulada «Flags globales»| Flag | Valores | Por defecto | Descripción |
|---|---|---|---|
--output | json|table | json | Formato de salida |
--org <slug> | string | — | Slug de organización; sobreescribe SUREVA_ORG y el archivo de configuración |
--config <path> | ruta | — | Ruta a un archivo de configuración alternativo |
--json | — | — | Solo válido con --help; emite un JSON con el árbol de comandos legible por máquinas |
Comandos
Sección titulada «Comandos»version
Sección titulada «version»sureva version# o tambiénsureva --versionDevuelve información de versión como JSON:
{ "version": "0.x.y", "commit": "...", "built_at": "..." }auth whoami
Sección titulada «auth whoami»sureva auth whoamiMuestra la identidad del usuario (email / ID) asociada al token actual.
auth token create
Sección titulada «auth token create»sureva auth token create [--name <string>] --expires-at <RFC3339>Crea un token de acceso personal. El valor del token (sapi_<hex>) se muestra exactamente una vez y no puede recuperarse después.
| Flag | Requerido | Descripción |
|---|---|---|
--name | No | Etiqueta legible para el token; por defecto cli-token si se omite |
--expires-at | Sí | Expiración en formato RFC 3339, p. ej. 2026-12-31T00:00:00Z |
auth token list
Sección titulada «auth token list»sureva auth token listLista todos los tokens de acceso personal del usuario autenticado. El valor del token nunca se muestra en el listado.
auth token revoke
Sección titulada «auth token revoke»sureva auth token revoke <id>Revoca el token con el ID indicado.
orgs list
Sección titulada «orgs list»sureva orgs listLista todas las organizaciones a las que pertenece el usuario autenticado.
teams list
Sección titulada «teams list»sureva teams list --org <slug>Lista todos los equipos de la organización resuelta.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
apps list
Sección titulada «apps list»sureva apps list [--org <slug>]Lista las apps. Sin --org, devuelve una lista plana de todas las organizaciones. Con --org, limita los resultados a esa organización.
| Flag | Requerido | Descripción |
|---|---|---|
--org | No | Slug de organización |
Cada app incluye un campo url compuesto (https://{subdomain}.sureva.com) cuando domain_status es active. El campo url está ausente hasta que el dominio esté activo (normalmente después del primer deploy exitoso).
apps get
Sección titulada «apps get»sureva apps get <app-id> --org <slug>Devuelve los detalles completos de una app.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
La respuesta incluye un campo url compuesto (https://{subdomain}.sureva.com). El campo url está ausente (omitempty) hasta que domain_status llega a active. El sufijo de host por defecto es sureva.com; se puede sobreescribir con SUREVA_DOMAIN_SUFFIX o la clave domain_suffix en el archivo de configuración.
apps create
Sección titulada «apps create»sureva apps create --name <string> --type <tipo> --region <region> --org <slug> [opciones]Crea una nueva aplicación.
| Flag | Requerido | Descripción |
|---|---|---|
--name | Sí | Nombre / slug de la aplicación |
--type | Sí | web | web-ssr | api | sse |
--region | Sí | us-east-1 | us-east-2 | sa-east-1 |
--runtime | Requerido cuando --type no es web | nodejs24 | python314 | go126 |
--team | No | Slug o ID del equipo (se selecciona automáticamente cuando la org tiene exactamente un equipo) |
--wait | No | Espera hasta que el dominio esté activo antes de retornar |
--wait-interval | No | Intervalo de polling (por defecto 5s) |
--wait-timeout | No | Tiempo máximo de espera (por defecto 10m) |
apps delete
Sección titulada «apps delete»sureva apps delete <app-id> --org <slug> --yesInicia el proceso de eliminación asincrónico de una aplicación.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
--yes | Sí | Confirma la eliminación (requerido para evitar eliminaciones accidentales en scripts) |
env get
Sección titulada «env get»sureva env get <app-id> --org <slug> [--reveal]Lee las variables de entorno de la app. Los valores se enmascaran (***) por defecto.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
--reveal | No | Muestra los valores sin enmascarar |
env set
Sección titulada «env set»sureva env set <app-id> --org <slug> CLAVE=VALOR [CLAVE=VALOR...]Reemplaza todas las variables de entorno de la app (reemplazo completo tipo PUT). Cualquier clave no incluida en el comando se elimina.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
deploys trigger
Sección titulada «deploys trigger»sureva deploys trigger <app-id> --org <slug> [--tag <release-tag>] [--env-id <id>] [--wait]Activa un nuevo deploy.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
--tag | Requerido para apps de tipo API y SSE; opcional para apps web | Tag de release a desplegar |
--env-id | No | ID del ambiente de destino (usa el ambiente por defecto si se omite) |
--wait | No | Espera hasta que el deploy llegue a un estado terminal antes de retornar |
--wait-interval | No | Intervalo de polling (por defecto 5s) |
--wait-timeout | No | Tiempo máximo de espera (por defecto 15m) |
deploys list
Sección titulada «deploys list»sureva deploys list <app-id> --org <slug>Lista los deploys recientes de la app.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
deploys status
Sección titulada «deploys status»sureva deploys status <app-id> <deploy-id> --org <slug>Devuelve el estado y los detalles de un deploy individual.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
sureva logs <app-id> --org <slug> [--env-id <id>]Obtiene un snapshot de logs no streaming. Resuelve automáticamente el ambiente por defecto cuando se omite --env-id.
| Flag | Requerido | Descripción |
|---|---|---|
--org | Sí | Slug de organización |
--env-id | No | ID del ambiente (usa el ambiente por defecto si se omite) |
Códigos de salida
Sección titulada «Códigos de salida»| Código | Significado |
|---|---|
0 | Éxito |
1 | Error general / error de API |
2 | Error de autenticación (401 / 403 / token faltante) |
3 | No encontrado (404) |
4 | Error de validación / entrada incorrecta (400 / 422) |
5 | Error de red |
Usá los códigos de salida en scripts y agentes para manejar fallos sin parsear texto de error. Consultá Uso con agentes para patrones de scripting.