Vue d'ensemble du CLI

Le CLI Almirant (almirant) est un outil unique pour deux types d'utilisateurs :

• Équipes SaaS qui souhaitent connecter leur dépôt local à un projet Almirant et utiliser des agents IA depuis leur IDE.
• Utilisateurs self-hosted qui souhaitent installer, mettre à jour et exploiter leur propre instance Almirant avec Docker.

Les deux flux partagent le même binaire et le même fichier de configuration. Seul l'ensemble de commandes utilisé change.

Ce que vous pouvez faire

Tâche	Commande	Guide
Vous authentifier auprès d'un backend Almirant	almirant login	Connecter un dépôt
Connecter le répertoire actuel à un projet	almirant init / almirant link	Connecter un dépôt
Installer une instance self-hosted	almirant install	Installation self-hosted
Consulter l'état de la stack locale	almirant ps	Exploiter la stack
Lire les logs de la stack locale	almirant logs	Exploiter la stack
Arrêter la stack locale	almirant down	Exploiter la stack
Mettre à jour la stack	almirant upgrade	Exploiter la stack
Gérer les comptes (SaaS, self-hosted)	almirant accounts / almirant use	Plusieurs comptes

Installer le CLI

Le CLI est distribué sous forme de paquet npm (exécutable autonome écrit en Go) :

bun add -g almirant@latest
# o
npm i -g almirant

Vérifiez l'installation :

almirant version

astuce

Si vous souhaitez seulement connecter un dépôt à un projet SaaS, le guide le plus court est Connecter un dépôt. Vous n'avez besoin de rien d'autre.

Modèle mental

Pour comprendre la sortie de chaque commande, retenez ces trois concepts :

1. Comptes (~/.almirant/config.json)

Le CLI conserve un ou plusieurs comptes. Chaque compte est un tuple :

• apiBaseUrl — emplacement du backend (par exemple https://api.almirant.ai pour le SaaS ou https://miempresa.com/api pour le self-hosted).
• appBaseUrl — emplacement du frontend.
• id — identifiant stable du compte, utilisé par les configurations générées.
• label — alias local lisible (local-m1pro, prod-saas, kroko-dev).
• apiKey — token que le CLI utilise pour s'authentifier auprès du backend.

Les commandes telles que init, link ou config fonctionnent avec un compte actif. Vous pouvez alterner entre plusieurs comptes avec almirant use <label> ou le sélecteur interactif de almirant use.

2. Stack self-hosted (~/.almirant/stack/)

Si vous installez Almirant sur votre serveur, le CLI clone le code source dans ~/.almirant/stack/ et démarre les conteneurs avec Docker Compose. Toutes les commandes ps, logs, down, upgrade utilisent ce répertoire par défaut (modifiable avec --dir).

La stack locale et les comptes sont indépendants : vous pouvez exécuter une stack self-hosted tout en ayant des comptes configurés vers le SaaS, sans conflit.

3. Projet lié (.mcp.json + .agents/)

Lorsque vous exécutez almirant init ou almirant link à la racine d'un dépôt, le CLI écrit deux éléments dans ce dépôt :

• .mcp.json — configuration MCP sans secrets. Elle ne contient aucun token : elle exécute almirant mcp proxy, qui lit le compte depuis ~/.almirant/config.json et attache le bearer token en mémoire.
• .agents/ et .claude/skills/ — modèles de skills permettant aux agents de savoir comment interagir avec Almirant.

Rien de tout cela ne modifie la base de données Almirant : ce ne sont que des métadonnées locales au dépôt.

Où aller maintenant

• Si votre équipe possède déjà un compte Almirant (SaaS ou instance déployée) et que vous souhaitez seulement connecter votre dépôt : Connecter un dépôt.
• Si vous souhaitez démarrer Almirant sur votre propre serveur à partir de zéro : Installation self-hosted.
• Si votre stack est déjà en cours d'exécution et que vous voulez savoir comment l'exploiter au quotidien : Exploiter la stack.
• Si vous recherchez une commande précise : Référence des commandes.