Befehlsreferenz

Vollständige Liste der CLI-Befehle. Um jederzeit die Inline-Hilfe anzuzeigen:

almirant --help
almirant <comando> --help

`almirant install`

Installiert eine Self-Hosted-Instanz von Almirant auf dem aktuellen Rechner.

Kloniert das Quell-Repository nach --dir (standardmäßig ~/.almirant/stack) und führt das Skript scripts/install.sh aus. Dieses baut die Docker-Images, erzeugt .env.production mit zufälligen Geheimnissen und startet den Stack.

almirant install [flags]

Flag	Standard	Beschreibung
`--branch`	`main`	Zu installierender Git-Branch oder Tag
`--dir`	`~/.almirant/stack`	Verzeichnis, in das der Stack geklont wird
`--from-dir`	—	Verwendet einen bestehenden lokalen Klon (Air-Gap-Installation; das CLI verwendet Git nicht)
`--non-interactive`	`false`	Uberspringt die Aufforderungen des Installers (verwendet Standardwerte)
`--public-url`	—	Öffentliche URL, unter der Almirant bereitgestellt wird (ohne abschließenden Slash)
`--repo`	`almirant-ai/almirant`	Zu klonendes GitHub-Repository
`--with-discord`	`false`	Aktiviert das Discord-Bridge-Profil
`--with-proxy`	`false`	Aktiviert das Reverse-Proxy-Profil (Caddy)

Verhalten

Wenn --dir bereits einen früheren Klon enthält, führt das CLI einen git fetch und einen Fast-Forward-Pull von --branch aus, statt erneut zu klonen.
Der Installer erzeugt .env.production nur beim ersten Mal. Falls die Datei bereits vorhanden ist, bleibt sie unverandert (deine Geheimnisse bleiben erhalten).
--public-url wird gleichzeitig in NEXT_PUBLIC_SITE_URL, BETTER_AUTH_URL, BETTER_AUTH_TRUSTED_ORIGINS und CORS_ORIGIN geschrieben. Um diese URL später zu ändern, muss das Frontend neu gebaut werden (siehe Den Stack betreiben).

Beispiele

# Instalacion interactiva, te pregunta la URL publica
almirant install

# Instalacion sin prompts, con URL fijada
almirant install --non-interactive --public-url https://almirant.example.com

# Instalacion desde un tag concreto
almirant install --branch v1.2.3

# Instalacion air-gapped desde un clone existente
almirant install --from-dir /opt/almirant-release --non-interactive

Hinweis

Der Installer muss auf dem Zielrechner laufen. install bietet keinen SSH-Remote-Modus. Verwende stattdessen almirant upgrade --host <ssh> für einen bereits installierten Stack.

`almirant login`

Öffnet den Browser, um einen OAuth-Ablauf mit dem Almirant-Backend abzuschließen, erfasst den erzeugten API-Schlüssel und speichert ein Konto in ~/.almirant/config.json.

almirant login [flags]

Flag	Standard	Beschreibung
`--api-url`	Aufforderung	Basis-URL der API (uberschreibt `ALMIRANT_API_URL` und die Aufforderung)
`--app-url`	von `--api-url` abgeleitet	Basis-URL des Frontends
`--name`	`Almirant CLI`	Bezeichnung, unter der der API-Schlüssel im Backend gespeichert wird

Jede Anmeldung erstellt oder aktualisiert ein lokales Konto mit stabiler ID und lesbarer Bezeichnung. Du kannst dies für SaaS, Staging und mehrere Self-Hosted-Instanzen wiederholen.

almirant login
almirant login --api-url https://almirant.miempresa.com/api
almirant accounts list

Tipp

Die API-Schlüssel befinden sich in ~/.almirant/config.json mit den Berechtigungen 600. Von init und link erzeugte Projektdateien enthalten keine Bearer-Tokens.

`almirant init`

Vollständiger Ersteinrichtungsablauf in einem Repository. Er erkennt den Projekttyp, lässt dich ein Konto auswählen oder erstellen, wählt ein Projekt aus oder erstellt eines und schreibt:

.mcp.json — tokenlose MCP-Konfiguration, die almirant mcp proxy ausführt.
.claude/skills/ und .agents/skills/ — Skill-Vorlagen.

almirant init [flags]

Flag	Standard	Beschreibung
`--api-url`	—	API-URL (nur beim Hinzufügen eines neuen Kontos)
`--app-url`	—	Frontend-URL (nur beim Hinzufügen eines neuen Kontos)
`--name`	`Almirant CLI`	Bezeichnung des API-Schlüssels (nur neues Konto)

Verhalten

Wenn du bereits gespeicherte Konten hast, lasst dich init eines auswahlen.
Wenn du kein Konto hast, startet es denselben OAuth-Ablauf wie almirant login.
Falls .mcp.json bereits existiert, führt es den Eintrag almirant zusammen, ohne andere MCP-Server zu verändern.
Der erzeugte Eintrag verwendet type: "stdio", command: "almirant" und args: ["mcp", "proxy", ...].

`almirant link`

Wie init, jedoch ohne OAuth-Ablauf. Erfordert, dass du zuvor mindestens ein Konto mit almirant login authentifiziert hast.

almirant link

Es akzeptiert auBer --help keine Flags. Es wahlt aus deinen bereits gespeicherten Konten und Projekten aus und schreibt .mcp.json sowie Skills in das aktuelle Verzeichnis.

Wann welchen Befehl verwenden

init — zum ersten Mal auf einem neuen Rechner oder wenn das CLI dich einschließlich der Anmeldung durch jeden Schritt führen soll.
link — du hast dich bereits authentifiziert und mochtest nur ein weiteres Repository mit einem bestehenden Projekt verbinden.

`almirant accounts`

Verwaltet Konten über die Hauptverknüpfung. Dieselben Unterbefehle sind aus Kompatibilitätsgründen auch unter almirant config accounts ... verfügbar.

almirant accounts list
almirant accounts rename <ref> <label>
almirant accounts add
almirant accounts remove <ref>
almirant accounts set-default <ref>

Unterbefehl	Beschreibung
`list`	Listet Markierung, Index, Bezeichnung, E-Mail, API-URL und Status des API-Schlüssels auf
`add`	Alias für `almirant login`
`rename <ref> <label>`	Andert die lesbare Bezeichnung eines Kontos
`remove <ref>`	Entfernt ein lokales Konto (`--yes` uberspringt die Bestatigung)
`set-default <ref>`	Legt das standardmaBig aktive Konto fest

<ref> kann eine Bezeichnung, stabile ID, eindeutige E-Mail-Adresse oder ein bei 1 beginnender Index sein.

`almirant use [label|id|email|index]`

Wahlt das aktive Konto aus. Ohne Argument offnet sich eine interaktive Auswahl.

almirant use local-m1pro
almirant current

almirant current gibt Bezeichnung, ID, E-Mail, API-URL und Schlüsselpräfix aus, ohne das vollständige Token offenzulegen.

`almirant mcp proxy`

Führt den von MCP-Agenten verwendeten stdio-Proxy aus.

almirant mcp proxy --project-id <id> [--account <label|id|email|index>]

Der Proxy liest das Konto aus ~/.almirant/config.json, leitet den Datenverkehr an <apiBaseUrl>/mcp?projectId=<id> weiter und hangt das Bearer-Token nur im Speicher an. Schreibe keine Tokens in .mcp.json, .codex/config.toml oder Shell-Dateien.

`almirant ps`

Wrapper um docker compose ps für die Produktions-Compose-Datei.

almirant ps [flags]

Flag	Standard	Beschreibung
`--dir`	`~/.almirant/stack`	Stack-Verzeichnis

`almirant logs`

Wrapper um docker compose logs für den Produktions-Stack.

almirant logs [service...] [flags]

Positionsargumente — Namen der Services, auf die die Ausgabe beschränkt wird (z. B. backend, frontend, db-init).

Flag	Standard	Beschreibung
`--dir`	`~/.almirant/stack`	Stack-Verzeichnis
`-f, --follow`	`false`	Ausgabe in Echtzeit verfolgen (`tail -f`)
`--tail`	`0` (alle)	Nur die letzten N Zeilen pro Service anzeigen

Beispiele

# Todos los servicios, las ultimas 100 lineas
almirant logs --tail 100

# Solo backend y frontend, en tiempo real
almirant logs -f backend frontend

`almirant down`

Führt docker compose down für den Produktions-Stack aus. Die Datenvolumes bleiben standardmäßig erhalten.

almirant down [flags]

Flag	Standard	Beschreibung
`--dir`	`~/.almirant/stack`	Stack-Verzeichnis
`--rmi`	—	Entfernt auch Images. Werte: `local` oder `all`
`--volumes`	`false`	Destruktiv: entfernt auch die Volumes (alle Daten gehen verloren)

Warnung

--volumes ist irreversibel. Verwende es nur, wenn du von vorn beginnen möchtest. Für einen sauberen Test nach einer fehlgeschlagenen Installation brauchst du normalerweise: almirant down --volumes.

`almirant upgrade`

Aktualisiert den Stack auf die neueste Version des angegebenen Branches.

Lokaler Modus (ohne --host): Führt in --dir einen git fetch und Pull aus, baut die Images neu und startet die Container neu.

Remote-Modus (mit --host): Führt scripts/update-remote.sh per SSH auf dem Rechner aus.

almirant upgrade [service...] [flags]

Positionsargumente — Namen der Services, auf die der Neubau beschränkt wird (z. B. frontend backend). Falls du sie auslässt, wird alles neu gebaut.

Flag	Standard	Beschreibung
`--branch`	`main`	Abzurufender Branch
`--dir`	`~/.almirant/stack`	Stack-Verzeichnis (lokaler Modus)
`--host`	—	SSH-Host für ein Remote-Upgrade
`--local-repo`	—	Pfad zu einem lokalen Klon, um den Download des Skripts zu vermeiden (Remote-Modus)
`--repo`	`almirant-ai/almirant`	Repository des Upgrade-Skripts (Remote-Modus)

Beispiele

# Upgrade completo del stack local
almirant upgrade

# Solo reconstruir el frontend (mas rapido si solo cambiaste UI)
almirant upgrade frontend

# Upgrade de un servidor remoto via SSH
almirant upgrade --host [email protected]

`almirant config`

Verwaltet die in ~/.almirant/config.json gespeicherte CLI-Konfiguration. Für den Alltag sind die Verknüpfungen almirant accounts, almirant use und almirant current vorzuziehen; config behält den vollständigen Baum und erweiterte Unterbefehle.

almirant config [comando]

`almirant config show`

Gibt alle konfigurierten Konten ohne Geheimnisse offenzulegen aus. Der API-Schlüssel wird nur mit seinem Präfix angezeigt (z. B. alm_k1_…). Der vollständige Schlüssel wird nie ausgegeben.

`almirant config accounts`

Vollständiger Alias des Kontenmanagers. Auch als almirant accounts ... verfügbar.

Unterbefehl	Beschreibung
`list`	Listet alle konfigurierten Konten auf
`add`	Alias für `almirant login` — fügt ein neues Konto hinzu
`rename <ref> <label>`	Andert die lesbare Bezeichnung eines Kontos
`remove <ref>`	Entfernt ein Konto aus der lokalen Konfiguration
`set-default <ref>`	Legt fest, welches Konto standardmaBig aktiv ist

`almirant config set`

Unterbefehl	Beschreibung
`api-url <url> [--account <ref>]`	Andert die API-URL eines Kontos (nutzlich, wenn das Backend umgezogen ist)

`almirant config rotate`

Unterbefehl	Beschreibung
`api-key [--account <ref>]`	Erzeugt einen neuen API-Schlüssel für das ausgewählte Konto und ersetzt den bisherigen. Der vorherige Schlüssel wird auf dem Server ungültig.

`almirant config reset`

Loscht alle Konten und hinterlasst eine leere Konfiguration.

almirant config reset       # te pide confirmacion
almirant config reset -y    # sin prompt, para scripts

`almirant version`

Gibt die Version des CLI und die Build-Metadaten aus.

almirant version

Nutzlich, um Issues zu melden und zu entscheiden, ob sich ein Update mit bun add -g almirant@latest lohnt.

Umgebungsvariablen

Mehrere Befehle berucksichtigen Umgebungsvariablen, die ihren Flags entsprechen. Sie sind hier aufgefuhrt, weil sie in CI und Skripten nutzlich sind.

Variable	Betroffener Befehl	Entsprechendes Flag
`ALMIRANT_API_URL`	`login`, `init`	`--api-url`
`ALMIRANT_APP_URL`	`login`, `init`	`--app-url`
`ALMIRANT_NONINTERACTIVE`	`install` (via `scripts/install.sh`)	`--non-interactive`
`ALMIRANT_PUBLIC_URL`	`install` (via `scripts/install.sh`)	`--public-url`
`ALMIRANT_WITH_PROXY`	`install`	`--with-proxy`
`ALMIRANT_WITH_DISCORD`	`install`	`--with-discord`

almirant install​

almirant login​

almirant init​

almirant link​

almirant accounts​

almirant use [label|id|email|index]​

almirant mcp proxy​

almirant ps​

almirant logs​

almirant down​

almirant upgrade​

almirant config​

almirant config show​

almirant config accounts​

almirant config set​

almirant config rotate​

almirant config reset​

almirant version​

Umgebungsvariablen​

`almirant install`

`almirant login`

`almirant init`

`almirant link`

`almirant accounts`

`almirant use [label|id|email|index]`

`almirant mcp proxy`

`almirant ps`

`almirant logs`

`almirant down`

`almirant upgrade`

`almirant config`

`almirant config show`

`almirant config accounts`

`almirant config set`

`almirant config rotate`

`almirant config reset`

`almirant version`

Umgebungsvariablen