Aller à la documentation
CLI

Installation

npm, pnpm, Bun ou Yarn, ou aucune installation avec npx.

Installation

La version actuelle est 0.0.1. Elle nécessite Node.js 20.12 ou plus récent.

npm install -g @openemail/cli

Le paquet est un seul fichier empaqueté sans dépendances, et il ajoute une commande à votre PATH : openemail. Le SDK avec lequel il appelle l'API est intégré, donc la CLI tourne toujours avec le SDK avec lequel elle a été testée. openemail version affiche la version des deux, et celle de l'environnement d'exécution.

Vérifier
openemail --versionopenemail --help

La lancer sans installation

npx récupère le paquet dans un cache et le lance, ce qui convient à une commande ponctuelle, à un job de CI ou à un client MCP qui démarre le pont local.

Terminal
npx @openemail/cli --helpnpx -y @openemail/[email protected] whoaminpx -y @openemail/cli mcp serve

Fixez la version en CI, comme dans npx -y @openemail/[email protected], pour qu'une nouvelle version ne change jamais un pipeline à votre insu.

Mises à jour

La CLI ne se met jamais à jour d'elle-même. Elle retient pendant un jour ce que le registre npm a dit de la dernière version. Quand c'est plus ancien, elle redemande en arrière-plan pendant que votre commande s'exécute, et une fois la commande terminée elle attend la réponse un cinquième de seconde au plus. Quand une version plus récente existe, elle affiche un avis sur stderr une fois votre commande terminée :

Avis de mise à jour
Update available! 0.0.1 → 0.0.2Changelog: https://openemail.uk/docs/cli/changelogRun `npm i -g @openemail/cli@latest` to update. Disable this notice with OPENEMAIL_NO_UPDATE_CHECK=1
  • La commande d'installation de l'avis correspond au gestionnaire de paquets avec lequel vous avez installé.
  • Il n'y a pas d'avis avec --help, --version ou --json, pour help, version, update ou completion, quand stdout ou stderr n'est pas un terminal, ni en CI.
  • Définissez OPENEMAIL_NO_UPDATE_CHECK=1 pour le désactiver partout. OPENEMAIL_DISABLE_UPDATE_NOTICE=1 fait de même.
  • La seule requête part vers le registre npm, et sa réponse est conservée un jour dans ~/.openemail/update-check.json.

openemail update vérifie tout de suite, sans le cache quotidien, et affiche soit la commande à lancer, soit que vous avez la dernière version.

npm i -g @openemail/cli@latest

Complétion du shell

openemail completion <shell> affiche un script de complétion pour bash, zsh ou fish, construit à partir de chaque commande, sous-commande et option de votre version. Relancez-le après une mise à jour.

echo 'eval "$(openemail completion bash)"' >> ~/.bashrc

Désinstaller

Déconnectez-vous d'abord, pour que chaque connexion par navigateur soit révoquée sur le serveur, puis supprimez le paquet et le dossier où la CLI garde ses connexions.

Terminal
openemail logout --allnpm uninstall -g @openemail/clirm -rf ~/.openemail

Votre boîte de réception,
à vos conditions.

L’infrastructure e-mail pour les entreprises, l’IA, les agents et le courrier personnel. Conçue pour l’échelle, la confidentialité et le contrôle. Tout ce que l’e-mail aurait dû avoir dès le premier jour.

OpenEmail

L’infrastructure e-mail pour les entreprises, l’IA, les agents et le courrier personnel. Conçue pour l’échelle, la confidentialité et le contrôle. Tout ce que l’e-mail aurait dû avoir dès le premier jour.

© 2026 OpenEmail. Tous droits réservés.