CLI Commands
NeatNode provides an interactive CLI to scaffold Node.js projects and a focused resource generator for feature slices.
Main Command
npx neatnodeThis launches the interactive project generator. No flags required - you’ll be guided through prompts.
Resource Generation
neatnode g resource <name>Generates a complete backend resource and updates the route registry automatically.
Options
| Flag | Description |
|---|---|
--force | Overwrite an existing resource when regenerating it. |
Future Commands
Planned resource-oriented commands for later releases:
g controllerg serviceg routeg validation
Interactive Prompts
When you run the CLI, you’ll be asked:
| Prompt | Description |
|---|---|
| Project name | Folder name for your new project |
| Language | JavaScript or TypeScript |
| Template | Basic, REST API, or Socket.IO |
| Include CRUD? | Whether to include example CRUD files |
After Scaffolding
Once the CLI finishes, follow these steps:
cd <project-name>
npm install
npm run devGlobal Installation
If you prefer running without npx:
npm install -g neatnode
neatnodeVersion Check
neatnode --versionPrints the currently installed CLI version.
Help
neatnode --helpDisplays available commands and options.