Resumen/Scripts y CLI

x — CLI

x es la CLI de aprovisionamiento del sistema x (ADR-0003 en DECISIONS.md en la raíz del workspace). Su implementación vive en bin/ de este repo y se instala como /usr/bin/x (symlink a /usr/share/x/bin/x) con el paquete x-scripts. Trabajando desde un checkout se invoca como bash bin/x.

El despacho es por convención de nombres más metadatos en comentarios de cabecera, sin registro central: añadir un comando es añadir un archivo en bin/.

Uso

x <command> [arguments]
x help          # o: x list, x -h, x --help

x sin argumentos imprime la ayuda. El dispatcher exporta X_BIN (el directorio bin/) y X_CLI=1 para que los subcomandos sepan que corren vía CLI.

Comandos

Los resúmenes son las cabeceras x:summary de cada archivo (los muestra x help).

Los comandos solo-root lo hacen cumplir dentro del dispatcher (ver metadatos más abajo) e imprimen un error si se ejecutan como usuario no root.

Aliases

Los aliases se definen con el metadato x:aliases y permiten que un token único mapee a un archivo de comando:

Mecánica del despacho

La resolución prueba primero el prefijo de nombre de archivo más largo y luego cae al primer argumento comparado contra x:aliases:

• x theme set nord → busca x-theme.sh, luego x-theme-set.sh; existe este último, así que nord se pasa a x-theme-set.sh.
• x theme (token único) → no hay x-theme.sh; el alias theme de x-theme-list.sh coincide.
• x inexistente → error con ayuda (exit 1).

El archivo debe ser ejecutable para poder resolverse. El dispatcher solo consume x:summary, x:aliases y x:root; el resto de argumentos se reenvían al subcomando, que valida sus propios argumentos (x setup --help, x theme set con arity incorrecto da error, etc.).

Cómo añadir un comando

Crea bin/x-<grupo>-<verbo>.sh como script ejecutable con metadatos en la cabecera:

#!/usr/bin/env bash
# x:summary=una línea mostrada por x help
# x:aliases=alias1 alias2      # opcional
# x:root=true                  # opcional: exige root para ejecutarse
set -euo pipefail

X_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
# ...

• x:summary — descripción de una línea, mostrada en x help y x list.
• x:aliases — aliases opcionales separados por espacios, resueltos contra el primer token.
• x:root=true — hace que el dispatcher se niegue a ejecutarlo como usuario no root.
• x:args — opcional; solo informativo, no lo parsea el dispatcher. Úsalo para documentar los argumentos esperados en la cabecera.

No hay registro central ni paso de registro.

Variables de entorno

Las variables específicas del setup de Hyprland (X_HYPR_*) se documentan en hyprland.md.

Estado

• ~/.local/state/x/ — estado de usuario: theme (tema activo) y migrations/<name> (marcadores de migración aplicada).
• ~/.config/x/ — config de usuario generada, p.ej. theme.conf.
• ~/.local/share/x/home-gens/ — generaciones de home (manifiesto, copia de dotfiles y files.sha256).
• /var/lib/x/ — estado de sistema: generations/<id>/ (manifiestos y capturas) y current (id de la generación actual); los snapshots viven en /.snapshots/.

Los overrides de entorno anteriores permiten que los tests y el desarrollo redirijan cada ruta de estado/salida fuera del home real (ver test/smoke.sh).

x setup --online

Ejecuta el instalador original de equisdots (equisdots/dots setup) desde un clon temporal y lo limpia después. Úsalo cuando ya hayas iniciado sesión y el setup empaquetado offline no baste. Pedirá la contraseña de sudo cuando el script original la necesite.

x setup --user --online

Editar esta página en GitHub