Référence des commandes

Liste exhaustive des commandes du CLI. Pour afficher l'aide intégrée à tout moment :

almirant --help
almirant <commande> --help

`almirant install`

Installe une instance self-hosted d'Almirant sur la machine actuelle.

Clone le dépôt source dans --dir (par défaut ~/.almirant/stack) et exécute le script scripts/install.sh, qui construit les images Docker, génère .env.production avec des secrets aléatoires et démarre la stack.

almirant install [flags]

Flag	Valeur par défaut	Description
`--branch`	`main`	Branche ou tag git à installer
`--dir`	`~/.almirant/stack`	Répertoire dans lequel cloner la stack
`--from-dir`	—	Utilise un clone local existant (installation air-gapped, le CLI ne touche pas à git)
`--non-interactive`	`false`	Ignore les invites de l'installateur (utilise les valeurs par défaut)
`--public-url`	—	URL publique où Almirant sera servi (sans slash final)
`--repo`	`almirant-ai/almirant`	Dépôt GitHub à cloner
`--with-discord`	`false`	Active le profile Discord bridge
`--with-proxy`	`false`	Active le profile reverse proxy (Caddy)

Comportement

Si --dir contient déjà un clone, le CLI effectue git fetch + fast-forward pull sur --branch au lieu de cloner à nouveau.
L'installateur génère .env.production uniquement la première fois. Si le fichier existe déjà, il le conserve tel quel (vos secrets sont conservés).
--public-url est écrit simultanément dans NEXT_PUBLIC_SITE_URL, BETTER_AUTH_URL, BETTER_AUTH_TRUSTED_ORIGINS et CORS_ORIGIN. Modifier cette URL ultérieurement nécessite de reconstruire le frontend (voir Exploiter la stack).

Exemples

# 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

remarque

L'installateur doit s'exécuter sur la machine cible. Il n'existe pas de mode SSH distant pour install ; utilisez almirant upgrade --host <ssh> pour une stack déjà installée.

`almirant login`

Ouvre le navigateur pour effectuer un flux OAuth auprès du backend Almirant, récupère la clé API générée et enregistre un compte dans ~/.almirant/config.json.

almirant login [flags]

Flag	Valeur par défaut	Description
`--api-url`	invite	URL de base de l'API (remplace `ALMIRANT_API_URL` et l'invite)
`--app-url`	dérivée de `--api-url`	URL de base du frontend
`--name`	`Almirant CLI`	Libellé sous lequel la clé API est enregistrée dans le backend

Chaque connexion crée ou met à jour un compte local avec un ID stable et un label lisible. Vous pouvez répéter l'opération pour le SaaS, le staging et plusieurs instances self-hosted.

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

astuce

Les clés API sont stockées dans ~/.almirant/config.json avec les permissions 600. Les fichiers de projet générés par init et link ne contiennent aucun bearer token.

`almirant init`

Flux complet de première utilisation dans un dépôt. Il détecte le type de projet, permet de choisir ou créer un compte, sélectionne ou crée un projet, puis écrit :

.mcp.json — configuration MCP sans secrets qui exécute almirant mcp proxy.
.claude/skills/ et .agents/skills/ — modèles de skills.

almirant init [flags]

Flag	Valeur par défaut	Description
`--api-url`	—	URL de l'API (uniquement lors de l'ajout d'un nouveau compte)
`--app-url`	—	URL du frontend (uniquement lors de l'ajout d'un nouveau compte)
`--name`	`Almirant CLI`	Libellé de la clé API (nouveau compte uniquement)

Comportement

Si vous avez déjà des comptes enregistrés, init vous permet d'en choisir un.
Si vous n'avez aucun compte, il lance le flux OAuth, comme almirant login.
Si .mcp.json existe déjà, il fusionne l'entrée almirant sans modifier les autres serveurs MCP.
L'entrée générée utilise type: "stdio", command: "almirant" et args: ["mcp", "proxy", ...].

`almirant link`

Identique à init, mais sans flux OAuth. Vous devez avoir authentifié au moins un compte avec almirant login.

almirant link

N'accepte aucun flag autre que --help. Il choisit un compte et un projet parmi ceux déjà enregistrés et écrit .mcp.json + les skills dans le répertoire actuel.

Quand utiliser chacun

init — première utilisation sur une nouvelle machine, ou si vous voulez que le CLI vous guide, connexion comprise.
link — vous vous êtes déjà authentifié et souhaitez seulement connecter un dépôt supplémentaire à un projet existant.

`almirant accounts`

Gère les comptes depuis le raccourci principal. Les mêmes sous-commandes existent également sous almirant config accounts ... pour des raisons de compatibilité.

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

Sous-commande	Description
`list`	Liste le marqueur, l'index, le label, l'e-mail, l'URL API et l'état de la clé API
`add`	Alias de `almirant login`
`rename <ref> <label>`	Modifie le label lisible d'un compte
`remove <ref>`	Supprime un compte local (`--yes` ignore la confirmation)
`set-default <ref>`	Définit le compte actif par défaut

<ref> peut être un label, un ID stable, un e-mail unique ou un index commençant à 1.

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

Sélectionne le compte actif. Sans argument, ouvre un sélecteur interactif.

almirant use local-m1pro
almirant current

almirant current affiche le label, l'ID, l'e-mail, l'URL API et le préfixe de la clé sans exposer le token complet.

`almirant mcp proxy`

Exécute le proxy stdio utilisé par les agents MCP.

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

Le proxy lit le compte depuis ~/.almirant/config.json, transmet le trafic à <apiBaseUrl>/mcp?projectId=<id> et attache le bearer token uniquement en mémoire. N'écrivez pas de tokens dans .mcp.json, .codex/config.toml ou des fichiers shell.

`almirant ps`

Wrapper de docker compose ps utilisant le fichier compose de production.

almirant ps [flags]

Flag	Valeur par défaut	Description
`--dir`	`~/.almirant/stack`	Répertoire de la stack

`almirant logs`

Wrapper de docker compose logs pour la stack de production.

almirant logs [service...] [flags]

Arguments positionnels — noms des services auxquels limiter la sortie (par exemple backend, frontend, db-init).

Flag	Valeur par défaut	Description
`--dir`	`~/.almirant/stack`	Répertoire de la stack
`-f, --follow`	`false`	Suivre la sortie en temps réel (`tail -f`)
`--tail`	`0` (toutes)	N'afficher que les N dernières lignes par service

Exemples

# 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`

Exécute docker compose down sur la stack de production. Les volumes de données sont conservés par défaut.

almirant down [flags]

Flag	Valeur par défaut	Description
`--dir`	`~/.almirant/stack`	Répertoire de la stack
`--rmi`	—	Supprime également les images. Valeurs : `local` ou `all`
`--volumes`	`false`	Destructif : supprime aussi les volumes (vous perdez toutes les données)

attention

--volumes est irréversible. Utilisez-le uniquement si vous souhaitez repartir de zéro. Pour un test propre après une installation échouée, vous voudrez généralement exécuter : almirant down --volumes.

`almirant upgrade`

Met à jour la stack vers la version la plus récente de la branche indiquée.

Mode local (sans --host) : exécute git fetch + pull dans --dir, reconstruit les images et redémarre les conteneurs.

Mode distant (avec --host) : exécute scripts/update-remote.sh sur la machine via SSH.

almirant upgrade [service...] [flags]

Arguments positionnels — noms des services auxquels limiter la reconstruction (par exemple frontend backend). Si vous les omettez, tout est reconstruit.

Flag	Valeur par défaut	Description
`--branch`	`main`	Branche à récupérer
`--dir`	`~/.almirant/stack`	Répertoire de la stack (mode local)
`--host`	—	Hôte SSH pour la mise à jour distante
`--local-repo`	—	Chemin vers un clone local pour éviter de télécharger le script (mode distant)
`--repo`	`almirant-ai/almirant`	Dépôt contenant le script de mise à jour (mode distant)

Exemples

# 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`

Gère la configuration du CLI enregistrée dans ~/.almirant/config.json. Au quotidien, préférez les raccourcis almirant accounts, almirant use et almirant current ; config conserve l'arborescence complète et les sous-commandes avancées.

almirant config [commande]

`almirant config show`

Affiche tous les comptes configurés sans exposer de secrets. La clé API est affichée uniquement par son préfixe (par exemple alm_k1_…). La clé complète n'est jamais affichée.

`almirant config accounts`

Alias complet du gestionnaire de comptes. Également disponible sous almirant accounts ....

Sous-commande	Description
`list`	Liste tous les comptes configurés
`add`	Alias de `almirant login` — ajoute un nouveau compte
`rename <ref> <label>`	Renomme le label lisible d'un compte
`remove <ref>`	Supprime un compte de la configuration locale
`set-default <ref>`	Définit le compte actif par défaut

`almirant config set`

Sous-commande	Description
`api-url <url> [--account <ref>]`	Modifie l'URL API d'un compte (utile si le backend a été déplacé)

`almirant config rotate`

Sous-commande	Description
`api-key [--account <ref>]`	Génère une nouvelle clé API pour le compte sélectionné et remplace l'ancienne. L'ancienne clé est invalidée sur le serveur.

`almirant config reset`

Supprime tous les comptes et laisse la configuration vide.

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

`almirant version`

Affiche la version du CLI et les métadonnées de build.

almirant version

Utile pour signaler des issues et décider s'il est pertinent de mettre à jour avec bun add -g almirant@latest.

Variables d'environnement

Plusieurs commandes respectent des variables d'environnement équivalentes à leurs flags. Elles sont listées ici car utiles en CI et dans les scripts.

Variable	Commande concernée	Équivalent du 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​

Variables d'environnement​

`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`

Variables d'environnement