Skip to Content
API ReferenceCLI Commands

CLI Commands

NeatNode provides an interactive CLI to scaffold Node.js projects. Here’s how to use it.


Main Command

npx neatnode

This launches the interactive project generator. No flags required — you’ll be guided through prompts.


Interactive Prompts

When you run the CLI, you’ll be asked:

PromptDescription
Project nameFolder name for your new project
LanguageJavaScript or TypeScript
TemplateBasic, 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 dev

Global Installation

If you prefer running without npx:

npm install -g neatnode neatnode

Version Check

neatnode --version

Prints the currently installed CLI version.


Help

neatnode --help

Displays available commands and options.