Files
n8n-enterprise-unlocked/packages/@n8n/node-cli/README.md

48 lines
708 B
Markdown

# @n8n/node-cli
Official CLI for developing community nodes for [n8n](https://n8n.io).
## Features
- 🔧 Scaffold new nodes
- More coming soon
## Installation
Run directly via `npx`:
```bash
npx n8n-node new
```
Or install globally:
```bash
npm install -g @n8n/node-cli
n8n-node new
```
## Commands
## Create a node
```bash
n8n-node new # Scaffold a new node
```
## Build a node
```bash
n8n-node build # Build your node; should be ran in the root of your custom node
```
## Develop a node
```bash
n8n-node dev # Develop your node with hot reloading; should be ran in the root of your custom node
```
## Related
`@n8n/create-node`: Lightweight wrapper to support `npm create @n8n/node`