Direkt zum Inhalt
ColliePWA

18/Documentation

Befehle

Jedes collie-Verb, das Hinzufügen von collie zu Ihrem PATH und die Herdr-Aktionen, die den Verben bei einer von Herdr verwalteten Installation entsprechen

Jedes Verb verwendet das Format collie <verb>. Dies ist die kanonische Syntax für alle Installationen, die direkt im Binary (cli/) implementiert ist. Bevor Sie collie zu Ihrem PATH (unten) hinzufügen, führen Sie bin/collie <verb> aus dem Wurzelverzeichnis des Repositorys aus. Bei einer von Herdr verwalteten Installation registrieren sich dieselben Verben als Herdr-Aktionen (unten) mit identischem Verhalten.

Wenn auf dem Host mehrere Instanzen laufen, stellen Sie jedem Verb COLLIE_INSTANCE=<name> voran. Siehe Mehrere Collie-Instanzen auf einem Host.

VerbBefehlFunktion
Startencollie startBei Bedarf erstellen, ausliefern, URL ausgeben
Stoppencollie stopBridge anhalten; entfernt nichts
Neu startencollie restartStoppen, dann starten
Statuscollie statusDas Banner Collie läuft + URLs
URLcollie urlTailnet-URL ausgeben
QRcollie qrDieselbe URL als scannbarer Code
Versioncollie versionDie laufende Version (0.x.y+sha)
Skillcollie skillDie an den Agenten gerichtete Kurzanleitung zu Collie für einen KI-Coding-Agenten, der in Ihrem Terminal arbeitet (auch collie --skill). collie skill install, uninstall, sync, status und print verwalten den Walky-Talky-Skill in den Anweisungsdateien Ihrer Agenten; collie update führt nach jeder Aktualisierung sync aus (Den Skill installieren)
Dokumentationcollie docs · collie docs <name> · collie docs --allDiese Seiten, direkt aus der Binärdatei ausgegeben
Aktualisierencollie updateDas neueste Release Ihrer Major-Version bereitstellen, darauf umschalten, neu starten und überprüfen (--check prüft vorab, --status berichtet, --major führt ein Major-Upgrade durch)
Zurücksetzencollie update --rollbackDie vorherige Version wiederherstellen (nicht bei einem von Herdr verwalteten Checkout, da dort keine Version bereitgestellt ist)
Deinstallierencollie uninstallDienst entfernen; .env und die Installation behalten
Koppelncollie pair · collie pair --expires <duration>Geben Sie einen 8-stelligen Code und einen QR-Code aus, gültig für 10 Minuten; scannen Sie den QR-Code, um Einstellungen → System → Gekoppelte Geräte mit vorausgefülltem Code zu öffnen, oder geben Sie den Code manuell ein, um ihn gekoppelt zu erhalten. Ohne --expires läuft das Token nie ab, und der Befehl meldet dies; mit der Option (12h, 30d, 2w) gibt der Befehl das Datum aus, an dem das Token nach dem Anfordern ungültig wird. Ein Skript fordert den Code mit einer eigenen Kennung an, beispielsweise script, und koppelt einmalig (Einem Gerät ein Ablaufdatum geben)
Gerätecollie devices list · collie devices revoke <label> · collie devices set-expiry <label> <duration> · collie devices clear-expiry <label>Gekoppelte Geräte auflisten / widerrufen oder ändern, wann eines läuft ab. list zeigt den Ablauf jedes Geräts als no expiry, expires <date> oder EXPIRED <date> an. set-expiry berechnet eine neue Gültigkeitsdauer ab jetzt; clear-expiry entfernt es. Eine Kennung passt exakt oder ohne Berücksichtigung der Groß-/Kleinschreibung, wenn nur ein Gerät zutrifft
Verknüpfencollie link · collie unlinkcollie zu Ihrem PATH hinzufügen (unten)
Protokollecollie logsDas Dienst-Protokoll fortlaufend anzeigen
Konfigurationcollie config show · collie config check · collie config initGeben Sie jede Einstellung samt Quelle aus, validieren Sie die Datei oder schreiben Sie eine kommentierte config.toml (die Konfigurationsdatei)
Persistente Agentencollie durable attach <name> --socket <path> · collie durable attach <name> --url <url> --token-env <VAR> · collie durable detach <name> · collie durable listEinen durable agent zu sources.json hinzufügen, ihn entfernen oder jeden durable agent mit dem Status auflisten, den die laufende Bridge ihm zuweist. attach und detach greifen beim nächsten Neustart oder sofort mit --restart. Flags, Ausgabe und Exit-Codes: Persistente Agenten
Walky-Talkycollie walky who · collie walky send <address> <text> · collie walky reply <id> <text> · collie walky inbox · collie walky status <id>Senden Sie Nachrichten an eine Agenten-Sitzung aus einem Terminal oder von einem Agenten zu einem anderen (Walky-Talky)
Sprachecollie stt setup · stt test · stt status · stt offSpracheingabe konfigurieren / prüfen / deaktivieren
Push-Schlüsselcollie push-keysDas VAPID-Schlüsselpaar in Ihrer .env generieren
Push-Testcollie push-testEine Benachrichtigung senden, um die Funktion zu prüfen

Die CLI enthält außerdem build, serve, unserve, doctor und crew … für seltenere Aufgaben.

Sowohl start als auch status geben das Collie läuft-Banner aus: einen Zustandsstatus und die Version, gefolgt von einer service-, einer local- und einer tailnet-Zeile. Erster Aufruf zeigt es vollständig an, einschließlich der Ausgabe bei einer fehlgeschlagenen Zustandsprüfung. Die gemeldete Version stammt aus dem Zeitstempel des ausgelieferten Bundles und spiegelt den aktiven Build wider.

Ink oder reiner Text. Die Befehle start, status, doctor, crew add und crew status stellen eine interaktive Terminal-Benutzeroberfläche dar, wenn stdout ein TTY ist. Durch Übergabe von --plain oder die Umleitung der Ausgabe in eine Pipe, Datei, ein systemd-Journal oder einen CI-Runner wird auf reine Zeilenausgabe zurückgegriffen.

collie doctor gibt an, welcher Zustand gelesen wurde. Seine erste Zeile nennt die Instanz (default oder der Name in COLLIE_INSTANCE) und das Zustandsverzeichnis, das es liest. Führen Sie zwei Lanes auf einem Rechner aus, prüfen Sie diese Zeile, bevor Sie dem Rest vertrauen, denn eine Shell mit der falschen COLLIE_INSTANCE liest die falsche Lane. --json liefert dieselben zwei Werte wie instance und stateDir beim Eintrag collie.

collie doctor listet Ihre Agentenprogramme auf. Jedes Programm, für das Collie ein Eingabeprofil hat, erhält eine harness-<name>-Zeile: die Datei, die Collie auf der PATH Ihrer Login-Shell ausführen würde, die von ihr ausgegebene Version und das Urteil des Profils zu dieser Version. Eine Version über dem verifizierten Bereich ist nur ein Hinweis, da Eingaben in einem Zug weiterhin als vertrauenswürdig gelten. Die Zeile warnt, wenn sich die Datei auflösen lässt, ihre Version jedoch nicht lesbar ist, beispielsweise ein Wrapper an erster Stelle in PATH, der $HOME benötigt, oder eine defekte Installation: Bis die Version lesbar ist, behandelt Collie jede Eingabe an dieses Programm als vorläufig. Ein nicht installiertes Programm zeigt not installed. In --json enthält jede Zeile außerdem harness, binary, version und profileStatus.

Die Zeile nennt die Kopie auf Ihrem PATH, da collie doctor keinen Bereich zum Auslesen hat. Eine Eingabe auf Herdr fragt das Programm ab, das in seinem Bereich läuft; ein Bereich, der eine andere Kopie ausführt, gestartet über ihren vollständigen Pfad oder in einem Projekt installiert, zeigt daher die Version dieser Kopie auf seinen Quittungen.

collie zu Ihrem PATH hinzufügen

Führen Sie collie link aus, um ~/.local/bin/collie zu veröffentlichen:

bin/collie link          # ~/.local/bin/collie → <checkout>/bin/collie
collie status            # from anywhere
bin/collie unlink        # take the name back down

Es erstellt einen Symlink zur Binärdatei des Checkouts, sodass künftige collie build-Aktualisierungen ohne zusätzliche Schritte sofort wirksam werden (ADR 0021). Der Befehl ersetzt bestehende Verknüpfungen aus anderen Collie-Checkouts und gibt aus, welche überschrieben wurde. Er verweigert das Überschreiben von Nicht-Collie-Dateien unter diesem Pfad. unlink entfernt den Symlink nur, wenn er auf Ihren aktuellen Checkout verweist.

Wenn ~/.local/bin in Ihrem PATH fehlt, gibt link eine Warnung aus und beendet die Ausführung. Ihr Shell-Profil wird nie bearbeitet. Führen Sie collie doctor aus, um die path-link-Zeile zu prüfen und zu sehen, zu welchem Checkout der einfache collie-Befehl auflöst.

Herdr-Aktionen

Gilt nur für eine über Herdr verwaltete Installation mit herdr plugin install AltanS/collie oder herdr plugin link erstellt. Herdr ist einer von fünf Multiplexern, die Collie unterstützt. Diese Aktionen bilden direkt auf den Adapter ab: Jede Aktion leitet das Verb an dieselbe in der obigen Tabelle dokumentierte collie-Binärdatei weiter. Bei Binärinstallationen über scripts/install.sh existieren keine Plugin-Aktionen, und collie <verb> ist die einzige Syntax.

Collie registriert diese Aktionen in herdr-plugin.toml. Rufen Sie sie mit herdr plugin action invoke <id> --plugin herdr.collie auf oder zeigen Sie sie mit herdr plugin action list --plugin herdr.collie an:

<id>Entsprechendes VerbFunktion
startcollie startBei Bedarf bauen, Dienst starten, tailscale serve, URL + Banner ausgeben
stopcollie stopBridge anhalten; entfernt nichts
restartcollie restartstop + start
statuscollie statusDas Collie läuft-Banner: Bereitschaft ✓/⚠, Version, URLs
urlcollie urlTailnet-URL ausgeben
versioncollie versionLaufende Version ausgeben (0.x.y+sha)
updatecollie updateCheckout aktualisieren (Pull oder Fetch + Re-Detach) + neu bauen + neu starten
uninstallcollie uninstallDienst beenden (behält .env + Checkout)
push-keyscollie push-keysEin VAPID-Schlüsselpaar in die vom Dienst gelesene .env schreiben
push-testcollie push-testEine Benachrichtigung an jedes abonnierte Gerät senden

qr, pair, devices, link, logs, stt und config haben keine entsprechende Plugin-Aktion, da sie ein Terminal, Positionsargumente oder beides erfordern. Führen Sie sie als collie <verb> aus.

Herdr-Aktionen geben Herdr-JSON-Envelope anstelle des Terminal-Banners zurück. Zeigen Sie die erfasste Standardausgabe der Aktion mit herdr plugin log list --plugin herdr.collie an oder führen Sie collie <verb> direkt aus, um die Ausgabe inline auszugeben. Die Ausgabe von herdr plugin list --json spiegelt die während plugin link zwischengespeicherte Version wider, nicht die aktive Version. Bei verknüpften Klonen verknüpft update automatisch neu, um den Cache zu korrigieren. Sie können dies mit herdr plugin link "$(pwd)" erzwingen. Herdr ≥0.8.0 liest das Manifest bei jedem Aufruf neu von der Festplatte.

Hinweis. scripts/collie-ctl.sh <verb> wird weiterhin unterstützt. Es fungiert als Bootstrap-Shim: Es sucht Bun, kompiliert bin/collie, falls dies im Checkout fehlt, und leitet argv weiter. Ein frisch verknüpfter Klon verwendet diesen Pfad, um seine initiale Binärdatei zu erstellen. Herdr-Aktionen verweisen weiterhin auf dieses Skript, da Herdr <0.8.0 die bei der Installation zwischengespeicherten Aktionsdefinitionen einfriert (ADR 0006). Jedes Verb ist einmal innerhalb der kompilierten Binärdatei in cli/ implementiert.

Diese Seite auf GitHub bearbeiten

The rest of the documentation