CLI Commands

Every command and option for nitrostack-cli and nitrostack-py.

The one place to look up a command in either CLI. For what each command does, see its page in NitroStack CLI.

Commands

Every command in both CLIs, in one table per language.

CommandPurpose
init <name>Create a project from a template
devDevelopment mode with hot reload
buildCompile for production
startStart the production server
installInstall root and widget dependencies
upgradeUpgrade NitroStack packages
generate <type> <name>Generate modules, tools, guards, and more
cursorConfigure Cursor to use the server
packCreate a deployment zip

Install with npm install -g @nitrostack/cli, or run any command with npx @nitrostack/cli.

Entry: nitrostack-py or python -m nitrostack.cli.main.

CommandPurpose
init [name]Scaffold (--template, --skip-install, --force, --port, --widget)
devHot reload (--port, --widget)
startProduction (--port, --widget)
packWheel (--dry-run, --include-env)
generate <type> <name>tool module guard pipe interceptor filter service
installDeps (--production)
upgradePin/bump (--version, --dry-run, --allow-downgrade)
validateLint project
registerClaude Desktop (--name, --file)

There is no build command.

TypeScript options

Each command's page explains what it does, with examples and every option's default. This table is the quick lookup.

CommandOptions
init--preset, --template, --description, --author, --skip-install, --force
dev--port
build--output
start--port
pack-o, --output, --dry-run, --include-env, --no-sync-gitignore
install--skip-widgets, --production
upgrade--dry-run
generate--module, --output, --force, --skip-related

cursor

cursor configures Cursor to discover and connect to your MCP server.

nitrostack-cli cursor [options]
OptionDescriptionDefault
-g, --globalInstall to ~/.cursor/mcp.jsonfalse
-l, --localInstall to .cursor/mcp.jsontrue
-t, --type <type>Connection type (command, legacy-sse, streamable-http)command
-u, --url <url>Custom HTTP URLAuto
-p, --port <port>Port for default HTTP URL3000
--forceForce overwrite existing configurationfalse

npm scripts

Projects created with init include these scripts:

{
  "scripts": {
    "dev": "nitrostack-cli dev",
    "build": "nitrostack-cli build",
    "start": "nitrostack-cli start",
    "upgrade": "nitrostack-cli upgrade",
    "install:all": "nitrostack-cli install"
  }
}

Run them with npm:

npm run dev          # Start development
npm run build        # Build for production
npm start            # Start production server
npm run upgrade      # Upgrade packages
npm run install:all  # Install all dependencies

Exit codes

Every command exits with one of these codes, so scripts can check the result:

CodeDescription
0Success
1General error

Environment variables

Variables the CLI and the server read:

VariableDescriptionDefault
NODE_ENVEnvironment modedevelopment
MCP_SERVER_PORTMCP server port3000
WIDGET_PORTWidget server port3001
LOG_LEVELLogging levelinfo

On this page