Guide

Erste Schritte mit der CLI

Richten Sie Nylas CLI in unter 2 Minuten ein. Erstellen Sie ein kostenloses Nylas-Konto, holen Sie sich einen API-Schlüssel aus dem Dashboard und führen Sie nylas auth config aus. Kein Browser-Auth-Flow nötig.

Written by Prem Keshari Senior SRE

Reviewed by Caleb Geene

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

Wie installiere ich Nylas CLI?

Nylas CLI wird als einzelne 12 MB statische Binary ohne Laufzeitabhängigkeiten installiert. Wählen Sie die Methode, die zu Ihrer Plattform passt — jede erkennt automatisch Ihre CPU-Architektur (x86_64 oder arm64), lädt den passenden Build von GitHub herunter und prüft den Download mit SHA-256-Prüfsummen. Die Installation dauert auf den meisten Verbindungen weniger als 30 Sekunden.

Homebrew (macOS und Linux)

Die Homebrew-Formel zapft das nylas/nylas-cli-Repository an und pinnt das neueste stabile Release. Homebrew übernimmt Upgrades automatisch, wenn Sie brew upgrade ausführen.

brew install nylas/nylas-cli/nylas

Shell-Skript (macOS, Linux, WSL)

Das Shell-Installationsskript funktioniert auf jedem POSIX-System, einschließlich WSL. Es schreibt die Binary nach ~/.config/nylas/bin und gibt eine PATH-Export-Zeile aus, die Sie Ihrem Shell-Profil hinzufügen können.

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

PowerShell (Windows)

Das PowerShell-Installationsskript lädt die Windows-Binary herunter und fügt das Installationsverzeichnis Ihrem benutzerbezogenen PATH hinzu. Es erfordert PowerShell 5.1 oder höher, das mit Windows 10 und 11 ausgeliefert wird.

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

Go

Das Kompilieren aus dem Quellcode erfordert Go 1.23 oder höher. Die Binary landet in Ihrem $GOPATH/bin-Verzeichnis.

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

Nach der Installation mit einer beliebigen Methode prüfen Sie, ob die Binary in Ihrem PATH liegt:

nylas --version

Wie richte ich Nylas CLI ein?

Der schnellste Weg ist ein API-Schlüssel aus dem Nylas Dashboard. Fünf Schritte, unter 2 Minuten, kein Browser-Auth-Flow erforderlich.

Schritt 1: Nylas-Konto erstellen

Registrieren Sie sich unter dashboard-v3.nylas.com. Das kostenlose Kontingent umfasst 5 verbundene Konten — genug für den persönlichen Gebrauch und zum Testen. Sie können sich mit Google, Microsoft oder GitHub SSO anmelden.

Schritt 2: Anwendung erstellen

Gehen Sie im Dashboard zu All apps → Create new app. Wählen Sie einen Namen und Ihre Region (US oder EU). Jede Anwendung unterstützt unbegrenzt viele verbundene E-Mail-Konten (sogenannte Grants) für Gmail, Outlook, Exchange, Yahoo, iCloud und IMAP.

Schritt 3: API-Schlüssel holen

Öffnen Sie Ihre Anwendung im Dashboard und navigieren Sie zum Abschnitt API Keys. Klicken Sie auf Create new key. Kopieren Sie den Schlüssel — er beginnt mit nyl_ und wird im nächsten Schritt in die CLI eingefügt.

Schritt 4: E-Mail-Konto verbinden

Navigieren Sie im Dashboard zum Abschnitt Grants Ihrer Anwendung und klicken Sie auf Add Account. Autorisieren Sie sich bei Ihrem E-Mail-Anbieter (Gmail, Outlook, Exchange, Yahoo, iCloud oder IMAP). Dadurch entsteht ein Grant — die Verbindung zwischen Ihrem E-Mail-Konto und Ihrer Nylas-Anwendung.

Schritt 5: CLI konfigurieren

Führen Sie nylas auth config aus und fügen Sie Ihren API-Schlüssel ein, wenn Sie dazu aufgefordert werden. Die CLI validiert den Schlüssel gegen die Nylas-API, speichert ihn verschlüsselt unter ~/.config/nylas/config.yaml und synchronisiert den soeben verbundenen Grant.

nylas auth config

Falls Ihre Nylas-Anwendung in der EU-Region liegt, übergeben Sie --region eu:

nylas auth config --region eu

Die CLI bestätigt die Speicherung und zeigt Ihre verbundenen Konten:

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

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

Fertig — listen Sie Ihren Posteingang auf, um zu prüfen, ob alles funktioniert:

nylas email list

Wie verbinde ich weitere E-Mail-Konten?

Um nach der Einrichtung weitere Konten hinzuzufügen, öffnen Sie das Nylas Dashboard, navigieren Sie zum Abschnitt Grants Ihrer Anwendung und klicken Sie auf Add Account. Die CLI erkennt neue Grants automatisch beim nächsten Befehl.

Sie können Konten auch direkt über die CLI per OAuth verbinden:

nylas auth login

Dieser Befehl öffnet Ihren Browser zur Autorisierung. Laut Googles OAuth-2.0-Dokumentation laufen Access Tokens nach 3.600 Sekunden ab — die CLI erneuert sie automatisch. Falls der Browser-Flow nach der Autorisierung hängt, verwenden Sie stattdessen die Dashboard-Methode.

Verwalten Sie Ihre verbundenen Konten mit:

# Alle verbundenen Konten auflisten
nylas auth list

# Zwischen Konten wechseln
nylas auth switch

Wie richte ich alles mit einem einzigen Befehl ein?

nylas init --api-key konfiguriert das CLI in einem einzigen nicht-interaktiven Befehl — ohne Browser-Authentifizierung und ohne SSO-Weiterleitung, anders als der interaktive Assistent, der vier Schritte durchläuft. Übergeben Sie Ihren Schlüssel direkt und das CLI authentifiziert sich sofort, was diesen Weg zur Wahl für Umgebungen ohne Oberfläche macht: CI/CD-Pipelines, Docker-Container und SSH-Sitzungen, in denen kein Browser verfügbar ist.

nylas init --api-key nyl_abc123

Verwenden Sie --region eu, falls Ihre Anwendung in der EU-Region liegt:

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

Wie verwende ich den interaktiven Einrichtungsassistenten?

Der nylas init-Assistent ist eine Alternative zum API-Schlüssel-Flow oben. Er führt Sie durch Kontoerstellung, Anwendungsauswahl, API-Schlüssel-Generierung und Grant-Synchronisation in einer interaktiven Sitzung. Dafür wird ein Browser für die SSO-Authentifizierung benötigt.

nylas init

Um das SSO-Anbieter-Auswahlmenü zu überspringen, übergeben Sie das Flag direkt:

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

Wie verwalte ich mein Konto über die CLI?

Die CLI bildet etwa 90 % der Web-Dashboard-Funktionalität über nylas dashboard-Unterbefehle ab. Sie können Anwendungen erstellen, API-Schlüssel rotieren, Organisationen wechseln und Ihren Anmeldestatus prüfen, ohne einen Browser zu öffnen. Jeder Unterbefehl unterstützt --json-Ausgabe für Skripting.

Die häufigsten Dashboard-Operationen:

# Anmeldestatus prüfen
nylas dashboard status

# Anwendungen auflisten
nylas dashboard apps list

# Neue Anwendung erstellen
nylas dashboard apps create --name "Production App" --region us

# Anwendung als aktiv setzen
nylas dashboard apps use app_abc123

# Neuen API-Schlüssel generieren
nylas dashboard apps apikeys create

# Organisation wechseln
nylas dashboard orgs switch

Wie verwende ich E-Mail, Kalender und Kontakte?

Die CLI organisiert ihre 72+ Befehle in drei Kerngruppen: E-Mail (senden, auflisten, suchen, Entwurf, Anhang), Kalender (Termine, Verfügbarkeit, Planung) und Kontakte (auflisten, suchen, Gruppen). Jede Gruppe unterstützt --json-Ausgabe für Skripting und --limit zur Steuerung der Ergebnismenge. Hier sind die Befehle, die Sie nach der Einrichtung am häufigsten nutzen:

# E-Mail: auflisten, suchen und senden
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."

# Kalender: Termine auflisten und Verfügbarkeit prüfen
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

# Kontakte: auflisten und suchen
nylas contacts list --limit 10
nylas contacts search --query "Alice"
nylas contacts groups list

Fügen Sie --json zu jedem Befehl hinzu, um strukturierte Ausgabe zu erhalten, die Sie an jq weiterleiten, in ein Skript einspeisen oder einem KI-Agenten übergeben können. Die Anleitung zum E-Mail-Versand und die Kalender-Anleitung behandeln jede Gruppe ausführlich.

Wie setze ich alles zurück und fange von vorne an?

Die CLI speichert die gesamte Konfiguration lokal unter ~/.config/nylas/ — in der Regel 3-4 Dateien mit insgesamt unter 2 KB. Ein Reset entfernt API-Zugangsdaten, Dashboard-Sitzungs-Tokens, authentifizierte Grants und die Konfigurationsdatei — hat aber keinen Einfluss auf Ihre Nylas-Dashboard-Daten oder die serverseitig verbundenen Konten. Ihre Anwendungen, Grants und API-Schlüssel bleiben in der Cloud erhalten.

Um die lokale Konfiguration zu löschen und die Einrichtung erneut auszuführen:

nylas config reset
nylas init

Verwenden Sie --force, um die Bestätigungsabfrage zu überspringen — nützlich in Skripten, die die CLI automatisch neu konfigurieren müssen.

Nächste Schritte