Skip to Content
API ReferenceCLI Options

CLI Options

NeatNode uses an interactive prompt-based interface. Currently, all configuration is done through prompts rather than command-line flags.


Interactive Prompts

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

PromptOptionsDescription
Project nameAny valid folder nameDirectory name for your project
LanguageJavaScript, TypeScriptChoose your preferred language
TemplateBasic, REST API, Socket.IOSelect project template
Include CRUD?Yes, NoInclude example CRUD files

Available Flags

FlagDescription
--version, -vDisplay CLI version
--help, -hShow help information

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
  • --force — Overwrite existing directory

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