Guide

Premiers pas avec la CLI

Configurez Nylas CLI en moins de 2 minutes. Créez un compte Nylas gratuit, récupérez une clé API depuis le dashboard et exécutez nylas auth config. Aucun flux d'authentification navigateur requis.

Written by Prem Keshari Senior SRE

Reviewed by Caleb Geene

Verified — CLI 3.1.1 · Gmail, Outlook, IMAP · last tested April 11, 2026

Comment installer Nylas CLI ?

Nylas CLI s'installe sous forme d'un seul binaire statique de 12 Mo sans aucune dépendance d'exécution. Choisissez la méthode adaptée à votre plateforme — chaque option détecte automatiquement votre architecture CPU (x86_64 ou arm64), télécharge le build correspondant depuis GitHub et vérifie le téléchargement avec des sommes de contrôle SHA-256. L'installation prend moins de 30 secondes sur la plupart des connexions.

Homebrew (macOS et Linux)

La formule Homebrew ajoute le dépôt nylas/nylas-cli et épingle la dernière version stable. Homebrew gère les mises à jour automatiquement quand vous exécutez brew upgrade.

brew install nylas/nylas-cli/nylas

Script shell (macOS, Linux, WSL)

Le script d'installation fonctionne sur tout système POSIX, y compris WSL. Il écrit le binaire dans ~/.config/nylas/bin et affiche une ligne d'export PATH à ajouter à votre profil shell.

curl -fsSL https://cli.nylas.com/install.sh | bash

PowerShell (Windows)

Le script PowerShell télécharge le binaire Windows et ajoute le répertoire d'installation au PATH de votre profil utilisateur. Il nécessite PowerShell 5.1 ou supérieur, inclus dans Windows 10 et 11.

irm https://cli.nylas.com/install.ps1 | iex

Go

La compilation depuis les sources nécessite Go 1.23 ou supérieur. Le binaire est placé dans votre répertoire $GOPATH/bin.

go install github.com/nylas/cli/cmd/nylas@latest

Après l'installation, vérifiez que le binaire est dans votre PATH en affichant sa version :

nylas --version

Comment configurer Nylas CLI ?

Le moyen le plus rapide est d'utiliser une clé API du Dashboard Nylas. Cinq étapes, moins de 2 minutes, aucun flux d'authentification navigateur requis.

Étape 1 : Créer un compte Nylas

Inscrivez-vous sur dashboard-v3.nylas.com. L'offre gratuite inclut 5 comptes connectés, suffisant pour un usage personnel et les tests. Vous pouvez vous inscrire avec Google, Microsoft ou GitHub SSO.

Étape 2 : Créer une application

Dans le dashboard, allez dans All apps → Create new app. Choisissez un nom et votre région (US ou EU). Chaque application supporte un nombre illimité de comptes e-mail connectés (appelés grants) pour Gmail, Outlook, Exchange, Yahoo, iCloud et IMAP.

Étape 3 : Récupérer votre clé API

Ouvrez votre application dans le dashboard et accédez à la section API Keys. Cliquez sur Create new key. Copiez la clé — elle commence par nyl_ et vous la collerez dans la CLI à l'étape suivante.

Étape 4 : Connecter votre compte e-mail

Toujours dans le dashboard, accédez à la section Grants de votre application et cliquez sur Add Account. Autorisez l'accès à votre fournisseur e-mail (Gmail, Outlook, Exchange, Yahoo, iCloud ou IMAP). Cela crée un grant — la connexion entre votre compte e-mail et votre application Nylas.

Étape 5 : Configurer la CLI

Exécutez nylas auth config et collez votre clé API quand vous y êtes invité. La CLI valide la clé auprès de l'API Nylas, la sauvegarde de manière chiffrée dans ~/.config/nylas/config.yaml et synchronise le grant que vous venez de connecter.

nylas auth config

Si votre application Nylas est dans la région EU, passez --region eu :

nylas auth config --region eu

La CLI confirme la sauvegarde et affiche vos comptes connectés :

Paste your API key:
nyl_••••••••••••••••••••

> API key saved to system keyring
> Set user@gmail.com as default account

C'est tout — listez votre boîte de réception pour vérifier que tout fonctionne :

nylas email list

Comment connecter d'autres comptes e-mail ?

Pour ajouter d'autres comptes après la configuration, ouvrez le Dashboard Nylas, accédez à la section Grants de votre application et cliquez sur Add Account. La CLI détecte les nouveaux grants automatiquement à la prochaine commande.

Vous pouvez aussi connecter des comptes directement depuis la CLI via OAuth :

nylas auth login

Cette commande ouvre votre navigateur pour l'autorisation. Selon la documentation OAuth 2.0 de Google, les access tokens expirent après 3 600 secondes — la CLI les renouvelle automatiquement. Si le flux navigateur reste bloqué après l'autorisation, utilisez la méthode du dashboard.

Gérez vos comptes connectés avec :

# Lister tous les comptes connectés
nylas auth list

# Basculer entre les comptes
nylas auth switch

Comment tout configurer en une seule commande ?

nylas init --api-key configure le CLI en une seule commande non interactive — sans flux d'authentification dans le navigateur ni redirection SSO, contrairement à l'assistant interactif, qui se déroule en quatre étapes. Fournissez votre clé directement et le CLI s'authentifie immédiatement, ce qui en fait la voie à suivre pour les environnements headless : pipelines CI/CD, conteneurs Docker et sessions SSH où aucun navigateur n'est disponible.

nylas init --api-key nyl_abc123

Utilisez --region eu si votre application est dans la région EU :

nylas init --api-key nyl_abc123 --region eu

Comment utiliser l'assistant de configuration interactif ?

L'assistant nylas init est une alternative au flux par clé API ci-dessus. Il vous guide à travers la création de compte, la sélection d'application, la génération de clé API et la synchronisation des grants en une seule session interactive. Il nécessite un navigateur pour l'authentification SSO.

nylas init

Pour passer le menu de sélection du fournisseur SSO, spécifiez le flag directement :

nylas init --google
nylas init --microsoft
nylas init --github

Comment gérer mon compte depuis la CLI ?

La CLI reproduit environ 90 % des fonctionnalités du dashboard web via les sous-commandes nylas dashboard. Vous pouvez créer des applications, renouveler des clés API, changer d'organisation et vérifier votre statut de connexion sans ouvrir de navigateur. Chaque sous-commande supporte la sortie --json pour le scripting.

Les opérations dashboard les plus courantes :

# Vérifier le statut de connexion
nylas dashboard status

# Lister les applications
nylas dashboard apps list

# Créer une nouvelle application
nylas dashboard apps create --name "Production App" --region us

# Définir une application comme active
nylas dashboard apps use app_abc123

# Générer une nouvelle clé API
nylas dashboard apps apikeys create

# Changer d'organisation
nylas dashboard orgs switch

Comment utiliser e-mail, calendrier et contacts ?

La CLI organise ses 72+ commandes en trois groupes principaux : e-mail (envoyer, lister, rechercher, brouillon, pièce jointe), calendrier (événements, disponibilité, planification) et contacts (lister, rechercher, groupes). Chaque groupe supporte la sortie --json pour le scripting et --limit pour contrôler la taille des résultats. Voici les commandes que vous utiliserez le plus après la configuration :

# E-mail : lister, rechercher et envoyer
nylas email list --limit 5
nylas email search "quarterly report"
nylas email send --to colleague@company.com --subject "Quick note" --body "See you at 2pm."

# Calendrier : lister les événements et vérifier la disponibilité
nylas calendar events list --days 7
nylas calendar availability check --start 2026-05-12T09:00:00Z --end 2026-05-12T17:00:00Z --participants colleague@company.com

# Contacts : lister et rechercher
nylas contacts list --limit 10
nylas contacts search --query "Alice"
nylas contacts groups list

Ajoutez --json à n'importe quelle commande pour obtenir une sortie structurée que vous pouvez rediriger vers jq, injecter dans un script ou transmettre à un agent IA. Le guide d'envoi d'e-mail et le guide calendrier traitent chaque groupe en détail.

Comment réinitialiser et repartir de zéro ?

La CLI stocke toute la configuration localement dans ~/.config/nylas/ — en général 3-4 fichiers totalisant moins de 2 Ko. La réinitialisation supprime les identifiants API, les tokens de session Dashboard, les grants authentifiés et le fichier de configuration — mais n'affecte pas vos données Dashboard Nylas ni vos comptes connectés côté serveur. Vos applications, grants et clés API restent intacts dans le cloud.

Pour effacer la configuration locale et relancer la configuration :

nylas config reset
nylas init

Utilisez --force pour passer l'invite de confirmation — utile dans les scripts qui doivent reconfigurer la CLI automatiquement.

Prochaines étapes