CLI Options

NeatNode uses an interactive prompt-based interface for project scaffolding. Resource generation adds a focused command, but the main setup flow still runs through prompts.

Interactive Prompts

When you run npx neatnode, you’ll be prompted for:

Prompt	Options	Description
Project name	Any valid folder name	Directory name for your project
Language	JavaScript, TypeScript	Choose your preferred language
Template	Basic, REST API, Socket.IO	Select project template
Architecture	MVC, Modular	Select folder architecture (for REST API)
Include CRUD?	Yes, No	Include example CRUD files

Available Flags

Flag	Description
`--version`, `-v`	Display CLI version
`--help`, `-h`	Show help information

Resource Generation Flags

Flag	Description
`--force`	Overwrite an existing resource when using `neatnode g resource <name>`.

Examples


# Interactive mode (recommended)
npx neatnode
 
# Check version
npx neatnode --version
 
# Show help
npx neatnode --help

Future Options

Planned flags for upcoming releases:

--template <name> - Skip template prompt
--typescript / --js - Skip language prompt
--no-crud - Skip CRUD prompt

[!NOTE] These flags are planned but not yet implemented. Use interactive mode for now.