Saltar al contenido
ColliePWA

18/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.

VerboComandoQué hace
Iniciarcollie startCompilar si es necesario, servir y mostrar la URL
Detenercollie stopPausar el puente; no elimina nada
Reiniciarcollie restartDetener y luego iniciar
Estadocollie statusEl banner de Collie se está ejecutando + URLs
URLcollie urlMostrar la URL de la tailnet
QRcollie qrLa misma URL en forma de código escaneable
Versióncollie versionLa versión en ejecución (0.x.y+sha)
Skillcollie skillResumen técnico de Collie orientado a agentes, para un agente de programación con IA que opera en su terminal (también collie --skill). collie skill install, uninstall, sync, status y print administran la habilidad walky talky en los archivos de instrucciones de sus agentes; collie update ejecuta sync tras cada actualización (Instalar la habilidad)
Documentacióncollie docs · collie docs <name> · collie docs --allEstas páginas, generadas directamente desde el propio binario
Actualizarcollie updatePreparar 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)
Revertircollie update --rollbackRestaurar la versión anterior (no en un checkout gestionado por Herdr, que no tiene ninguna preparada)
Desinstalarcollie uninstallEliminar el servicio; conservar .env y la instalación
Vincularcollie pair · collie pair --expires <duration>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 → System → Paired devices con el código ya completado, o introduzca el código manualmente para obtenerlo vinculado. Sin --expires, el token nunca expira y el comando así lo indica; con él (12h, 30d, 2w), el comando imprime la fecha en la que el token deja de funcionar una vez reclamado. Un script reclama el código con una etiqueta propia, por ejemplo script, y lo empareja una sola vez (Asignar una caducidad a un dispositivo)
Dispositivoscollie devices list · collie devices revoke <label> · collie devices set-expiry <label> <duration> · collie devices clear-expiry <label>Lista o revoca dispositivos emparejados, o cambia cuándo expira uno caduca. list muestra la expiración de cada dispositivo como no expiry, expires <date> o EXPIRED <date>. set-expiry cuenta un nuevo periodo de validez a partir de ahora; clear-expiry lo elimina. Una etiqueta coincide de forma exacta, o sin distinción de mayúsculas y minúsculas cuando solo encaja un dispositivo
Vincularcollie link · collie unlinkAñadir collie al PATH (abajo)
Registroscollie logsSeguir el registro del servicio con tail
Configuracióncollie config show · collie config check · collie config initImprima cada ajuste con su origen, valide el archivo o escriba un config.toml comentado (el archivo de configuración)
Durable agentscollie durable attach <name> --socket <path> · collie durable attach <name> --url <url> --token-env <VAR> · collie durable detach <name> · collie durable listAñada un agente duradero a sources.json, elimínelo o liste cada agente duradero con el estado que le asigna el puente en ejecución. attach y detach se aplican en el siguiente reinicio, o de inmediato con --restart. Opciones, salida y códigos de salida: Durable agents
Walky talkycollie walky who · collie walky send <address> <text> · collie walky reply <id> <text> · collie walky inbox · collie walky status <id>Enviar un mensaje a una sesión de agente desde una terminal, o de un agente a otro (Walky talky)
Vozcollie stt setup · stt test · stt status · stt offConfigurar / comprobar / desactivar entrada de voz
Claves pushcollie push-keysGenerar el par de claves VAPID en .env
Prueba pushcollie push-testEnviar una notificación para comprobar que funciona

La CLI también incluye build, serve, unserve, doctor y crew … 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, crew add y crew 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.

collie doctor indica qué estado leyó. Su primera línea indica la instancia (default, o el nombre en COLLIE_INSTANCE) y el directorio de estado que lee. Si ejecuta dos vías en una misma máquina, compruebe esa línea antes de dar por válido el resto, ya que un intérprete con un COLLIE_INSTANCE incorrecto leerá la vía equivocada. --json proporciona los mismos dos valores que instance y stateDir en la entrada collie.

collie doctor lista sus programas de agente. Cada programa para el que Collie dispone de un perfil de entrada recibe una fila harness-<name>: el archivo que Collie ejecutaría en el PATH del intérprete de inicio de sesión, la versión mostrada y el veredicto del perfil sobre esa versión. Una versión superior al rango verificado es solo una advertencia, ya que los envíos durante un turno siguen considerándose válidos. La fila avisa cuando el archivo se resuelve pero su versión no se puede leer, por ejemplo un ejecutable envoltorio situado antes en PATH que requiere $HOME, o una instalación dañada: hasta que la versión se pueda leer, Collie trata cada envío a ese programa como provisional. Un programa no instalado muestra not installed. En --json, cada fila incluye también harness, binary, version y profileStatus.

La fila nombra la copia presente en su PATH, ya que collie doctor no dispone de un panel que examinar. Un envío en Herdr consulta al programa en ejecución en su panel, por lo que un panel que ejecuta otra copia, iniciada mediante su ruta completa o instalada en un proyecto, muestra la versión de esa copia en sus comprobantes.

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 down

Crea 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 cinco multiplexores que admite 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 equivalenteQué hace
startcollie startCompilar si es necesario, iniciar el servicio, tailscale serve, imprimir URL + banner
stopcollie stopPausar el puente; no elimina nada
restartcollie restartstop + start
statuscollie statusEl banner de Collie se está ejecutando: estado de preparación ✓/⚠, versión, URL
urlcollie urlMostrar la URL de la tailnet
versioncollie versionImprimir la versión en ejecución (0.x.y+sha)
updatecollie updateAvanzar el checkout (pull, o fetch + re-detach) + recompilar + reiniciar
uninstallcollie uninstallDesmantelar el servicio (conserva .env + checkout)
push-keyscollie push-keysEscribir un par de claves VAPID en el .env que lee el servicio
push-testcollie push-testEnviar una notificación push a cada dispositivo suscrito

qr, pair, devices, link, logs, stt y config no tienen una acción de complemento 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 con scripts/collie-ctl.sh <verb>. Funciona como un shim de arranque: localiza Bun, compila bin/collie si 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 en cli/.

Editar esta página en GitHub

The rest of the documentation