Guide

Erste Schritte mit der CLI

Richten Sie Nylas CLI in unter 2 Minuten ein. Führen Sie nylas init für eine geführte Anmeldung aus, die Ihre E-Mail verbindet, oder melden Sie sich mit einem vorhandenen API-Schlüssel über nylas auth config an.

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 nach der Installation ein?

Nach der Installation gibt es zwei Einrichtungswege. Neue Nutzer führen nylas init aus, einen interaktiven Assistenten, der ein Nylas-Konto erstellt, eine Anwendung aufsetzt, einen API-Schlüssel generiert und Ihr erstes E-Mail-Konto in einer Sitzung verbindet. Wenn Sie bereits einen API-Schlüssel haben, führen Sie nylas auth config aus, um sich anzumelden. Fügen Sie Postfächer mit nylas auth login hinzu — das kostenlose Kontingent verbindet bis zu 5 Konten.

Wie richte ich alles mit nylas init ein?

Der nylas init-Assistent ist der schnellste Weg für neue Nutzer. Er führt vier Schritte in einer interaktiven Sitzung aus: bei einem Nylas-Konto anmelden oder eines erstellen, eine Anwendung auswählen oder erstellen, einen API-Schlüssel generieren und aktivieren und anschließend Ihre vorhandenen E-Mail-Konten synchronisieren. Der Ablauf dauert etwa 90 Sekunden und öffnet den Browser einmal für die SSO-Anmeldung.

nylas init

Der Assistent fragt nach einem SSO-Anbieter (Google, Microsoft oder GitHub) und führt dann durch die Erstellung von Anwendung und Schlüssel, bevor er Ihr Postfach verbindet. Um das Anbieter-Auswahlmenü zu überspringen, übergeben Sie das Flag direkt:

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

Wenn der Assistent fertig ist, ist Ihr Konto authentifiziert und Ihre E-Mail verbunden. Bestätigen Sie es, indem Sie Ihren Posteingang auflisten:

nylas email list

Wie melde ich mich mit einem vorhandenen API-Schlüssel an?

Sie haben bereits einen API-Schlüssel aus dem Nylas Dashboard? Führen Sie nylas auth config aus und fügen Sie ihn auf Aufforderung ein, um sich anzumelden — das überspringt den 4-stufigen Assistenten. Die CLI validiert den Schlüssel in unter einer Sekunde und speichert ihn verschlüsselt, ohne Browser oder SSO-Weiterleitung — ideal für CI/CD-Pipelines, Docker-Container und SSH-Sitzungen.

nylas auth config

Übergeben Sie den Schlüssel als Flag für eine nicht-interaktive Einrichtung und ergänzen Sie --region eu, falls Ihre Anwendung in der EU-Region liegt. Der Schlüssel beginnt mit nyl_:

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

Wie hole ich einen API-Schlüssel aus dem Dashboard?

Neu bei Nylas, aber Sie bevorzugen das Dashboard gegenüber dem Assistenten? Generieren Sie einen API-Schlüssel in drei Schritten und melden Sie sich dann mit nylas auth config oben an. Das kostenlose Kontingent umfasst 5 verbundene Konten und erfordert keine Kreditkarte.

  1. Registrieren Sie sich unter dashboard-v3.nylas.com mit Google-, Microsoft- oder GitHub-SSO.
  2. Anwendung erstellen — öffnen Sie All apps, erstellen Sie eine neue App und wählen Sie Ihre Region (US oder EU).
  3. API-Schlüssel generieren — öffnen Sie den Abschnitt API Keys der App und klicken Sie auf Create new key. Der Schlüssel beginnt mit nyl_.

Die Anmeldung mit einem Schlüssel authentifiziert die CLI gegen Ihre Anwendung, verbindet aber noch kein Postfach. Verbinden Sie Ihr erstes E-Mail-Konto mit nylas auth login — demselben Befehl, mit dem Sie später weitere Konten hinzufügen (als Nächstes behandelt).

Wie verbinde ich E-Mail-Konten?

Verbinden Sie ein Postfach mit nylas auth login. Das kostenlose Kontingent verbindet bis zu 5 Konten (sogenannte Grants) über Gmail, Outlook, Exchange, Yahoo, iCloud und IMAP. Google ist der Standardanbieter, daher startet der bloße Befehl eine Google-Anmeldung; übergeben Sie --provider für die anderen fünf. Die CLI erkennt jeden neuen Grant automatisch beim nächsten Befehl.

# OAuth-Anbieter (öffnet einen Browser)
nylas auth login --provider google
nylas auth login --provider microsoft
nylas auth login --provider ews

# Anbieter mit Zugangsdaten (anwendungsspezifisches Passwort)
nylas auth login --provider icloud
nylas auth login --provider yahoo
nylas auth login --provider imap

Laut Googles OAuth-2.0-Dokumentation laufen Access Tokens nach 3.600 Sekunden ab. Die CLI speichert den Grant und erneuert Tokens automatisch, sodass Sie nur einmal autorisieren. Listen Sie verbundene Konten auf und wechseln Sie zwischen ihnen mit:

# Alle verbundenen Konten auflisten
nylas auth list

# Aktives Konto wechseln
nylas auth switch

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