Saltar para a documentação
CLI

Instalar

npm, pnpm, Bun ou Yarn, ou sem instalar nada com npx.

Instalar

A versão atual é a 0.0.1. Precisa de Node.js 20.12 ou posterior.

npm install -g @openemail/cli

O pacote é um único ficheiro empacotado sem dependências, e coloca um comando no seu PATH: openemail. O SDK com que chama a API vem incluído, por isso a CLI corre sempre com o SDK com que foi testada. openemail version mostra a versão de ambos, e a do ambiente de execução.

Verificar
openemail --versionopenemail --help

Executar sem instalar

npx descarrega o pacote para uma cache e executa-o, o que serve para um comando pontual, um trabalho de CI ou um cliente MCP que arranca a ponte local.

Terminal
npx @openemail/cli --helpnpx -y @openemail/[email protected] whoaminpx -y @openemail/cli mcp serve

Fixe a versão em CI, como em npx -y @openemail/[email protected], para que uma nova versão nunca altere um pipeline sem dar por isso.

Atualizações

A CLI nunca se atualiza sozinha. Lembra-se durante um dia do que o registo npm disse sobre a versão mais recente. Quando essa informação é mais antiga, volta a perguntar em segundo plano enquanto o seu comando corre, e quando o comando termina espera pela resposta no máximo um quinto de segundo. Se existir uma versão mais recente, mostra um aviso em stderr depois de o seu comando terminar:

Aviso de atualização
Update available! 0.0.1 → 0.0.2Changelog: https://openemail.uk/docs/cli/changelogRun `npm i -g @openemail/cli@latest` to update. Disable this notice with OPENEMAIL_NO_UPDATE_CHECK=1
  • O comando de instalação no aviso corresponde ao gestor de pacotes com que instalou.
  • Não há aviso com --help, --version ou --json, para help, version, update ou completion, quando stdout ou stderr não é um terminal, nem em CI.
  • Defina OPENEMAIL_NO_UPDATE_CHECK=1 para o desligar em todo o lado. OPENEMAIL_DISABLE_UPDATE_NOTICE=1 faz o mesmo.
  • O único pedido vai para o registo npm, e a resposta fica guardada em ~/.openemail/update-check.json durante um dia.

openemail update verifica de imediato, ignorando a cache diária, e mostra o comando a executar ou que já tem a versão mais recente.

npm i -g @openemail/cli@latest

Autocompletar da shell

openemail completion <shell> mostra um script de autocompletar para bash, zsh ou fish, gerado a partir de cada comando, subcomando e opção da sua versão. Volte a executá-lo depois de uma atualização.

echo 'eval "$(openemail completion bash)"' >> ~/.bashrc

Desinstalar

Termine a sessão primeiro, para que cada início de sessão no navegador seja revogado no servidor, e depois remova o pacote e a pasta onde a CLI guarda os seus inícios de sessão.

Terminal
openemail logout --allnpm uninstall -g @openemail/clirm -rf ~/.openemail

A sua caixa de entrada,
nos seus termos.

Infraestrutura de email para empresas, IA, agentes e correio pessoal. Feita para escala, privacidade e controlo. Tudo o que o email devia ter tido desde o primeiro dia.

OpenEmail

Infraestrutura de email para empresas, IA, agentes e correio pessoal. Feita para escala, privacidade e controlo. Tudo o que o email devia ter tido desde o primeiro dia.

© 2026 OpenEmail. Todos os direitos reservados.