05/Documentation
Comandos
Cada verbo de collie, incorporación de collie al PATH y las acciones de Herdr que replican los verbos en una instalación gestionada por Herdr
Cada verbo utiliza el formato collie <verb>. Esta es la sintaxis canónica en todas las instalaciones, implementada directamente en el binario (cli/). Antes de añadir collie al PATH (abajo), ejecute bin/collie <verb> desde la raíz del repositorio. En una instalación gestionada por Herdr, estos mismos verbos se registran como acciones de Herdr (abajo) con un comportamiento idéntico.
Si el host ejecuta varias instancias, anteponga COLLIE_INSTANCE=<name> a cada verbo. Consulte Múltiples instancias de Collie en un mismo host.
| Verbo | Comando | Qué hace |
|---|---|---|
| Iniciar | collie start | Compilar si es necesario, servir y mostrar la URL |
| Detener | collie stop | Pausar el puente; no elimina nada |
| Reiniciar | collie restart | Detener y luego iniciar |
| Estado | collie status | El banner de Collie se está ejecutando + URLs |
| URL | collie url | Mostrar la URL de la tailnet |
| QR | collie qr | La misma URL en forma de código escaneable |
| Versión | collie version | La versión en ejecución (0.x.y+sha) |
| Actualizar | collie update | Preparar la versión más reciente de la versión principal actual, cambiar a ella, reiniciar y verificar (--check realiza comprobaciones previas, --status informa, --major pasa a otra versión principal) |
| Revertir | collie update --rollback | Restaurar la versión anterior (no en un checkout gestionado por Herdr, que no tiene ninguna preparada) |
| Desinstalar | collie uninstall | Eliminar el servicio; conservar .env y la instalación |
| Vincular | collie pair | Imprime un código de 8 caracteres y un código QR, válidos durante 10 minutos; escanee el código QR para abrir Settings → Paired devices con el código rellenado, o introduzca el código manualmente para obtenerlo vinculado |
| Dispositivos | collie devices list · collie devices revoke <label> | Listar / revocar dispositivos emparejados |
| Vincular | collie link · collie unlink | Añadir collie al PATH (abajo) |
| Registros | collie logs | Seguir el journal / archivo de registro |
| Voz | collie stt setup · stt test · stt status · stt off | Configurar / comprobar / desactivar entrada de voz |
| Claves push | collie push-keys | Generar el par de claves VAPID en .env |
| Prueba push | collie push-test | Enviar una notificación para comprobar que funciona |
La CLI también incluye build, serve, unserve, doctor y pack … para tareas menos frecuentes.
Tanto start como status muestran el encabezado de Collie se está ejecutando: una marca de estado y la versión, seguidas de una línea service, una local y una tailnet. Primera ejecución lo muestra completo, incluido lo que imprime en su lugar una comprobación de estado fallida. La versión reportada se lee del sello del paquete servido, reflejando la compilación activa.
Ink o texto plano. Los comandos start, status, doctor, pack add y pack status muestran una interfaz de terminal interactiva cuando stdout es una TTY. Si se pasa --plain, o si se redirige la salida a una tubería, archivo, journal de systemd o ejecutor de CI, se recurre a la salida de líneas sin formato.
Añadir collie al PATH
Ejecute collie link para publicar ~/.local/bin/collie:
bin/collie link # ~/.local/bin/collie → <checkout>/bin/collie
collie status # from anywhere
bin/collie unlink # take the name back downCrea un enlace simbólico al binario del checkout, de modo que las futuras actualizaciones de collie build se apliquen inmediatamente sin pasos adicionales (ADR 0021). El comando reemplaza los enlaces existentes de otros checkouts de Collie e imprime cuál se sobrescribió. Se rehúsa a sobrescribir archivos que no sean de Collie en esa ruta. unlink elimina el enlace simbólico solo si apunta a su checkout actual.
Si ~/.local/bin no está en su PATH, link muestra una advertencia y finaliza. Nunca edita el perfil de la shell. Ejecute collie doctor para comprobar la línea path-link y ver a qué checkout resuelve el comando collie directo.
Acciones de Herdr
Se aplica solo a una instalación administrada por Herdr creado con herdr plugin install AltanS/collie o herdr plugin link. Herdr es uno de los tres multiplexores compatibles con Collie. Estas acciones se asignan directamente al adaptador: cada acción reenvía el verbo al mismo binario collie documentado en la tabla anterior. En instalaciones binarias creadas mediante scripts/install.sh, las acciones de plugins no existen y collie <verb> es la única sintaxis.
Collie registra estas acciones en herdr-plugin.toml. Ejecútelas con herdr plugin action invoke <id> --plugin herdr.collie, o consúltelas con herdr plugin action list --plugin herdr.collie:
<id> | Verbo equivalente | Qué hace |
|---|---|---|
start | collie start | Compilar si es necesario, iniciar el servicio, tailscale serve, imprimir URL + banner |
stop | collie stop | Pausar el puente; no elimina nada |
restart | collie restart | stop + start |
status | collie status | El banner de Collie se está ejecutando: estado de preparación ✓/⚠, versión, URL |
url | collie url | Mostrar la URL de la tailnet |
version | collie version | Imprimir la versión en ejecución (0.x.y+sha) |
update | collie update | Avanzar el checkout (pull, o fetch + re-detach) + recompilar + reiniciar |
uninstall | collie uninstall | Desmantelar el servicio (conserva .env + checkout) |
push-keys | collie push-keys | Escribir un par de claves VAPID en el .env que lee el servicio |
push-test | collie push-test | Enviar una notificación push a cada dispositivo suscrito |
qr, pair, devices, link, logs y stt no tienen una acción de plugin correspondiente porque requieren un terminal, argumentos posicionales o ambos. Ejecútelos como collie <verb>.
Las acciones de Herdr devuelven el envoltorio JSON de Herdr en lugar del banner de terminal. Vea la salida estándar capturada de la acción con herdr plugin log list --plugin herdr.collie, o ejecute collie <verb> directamente para imprimir la salida en línea. La salida de herdr plugin list --json refleja la versión almacenada en caché durante plugin link, no la versión activa. Para clones vinculados, update vuelve a vincular automáticamente para corregir la caché. Puede forzar esto con herdr plugin link "$(pwd)". Herdr ≥0.8.0 vuelve a leer el manifiesto del disco en cada invocación.
Nota. Se mantiene la compatibilidad conscripts/collie-ctl.sh <verb>. Funciona como un shim de arranque: localiza Bun, compilabin/colliesi el clon carece de él y reenvía argv. Un clon recién vinculado utiliza esta ruta para compilar su binario inicial. Las acciones de Herdr siguen apuntando a este script porque Herdr <0.8.0 congela las definiciones de acciones almacenadas en caché durante la instalación (ADR 0006). Cada verbo se implementa una sola vez dentro del binario compilado encli/.