Skip to Content
Getting StartedCLI Usage

CLI Usage

The NeatNode CLI helps you quickly scaffold ready-to-run Node.js projects - interactively and without configuration.

Run the CLI (Interactive Mode)

Execute the command below in your terminal:

npx neatnode

You’ll be prompted to choose:

  • Project name (e.g., my-app)
  • Language (JavaScript or TypeScript)
  • Template type - Basic, REST API, or Socket.io
  • Architecture - MVC or Modular (Applies to REST API)
  • Include CRUD? - Whether to add default CRUD examples

Example Session

? Enter project name › my-app
? Select language › JavaScript
? Choose a template › REST API
? Choose architecture › MVC
? Include CRUD example? › No

Once confirmed, the CLI scaffolds your project:

✅ Created project: ./my-app
💡 Next steps:
   cd my-app
   npm install
   npm run dev

Then you can generate your first resource:

neatnode g resource user
✔ Created user.controller.js
✔ Created user.service.js
✔ Created user.route.js
✔ Created user.validation.js
✔ Created user.model.js

✔ Updated routes/index.route.js

✨ Resource "user" generated successfully.

[!TIP] NeatNode is fully interactive - just run npx neatnode and follow the prompts. No flags needed!

QuickstartTemplates