Guide

Primeiros passos com o Nylas CLI

Configure o Nylas CLI em menos de 2 minutos. Execute nylas init para um cadastro guiado que conecta seu e-mail, ou faça login com uma chave de API existente usando 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

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 após a instalação?

Existem dois caminhos de configuração após a instalação. Novos usuários executam nylas init, um assistente interativo que cria uma conta Nylas, monta um aplicativo, gera uma chave de API e conecta sua primeira conta de e-mail em uma única sessão. Se você já tem uma chave de API, execute nylas auth config para fazer login. Adicione caixas de correio com nylas auth login — o plano gratuito conecta até 5 contas.

Como configurar com o nylas init?

O assistente nylas init é o caminho mais rápido para novos usuários. Ele executa quatro etapas em uma única sessão interativa: faça login ou crie uma conta Nylas, selecione ou crie um aplicativo, gere e ative uma chave de API e, então, sincronize suas contas de e-mail existentes. O fluxo leva cerca de 90 segundos e abre o navegador uma vez para o login SSO.

nylas init

O assistente pede um provedor SSO (Google, Microsoft ou GitHub), depois conduz a criação de aplicativo e chave antes de conectar sua caixa de correio. Para pular o menu de provedor, passe o flag diretamente:

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

Quando o assistente termina, sua conta está autenticada e seu e-mail conectado. Confirme listando sua caixa de entrada:

nylas email list

Como fazer login com uma chave de API existente?

Já tem uma chave de API do Nylas Dashboard? Execute nylas auth config e cole a chave quando solicitado para fazer login — isso dispensa o assistente de 4 etapas. A CLI valida a chave em menos de um segundo e a salva criptografada, sem navegador ou redirecionamento SSO, ideal para pipelines CI/CD, containers Docker e sessões SSH.

nylas auth config

Passe a chave como flag para configuração não interativa e adicione --region eu se seu aplicativo está na região EU. A chave começa com nyl_:

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

Como obter uma chave de API no Dashboard?

Novo no Nylas mas prefere o Dashboard ao assistente? Gere uma chave de API em três passos e depois faça login com nylas auth config acima. O plano gratuito inclui 5 contas conectadas e não exige cartão de crédito.

  1. Cadastre-se em dashboard-v3.nylas.com com SSO do Google, Microsoft ou GitHub.
  2. Crie um aplicativo — abra All apps, crie um novo app e escolha sua região (US ou EU).
  3. Gere uma chave de API — abra a seção API Keys do aplicativo e clique em Create new key. A chave começa com nyl_.

Fazer login com uma chave autentica a CLI no seu aplicativo, mas ainda não conecta nenhuma caixa de correio. Conecte sua primeira conta de e-mail com nylas auth login, o mesmo comando usado para adicionar mais contas depois (veja a seguir).

Como conectar contas de e-mail?

Conecte uma caixa de correio com nylas auth login. O plano gratuito conecta até 5 contas (chamadas grants) entre Gmail, Outlook, Exchange, Yahoo, iCloud e IMAP. O Google é o provedor padrão, então o comando sem flags inicia um login do Google; passe --provider para os outros cinco. A CLI detecta cada novo grant automaticamente no próximo comando.

# Provedores OAuth (abre o navegador)
nylas auth login --provider google
nylas auth login --provider microsoft
nylas auth login --provider ews

# Provedores por credencial (senha de aplicativo)
nylas auth login --provider icloud
nylas auth login --provider yahoo
nylas auth login --provider imap

De acordo com a documentação OAuth 2.0 do Google, tokens de acesso expiram após 3.600 segundos. A CLI armazena o grant e renova os tokens automaticamente, então você autoriza apenas uma vez. Liste e alterne entre contas conectadas com:

# Listar todas as contas conectadas
nylas auth list

# Alternar a conta ativa
nylas auth switch

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