GuíasCLI

Comandos del CLI

El CLI styx objetivo, agrupado por área, con qué decisión define cada comando. Referencia escrita a mano hasta que exista la generada.

Especificado. Hoy existen en apps/cli los comandos de instalación y operación del servidor (install, update, rollback, status, backup, doctor, render) y los de acceso (login, logout, whoami, token, device: ver entrar con el CLI), además de styx-upload (subir ficheros). El resto de la API sigue por hacer. Cuando exista el CLI completo, la referencia exacta (referencia/cli) se genera del registro de operaciones y esta página pasa a enlazarla.

Hay un solo binario, styx, que sirve para instalar y operar el servidor y para usar la API. Cada cosa que hace la interfaz web existe como operación de la API y como comando. Reglas comunes en salida JSON y códigos de salida.

Quién define cada comando

La columna "Fuente" distingue lo que ya está en un ADR (aunque sea PROPOSED) de los nombres provisionales, que fija el ADR de headless (docs/track/docs/tickets/12.md).

GrupoComandosFuente
Instalacióninstall, update, rollback, status, doctor, logs, config, secrets rotate, channel, self-update, uninstall, render, verifydec-0123 D6
Copiasbackup create, backup list, backup restore, backup prunedec-0123 D6
Sesiónlogin [--server URL], login --with-token, auth status, auth methods, auth switch-profile, logout [--all]dec-0125 §10-11
Cuentasaccount list|show|update|set|delete, profile list|create|update|delete, profile pin set|cleardec-0125 §11
Hogareshousehold create|show|update|delete|leave, household member set|removedec-0125 §11
Invitacionesinvite create|list|show|revoke|inspectdec-0125 §11
Claves y dispositivoskey create|list|revoke|rotate, device list|approve|revoke, server setupdec-0125 §9-11
Bibliotecalibrary root set, library embed [--dry-run], library embed status, library prepare, library import nfodec-0126 §9
Biblioteca (resto)añadir raíz, escanear, listar, subirProvisional: nombres por fijar en el ADR de headless
Servidorserver … (estado, salud, configuración de runtime)Provisional

Principios

  • styx install y styx update son transacciones: el resumen de pasos, el rollback y el --dry-run están en Instalar y Actualizar.
  • Todo lo destructivo pide confirmación y admite --dry-run.
  • Sin secretos en argumentos: las claves y tokens se leen de stdin o de una variable, nunca de argv, que cualquiera ve en ps.
  • El CLI no es un supervisor: no queda residente ni vigila procesos. Habla con el runtime de despliegue por su API.
  • Autenticación: styx login usa el flujo de autorización de dispositivo (conectar la TV y el CLI); en scripts, una API key.