Crie um community Node com a ferramenta oficial

A ferramenta oficial n8n-node gera a estrutura de um community Node, compila TypeScript e executa o componente durante o desenvolvimento. Você pode criar o projeto pelo inicializador npm, sem instalar o CLI globalmente.

Gere o projeto

Em um diretório de desenvolvimento, execute:

1
npm create @n8n/node@latest

O inicializador solicita o nome do projeto, o estilo do Node e o template. Use o formato n8n-nodes-NOME ou @ORGANIZACAO/n8n-nodes-NOME, substituindo os marcadores. A ferramenta cria o diretório e, por padrão, instala as dependências iniciais.

Para uma API HTTP, a opção HTTP API cria uma estrutura declarativa. Você pode começar pelo exemplo GitHub Issues API ou por Start from scratch. Nesse segundo caminho, o inicializador solicita a URL base e o método de autenticação da API.

Escolha o estilo conforme o componente

A opção Other gera uma estrutura programática. Esse estilo permite escrever a lógica do componente com mais flexibilidade e é necessário para triggers, pois o estilo declarativo não oferece suporte a eles.

Um pacote que já possui um Node declarativo também pode incluir um trigger programático. Escolha o template pelo comportamento necessário. Depois, implemente as ações e as credenciais.

Desenvolva e confira o código

Dentro do diretório criado, os scripts do projeto permitem iniciar a instância de desenvolvimento, conferir o código e compilar os arquivos:

1
npm run dev
2
npm run lint
3
npm run build

Execute cada comando conforme a etapa do trabalho. O modo de desenvolvimento recompila o componente quando detecta alterações. O lint verifica a conformidade do código com os padrões de desenvolvimento. O build compila TypeScript e reúne os recursos necessários ao pacote.

No n8n 3.0, o ciclo padrão de n8n-node dev usa a imagem oficial em um container e exige Docker ou Podman. Para uma instância externa, a documentação oferece n8n-node dev --external-n8n com N8N_DEV_RELOAD=true nessa instância.

Teste e publicação do componente

Adicione o Node a um workflow na instância de desenvolvimento e confira cada ação implementada. No ciclo de containers da v3, workflows e credenciais de teste ficam em um volume por imagem. Exporte os workflows de teste que pretende preservar antes de trocar a imagem ou atualizar o CLI.

O comando n8n-node release publica o pacote no npm e exige autenticação com npm login. Execute a publicação somente depois de revisar o componente e conferir os testes locais.