Variables de entorno que lee cli.
scripts/docs/env.schema.tsPágina generada desde
scripts/docs/env.schema.ts. No se edita a mano:bun run docs:genla regenera ybun run docs:checkfalla si difiere.
16 variables.
| Variable | Qué controla | Defecto | Marcas | La leen |
|---|---|---|---|---|
DATABASE_URL | URL de PostgreSQL del servicio (usuario del servicio, sin contraseña). | — | obligatoria | catalog-svc, cli, identity-svc, playback-svc, realtime-svc, sources-svc, web, workers-svc |
HOME | Directorio personal del usuario. styx-upload guarda ahí el estado de reanudación (~/.local/state/styx) si no hay XDG_STATE_HOME; sin ninguno de los dos no reanuda. | — | — | cli, cli (zig) |
PATH | Ruta de búsqueda de ejecutables. El CLI styx busca en ella los binarios de cada runtime (systemctl, podman, docker…) antes de lanzarlos; sin ellos, la orden falla con código 127. | — | — | cli |
STYX_API_KEY_FILE | Ruta de un fichero con la API key personal (styx_pat_…: secreto de CI o de contenedor), alternativa a STYX_TOKEN; manda sobre ella. Distinta de STYX_TOKEN_FILE, que es el access token de admin de styx invite. | — | — | cli |
STYX_ETC | Directorio de configuración del CLI styx (styx.toml, secretos, trust.json). La opción --etc tiene prioridad. | /etc/styx | — | cli |
STYX_HEALTH_TIMEOUT_MS | Plazo del health gate de styx update, install y rollback, en ms. Un valor no numérico o ≤ 0 deja el de por defecto. | 120000 | — | cli |
STYX_IDENTITY_URL | URL de identity-svc para styx invite (https; http sólo en loopback). La opción --api-url tiene prioridad. | — | — | cli |
STYX_QUADLET_DIR | Directorio donde el adapter Podman Quadlet del CLI escribe sus unidades. Configurable para pruebas. | /etc/containers/systemd | sólo dev | cli |
STYX_ROOT | Raíz de instalación del CLI styx (releases/<tren>/ y el enlace current). La opción --root tiene prioridad. | /opt/styx | — | cli |
STYX_SERVER | Servidor de Styx al que habla styx login|whoami|token (https://…; http:// solo en loopback). --server manda; sin ninguno de los dos, el de las credenciales guardadas. | — | — | cli |
STYX_STATE | Directorio de estado del CLI styx (state.json, datos, copias). La opción --state tiene prioridad. | /var/lib/styx | — | cli |
STYX_SYSTEMD_UNIT_DIR | Directorio donde los adapters systemd nativo y Quadlet del CLI instalan las unidades de systemd. Configurable para pruebas. | /etc/systemd/system | sólo dev | cli |
STYX_SYSUSERS_FILE | Fichero sysusers.d donde el adapter systemd nativo del CLI declara los usuarios de cada servicio. Configurable para pruebas. | /etc/sysusers.d/styx.conf | sólo dev | cli |
STYX_TOKEN | API key personal (styx_pat_…) para styx en CI y agentes: sustituye al fichero de credenciales. Es un secreto en el entorno del proceso; en contenedores y CI mejor STYX_API_KEY_FILE. | — | — | cli |
STYX_TOKEN_FILE | Ruta del fichero con el access token de admin que usa styx invite (- lee la entrada estándar). La opción --token-file tiene prioridad. El token nunca va en una variable de entorno. | — | — | cli |
XDG_CONFIG_HOME | Base (ruta absoluta) del directorio de configuración del CLI: las credenciales van en $XDG_CONFIG_HOME/styx/credentials.json (0600). Sin valor, ~/.config. | — | — | cli |