05/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.
| Verb | Befehl | Funktion |
|---|---|---|
| Starten | collie start | Bei Bedarf erstellen, ausliefern, URL ausgeben |
| Stoppen | collie stop | Bridge anhalten; entfernt nichts |
| Neu starten | collie restart | Stoppen, dann starten |
| Status | collie status | Das Banner Collie läuft + URLs |
| URL | collie url | Tailnet-URL ausgeben |
| QR | collie qr | Dieselbe URL als scannbarer Code |
| Version | collie version | Die laufende Version (0.x.y+sha) |
| Aktualisieren | collie update | Das 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ücksetzen | collie update --rollback | Die vorherige Version wiederherstellen (nicht bei einem von Herdr verwalteten Checkout, da dort keine Version bereitgestellt ist) |
| Deinstallieren | collie uninstall | Dienst entfernen; .env und die Installation behalten |
| Koppeln | collie pair | Geben Sie einen 8-stelligen Code und einen QR-Code aus, die 10 Minuten lang gültig sind; scannen Sie den QR-Code, um Einstellungen → Gekoppelte Geräte mit bereits ausgefülltem Code zu öffnen, oder geben Sie den Code manuell ein, um ihn gekoppelt zu erhalten |
| Geräte | collie devices list · collie devices revoke <label> | Gekoppelte Geräte auflisten / widerrufen |
| Verknüpfen | collie link · collie unlink | collie zu Ihrem PATH hinzufügen (unten) |
| Protokolle | collie logs | Journal / Protokolldatei fortlaufend anzeigen |
| Sprache | collie stt setup · stt test · stt status · stt off | Spracheingabe konfigurieren / prüfen / deaktivieren |
| Push-Schlüssel | collie push-keys | Das VAPID-Schlüsselpaar in Ihrer .env generieren |
| Push-Test | collie push-test | Eine Benachrichtigung senden, um die Funktion zu prüfen |
Die CLI enthält außerdem build, serve, unserve, doctor und pack … 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, pack add und pack 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 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 downEs 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 erstellt mit herdr plugin install AltanS/collie oder herdr plugin link. Herdr ist einer von drei Multiplexern, die Collie unterstützt. Diese Aktionen bilden direkt auf den Adapter ab: Jede Aktion leitet das Verb an dieselbe collie-Binärdatei weiter, die in der obigen Tabelle dokumentiert ist. 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 Verb | Funktion |
|---|---|---|
start | collie start | Bei Bedarf bauen, Dienst starten, tailscale serve, URL + Banner ausgeben |
stop | collie stop | Bridge anhalten; entfernt nichts |
restart | collie restart | stop + start |
status | collie status | Das Collie läuft-Banner: Bereitschaft ✓/⚠, Version, URLs |
url | collie url | Tailnet-URL ausgeben |
version | collie version | Laufende Version ausgeben (0.x.y+sha) |
update | collie update | Checkout aktualisieren (Pull oder Fetch + Re-Detach) + neu bauen + neu starten |
uninstall | collie uninstall | Dienst beenden (behält .env + Checkout) |
push-keys | collie push-keys | Ein VAPID-Schlüsselpaar in die vom Dienst gelesene .env schreiben |
push-test | collie push-test | Eine Benachrichtigung an jedes abonnierte Gerät senden |
qr, pair, devices, link, logs und stt 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, kompiliertbin/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 incli/implementiert.
Diese Seite auf GitHub bearbeiten