CLI-Referenz

Alle Befehle von aictl auf einen Blick, gruppiert nach Aufgabe. Für die meisten Aufgaben brauchst du nur wenige davon.

4 Min. Lesezeit Kapitel 16

Allgemeines#

aictl --help zeigt alle Befehle, aictl <befehl> --help die Details zu einem Befehl. Vertippst du dich, schlägt aictl den passenden Befehl vor.

Befehle, die etwas am System ändern, brauchen Administratorrechte und werden mit sudo ausgeführt. Befehle, die nur anzeigen, funktionieren ohne.

Befehl	Beschreibung
`install`	Installiert die Plattform oder bringt eine bestehende Installation in Ordnung. Beliebig oft wiederholbar.
`update`	Aktualisiert `aictl` und die Plattform auf die neueste Version.
`update enable`	Schaltet automatische Updates ein.
`update disable`	Schaltet automatische Updates aus.
`update status`	Zeigt, ob automatische Updates aktiv sind und wann die nächste Prüfung erfolgt.
`backup`	Erstellt ein vollständiges Backup.
`restore <ordner>`	Stellt ein Backup wieder her.
`uninstall`	Entfernt die Plattform, vorher wird ein Backup erstellt.

Option	Beschreibung
`--license <schlüssel>`	Lizenzschlüssel. Ohne Angabe wird der gespeicherte Schlüssel verwendet oder danach gefragt.
`--base-domain <domain>`	Domain für alle Dienste, zum Beispiel `ki.firma.ch`.
`--internal`	Nur im internen Netz veröffentlichen.
`--tls-mode auto\|provided`	Automatisches Zertifikat oder eigenes Firmenzertifikat.
`--acme-email <e-mail>`	Kontaktadresse für automatische Zertifikate.
`--dns-provider <anbieter>`	DNS-Anbieter für automatische Zertifikate, zum Beispiel `cloudflare`.
`--auth-admin-email <e-mail>`	E-Mail-Adresse des Administrationskontos.
`--brand-name <name>`	Firmenname.
`--brand-logo-url <url>`	Logo als PNG oder JPEG.
`--brand-favicon-url <url>`	Favicon als PNG oder JPEG.
`--node-name <name>`	Name des Hauptservers, Standard `local`.
`--bind-address <adresse>`	Netzwerkadresse für den lokalen Zugriff, Standard `127.0.0.1`.
`--health-wait <dauer>`	Wie lange auf den Start gewartet wird, Standard 10 Minuten.

Option	Beschreibung
`--dry-run`	Nur anzeigen, was sich ändern würde.
`--pull`	Neue Bestandteile auch bei gleicher Version herunterladen.
`--force`	Vollständige Aktualisierung erzwingen.
`--interval <dauer>`	Bei `update enable`: Rhythmus, zum Beispiel `24h`, `3d` oder `2w`. Standard `7d`.

Option	Beschreibung
`--backup-dir <ordner>`	Zielordner für Backups.
`--skip-backup`	Bei `uninstall`: kein Backup erstellen.
`--keep-data`	Bei `uninstall`: Daten behalten, nur Programme entfernen.
`--skip-current-backup`	Bei `restore`: den aktuellen Stand nicht vorher sichern.
`-y`, `--yes`	Rückfragen automatisch bestätigen.

Befehl	Beschreibung
`status`	Prüft alle Dienste, Modelle, die Anmeldung und alle Rechner. Mit `--json` maschinenlesbar.
`doctor`	Sucht nach typischen Problemen und schlägt Lösungen vor.
`logs [erweiterung]`	Zeigt Meldungen einer Erweiterung. Optionen: `-f` (live), `-n <anzahl>`, `--since <dauer>`.
`start`	Startet die Plattform wieder, nachdem sie angehalten wurde.
`stop`	Hält die Plattform an, auch über Neustarts hinweg, bis `start` ausgeführt wird.
`restart`	Startet die Plattform neu.
`apply`	Übernimmt geänderte Einstellungen, zum Beispiel neue Subdomains oder Zugangsdaten.
`serve`	Der Hintergrunddienst der Plattform. Läuft automatisch, muss nicht von Hand gestartet werden.
`version`	Zeigt die Version von `aictl` und der installierten Erweiterungen.

Befehl	Beschreibung
`license info`	Zeigt Plan, Erweiterungen und Laufzeit. Funktioniert ohne Internet.
`license check`	Fragt den aktuellen Stand direkt beim Lizenzserver ab.
`license renew`	Holt neu gekaufte Erweiterungen sofort ab.

Befehl	Beschreibung
`model install <modell>`	Lädt ein Sprachmodell und stellt es bereit. Mit `--node <name>` auf einem bestimmten Rechner.
`model rm <modell>`	Entfernt ein Modell.
`model ls`	Zeigt alle Modelle und auf welchen Rechnern sie laufen.
`node ls`	Zeigt alle Rechner und ihren Zustand.
`node join-command [name]`	Gibt den Befehl aus, mit dem ein weiterer Rechner angehängt wird.
`node token`	Zeigt den Schlüssel zum Anhängen von Rechnern.
`node drain <name>`	Nimmt einen Rechner vorübergehend aus der Verteilung.
`node undrain <name>`	Nimmt ihn wieder auf.
`node rm <name>`	Entfernt einen Rechner dauerhaft.
`join <adresse>`	Auf einem neuen Rechner ausführen, um ihn als Modell-Rechner anzuhängen. Benötigt `--token` und `--name`.

Befehl	Beschreibung
`extension catalog`	Zeigt alle Erweiterungen, die deine Lizenz freischaltet.
`extension install <name>`	Installiert eine Erweiterung. Optionen: `--version`, `--yes`.
`extension ls`	Zeigt installierte Erweiterungen und verfügbare Updates.
`extension update [name]`	Aktualisiert eine oder alle Erweiterungen.
`extension remove <name>`	Entfernt eine Erweiterung, die Daten bleiben erhalten. Mit `--purge` werden auch alle Daten gelöscht.
`extension env <name>`	Zeigt, welche Einstellungen eine Erweiterung erhält (nur Namen, keine Werte).

Befehl	Beschreibung
`secret set <NAME>`	Speichert Zugangsdaten. Ohne Option wird verdeckt danach gefragt. Alternativ `--from-file`, `--stdin` oder `--value`.
`secret ls`	Zeigt die Namen aller gespeicherten Zugangsdaten.
`secret rm <NAME>`	Entfernt Zugangsdaten.

Nach Änderungen übernimmst du sie mit sudo aictl apply.

Befehl	Beschreibung
`proxy hostname`	Wählt interaktiv, welche Bereiche unter welcher Subdomain erreichbar sind. Für Erweiterungen auch direkt mit `--set <erweiterung>/<dienst>=<subdomain>`.
`proxy set-cert`	Hinterlegt ein eigenes Firmenzertifikat. Optionen: `--cert`, `--key`, `--password-file`, `--password-stdin`.
`auth info`	Zeigt die Adresse der Benutzerverwaltung und das Administrationskonto. Mit `--show-password` inklusive Passwort.
`brand show`	Zeigt Firmenname, Logo und Favicon.
`brand edit`	Ändert das Branding. Optionen: `--name`, `--logo-url`, `--favicon-url`, `--clear-logo`, `--clear-favicon`.

Nicht gefunden, was du suchst?

Unser Support hilft dir gerne weiter.