Guide

Premiers pas avec la CLI

Configurez Nylas CLI en moins de 2 minutes. Exécutez nylas init pour une inscription guidée qui connecte votre e-mail, ou connectez-vous avec une clé API existante via nylas auth config.

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 avec n'importe quelle méthode, vérifiez que le binaire est dans votre PATH en affichant sa version :

nylas --version

Comment configurer Nylas CLI après l'installation ?

Deux parcours de configuration existent après l'installation. Les nouveaux utilisateurs exécutent nylas init, un assistant interactif qui crée un compte Nylas, construit une application, génère une clé API et connecte votre premier compte e-mail en une seule session. Si vous avez déjà une clé API, exécutez nylas auth config pour vous connecter. Ajoutez des boîtes aux lettres avec nylas auth login — l'offre gratuite connecte jusqu'à 5 comptes.

Comment configurer avec nylas init ?

L'assistant nylas init est le parcours le plus rapide pour les nouveaux utilisateurs. Il exécute quatre étapes en une seule session interactive : se connecter à un compte Nylas ou en créer un, sélectionner ou créer une application, générer et activer une clé API, puis synchroniser vos comptes e-mail existants. Le flux prend environ 90 secondes et ouvre une fois le navigateur pour la connexion SSO.

nylas init

L'assistant demande un fournisseur SSO (Google, Microsoft ou GitHub), puis vous guide à travers la création d'application et de clé avant de connecter votre boîte aux lettres. Pour passer le menu de fournisseurs, spécifiez le flag directement :

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

Quand l'assistant se termine, votre compte est authentifié et votre e-mail est connecté. Vérifiez-le en listant votre boîte de réception :

nylas email list

Comment se connecter avec une clé API existante ?

Vous avez déjà une clé API du Dashboard Nylas ? Exécutez nylas auth config et collez-la quand vous y êtes invité pour vous connecter — cela passe l'assistant en 4 étapes. La CLI valide la clé en moins d'une seconde et la sauvegarde de manière chiffrée, sans navigateur ni redirection SSO, idéal pour les pipelines CI/CD, les conteneurs Docker et les sessions SSH.

nylas auth config

Passez la clé comme flag pour une configuration non interactive, et ajoutez --region eu si votre application est dans la région EU. La clé commence par nyl_ :

nylas auth config --api-key nyl_abc123
nylas auth config --api-key nyl_abc123 --region eu

Comment récupérer une clé API depuis le dashboard ?

Nouveau sur Nylas mais vous préférez le dashboard à l'assistant ? Générez une clé API en trois étapes, puis connectez-vous avec nylas auth config ci-dessus. L'offre gratuite inclut 5 comptes connectés et ne nécessite aucune carte bancaire.

  1. Inscrivez-vous sur dashboard-v3.nylas.com avec Google, Microsoft ou GitHub SSO.
  2. Créez une application — ouvrez All apps, créez une nouvelle app et choisissez votre région (US ou EU).
  3. Générez une clé API — ouvrez la section API Keys de l'application et cliquez sur Create new key. La clé commence par nyl_.

Se connecter avec une clé authentifie la CLI auprès de votre application mais ne connecte encore aucune boîte aux lettres. Connectez votre premier compte e-mail avec nylas auth login, la même commande utilisée pour ajouter d'autres comptes par la suite (abordée ci-après).

Comment connecter des comptes e-mail ?

Connectez une boîte aux lettres avec nylas auth login. L'offre gratuite connecte jusqu'à 5 comptes (appelés grants) pour Gmail, Outlook, Exchange, Yahoo, iCloud et IMAP. Google est le fournisseur par défaut, donc la commande seule démarre une connexion Google ; passez --provider pour les cinq autres. La CLI détecte chaque nouveau grant automatiquement à la prochaine commande.

# Fournisseurs OAuth (ouvre un navigateur)
nylas auth login --provider google
nylas auth login --provider microsoft
nylas auth login --provider ews

# Fournisseurs par identifiants (mot de passe d'application)
nylas auth login --provider icloud
nylas auth login --provider yahoo
nylas auth login --provider imap

Selon la documentation OAuth 2.0 de Google, les access tokens expirent après 3 600 secondes. La CLI stocke le grant et renouvelle les tokens automatiquement, vous n'autorisez donc qu'une seule fois. Listez et basculez entre les comptes connectés avec :

# Lister tous les comptes connectés
nylas auth list

# Basculer le compte actif
nylas auth switch

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