Guide

Primeiros passos com o Nylas CLI

Configure o Nylas CLI em menos de 2 minutos. Crie uma conta Nylas gratuita, obtenha uma chave de API no Dashboard e execute nylas auth config. Sem fluxo de autenticação no navegador, funciona no macOS, Linux e Windows.

Written by Prem Keshari Senior SRE

Reviewed by Caleb Geene

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

Como instalar o Nylas CLI?

O Nylas CLI instala como um binário estático de 12 MB sem dependências de runtime. Escolha o método que corresponde à sua plataforma — cada opção detecta automaticamente a arquitetura da CPU (x86_64 ou arm64), baixa a versão correta do GitHub e verifica o download com checksums SHA-256. A instalação leva menos de 30 segundos na maioria das conexões.

Homebrew (macOS e Linux)

A fórmula Homebrew usa o repositório nylas/nylas-cli e fixa a versão estável mais recente. O Homebrew gerencia atualizações automaticamente quando você executa brew upgrade.

brew install nylas/nylas-cli/nylas

Shell script (macOS, Linux, WSL)

O instalador shell funciona em qualquer sistema POSIX, incluindo WSL. Ele grava o binário em ~/.config/nylas/bin e exibe uma linha de exportação do PATH que você pode adicionar ao perfil do seu shell.

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

PowerShell (Windows)

O instalador PowerShell baixa o binário do Windows e adiciona o diretório de instalação ao PATH do usuário. Requer PowerShell 5.1 ou posterior, que já vem com o Windows 10 e 11.

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

Go

Compilar a partir do código-fonte requer Go 1.23 ou posterior. O binário fica no diretório $GOPATH/bin.

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

Após instalar com qualquer método, confirme que o binário está no PATH verificando a versão:

nylas --version

Como configurar o Nylas CLI?

A forma mais rápida de começar é com uma chave de API do Nylas Dashboard. Cinco passos, menos de 2 minutos, sem fluxo de autenticação no navegador.

Passo 1: Criar uma conta Nylas

Cadastre-se em dashboard-v3.nylas.com. O plano gratuito inclui 5 contas conectadas, suficiente para uso pessoal e testes. Você pode se cadastrar com SSO do Google, Microsoft ou GitHub.

Passo 2: Criar um aplicativo

No Dashboard, vá em All apps → Create new app. Escolha um nome e selecione sua região (US ou EU). Cada aplicativo suporta contas de e-mail conectadas ilimitadas (chamadas grants) para Gmail, Outlook, Exchange, Yahoo, iCloud e IMAP.

Passo 3: Obter sua chave de API

Abra seu aplicativo no Dashboard e vá até a seção API Keys. Clique em Create new key. Copie a chave — ela começa com nyl_ e você vai colá-la na CLI no próximo passo.

Passo 4: Conectar sua conta de e-mail

Ainda no Dashboard, vá até a seção Grants do seu aplicativo e clique em Add Account. Autorize com seu provedor de e-mail (Gmail, Outlook, Exchange, Yahoo, iCloud ou IMAP). Isso cria um grant — a conexão entre sua conta de e-mail e seu aplicativo Nylas.

Passo 5: Configurar a CLI

Execute nylas auth config e cole sua chave de API quando solicitado. A CLI valida a chave junto à API Nylas, salva-a criptografada em ~/.config/nylas/config.yaml e sincroniza o grant que você acabou de conectar.

nylas auth config

Se seu aplicativo Nylas está na região EU, passe --region eu:

nylas auth config --region eu

A CLI confirma que a chave foi salva e mostra suas contas conectadas:

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

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

Pronto — tente listar sua caixa de entrada para confirmar que tudo funciona:

nylas email list

Como conectar contas de e-mail adicionais?

Para adicionar mais contas após a configuração, vá ao Nylas Dashboard, abra a seção Grants do seu aplicativo e clique em Add Account. A CLI detecta novos grants automaticamente no próximo comando.

Você também pode conectar contas diretamente pela CLI com OAuth:

nylas auth login

Isso abre o navegador para autorização. De acordo com a documentação OAuth 2.0 do Google, tokens de acesso expiram após 3.600 segundos — a CLI os renova automaticamente. Se o fluxo no navegador travar após conceder permissões, use o método pelo Dashboard.

Gerencie suas contas conectadas com:

# Listar todas as contas conectadas
nylas auth list

# Alternar entre contas
nylas auth switch

Como configurar com um único comando?

O nylas init --api-key configura a CLI em um único comando não interativo — sem fluxo de autenticação no navegador e sem redirecionamento SSO, ao contrário do assistente interativo, que executa quatro etapas. Passe sua chave diretamente e a CLI autentica imediatamente, o que torna este o caminho para ambientes headless: pipelines CI/CD, containers Docker e sessões SSH onde nenhum navegador está disponível.

nylas init --api-key nyl_abc123

Use --region eu se seu aplicativo está na região EU:

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

Como usar o assistente de configuração interativo?

O assistente nylas init é uma alternativa ao fluxo com chave de API descrito acima. Ele guia você pela criação de conta, seleção de aplicativo, geração de chave de API e sincronização de grants em uma sessão interativa. Requer navegador para autenticação SSO.

nylas init

Para pular o menu de seleção de provedor SSO, passe o flag diretamente:

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

Como gerenciar minha conta pela CLI?

O Nylas CLI espelha cerca de 90% das funcionalidades do Dashboard web através dos subcomandos nylas dashboard. Você pode criar aplicativos, rotacionar chaves de API, trocar de organização e verificar o status de login sem abrir o navegador. Todos os subcomandos suportam saída --json para scripts.

As operações mais comuns do Dashboard:

# Verificar status de login
nylas dashboard status

# Listar aplicativos
nylas dashboard apps list

# Criar um novo aplicativo
nylas dashboard apps create --name "Production App" --region us

# Definir um aplicativo como ativo
nylas dashboard apps use app_abc123

# Gerar uma nova chave de API
nylas dashboard apps apikeys create

# Trocar de organização
nylas dashboard orgs switch

Como usar e-mail, calendário e contatos?

O Nylas CLI organiza seus 72+ comandos em três grupos principais: e-mail (enviar, listar, pesquisar, rascunho, anexo), calendário (eventos, disponibilidade, agendamento) e contatos (listar, pesquisar, grupos). Cada grupo suporta saída --json para scripts e --limit para controlar a quantidade de resultados. Estes são os comandos mais usados após a configuração:

# E-mail: listar, pesquisar e enviar
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."

# Calendário: listar eventos e verificar disponibilidade
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

# Contatos: listar e pesquisar
nylas contacts list --limit 10
nylas contacts search --query "Alice"
nylas contacts groups list

Adicione --json a qualquer comando para obter saída estruturada que você pode redirecionar para jq, alimentar um script ou passar para um agente IA. O guia de envio de e-mail e o guia de calendário cobrem cada grupo em detalhes.

Como resetar e começar do zero?

O Nylas CLI armazena toda a configuração localmente em ~/.config/nylas/ — normalmente 3-4 arquivos totalizando menos de 2 KB. Resetar remove credenciais de API, tokens de sessão do Dashboard, grants autenticados e o arquivo de configuração — mas não afeta seus dados no Nylas Dashboard nem as contas conectadas no servidor. Seus aplicativos, grants e chaves de API permanecem intactos na nuvem.

Para limpar a configuração local e refazer a configuração:

nylas config reset
nylas init

Use --force para pular o prompt de confirmação, útil em scripts que precisam reconfigurar a CLI automaticamente.

Próximos passos