Use o Notion do seu terminal com o Notion CLI (beta)

Neste documento de ajuda

Aprenda o básico sobre como usar o Notion na linha de comando, incluindo como configurar e correções comuns.

A Notion CLI ntn é uma ferramenta que permite que desenvolvedores e agentes de programação de IA trabalhem com o Notion digitando comandos em um terminal. Você pode ler e escrever conteúdo no Notion e (se tiver acesso) gerenciar Workers pela linha de comando.

Você também pode visualizar Workers e ler registros no Notion com o Modo de Desenvolvedor. Use a CLI quando precisar implantar Workers ou alterar o código ou a configuração deles.

Este artigo é uma visão geral de alto nível. Para a configuração técnica, consulte a documentação do desenvolvedor.

O que você precisa saber antes de começar

A CLI foi projetada para desenvolvedores e criadores técnicos.
A CLI está disponível em todos os planos. No entanto, a implantação e o gerenciamento de Notion Workers exigem um Plano Business ou Plano Enterprise.
Alguns recursos da plataforma para desenvolvedores que você usa por meio da CLI podem exigir planos específicos ou ativação por um administrador.
Se algo parecer estranho, primeiro verifique se você está usando a versão mais recente da CLI.
Se você só precisa visualizar um Worker, ler logs, desativá-lo ou /excluir, você pode fazer isso no Notion depois de ativar o Modo de Desenvolvedor.

Instale a CLI

A CLI funciona em Mac, Linux e Windows. Em qualquer um deles, você pode instalar com npm install -g ntn.

Para mais informações sobre a instalação, consulte a documentação do desenvolvedor.

Se algo não estiver funcionando

Comece com estas verificações rápidas:

Atualize a CLI e Tente novamente. A CLI foi projetada para se manter atualizada, e versões mais antigas podem se comportar de forma diferente.
Confirme se você está conectado à conta correta do Notion. Se você tiver várias contas ou espaços de trabalho, saia e entre novamente.
Verifique seu acesso no Notion primeiro. Se você não conseguir abrir a página ou a base de dados no Notion, a CLI também não poderá lê-la nem alterá-la.
Se você estiver tentando usar comandos de Workers, confirme se os Workers estão ativados. O acesso aos Workers pode depender do seu plano e se um Proprietário do espaço de trabalho os ativou.
Ainda com problemas? Consulte o erro exato e a correção na documentação do desenvolvedor, pois as etapas podem ser diferentes para cada comando.

Perguntas frequentes

Preciso da CLI para usar o Notion?

Não. A CLI é opcional e destinada a fluxos de trabalho de desenvolvedores.

A CLI funciona em dispositivos móveis?

Não. Ela é executada em um terminal no computador.

Onde posso encontrar a lista completa de comandos?

Você pode encontrá-la na documentação para desenvolvedores.

A CLI funciona no Windows?

Sim. A CLI funciona da mesma forma no Windows, Mac e Linux. Os Workers que você cria em uma plataforma aparecem da mesma forma em todos os lugares.

Posso gerenciar Workers no Notion em vez da CLI?

Parcialmente. Você pode visualizar Workers, ler registros, desativá-los e /excluir no Notion com o Modo de Desenvolvedor. Use a CLI para implantar Workers ou alterar o código ou a configuração.