Skip to content

CLI Reference

Command-line interface for NestForge Web

-h, --help Show help
-V, --version Show version

Create a new NestForge Web project.

Terminal window
nestforge-web new <name> [options]

Options:

  • -p, --path <path> - Directory to create project (default: .)
  • --ts - Use TypeScript (default)
  • --rs - Include Rust backend

Example:

Terminal window
nestforge-web new my-app
nestforge-web new my-app --path ./projects

Start the development server with hot module replacement.

Terminal window
nestforge-web dev [options]

Options:

  • -p, --port <port> - Port to listen on (default: 3000)
  • -h, --host <host> - Host to bind to (default: 127.0.0.1)
  • --app-dir <dir> - Frontend source directory (default: src/app)

Example:

Terminal window
nestforge-web dev
nestforge-web dev --port 8080
nestforge-web dev --host 0.0.0.0

Build the application for production.

Terminal window
nestforge-web build [options]

Options:

  • --app-dir <dir> - Frontend source directory (default: src/app)
  • --out-dir <dir> - Output directory (default: .next)
  • --no-sourcemap - Disable source maps

Example:

Terminal window
nestforge-web build
nestforge-web build --out-dir dist

Start the production server.

Terminal window
nestforge-web start [options]

Options:

  • -p, --port <port> - Port to listen on (default: 3000)
  • -h, --host <host> - Host to bind to (default: 127.0.0.1)

Example:

Terminal window
nestforge-web start
nestforge-web start --port 8080 --host 0.0.0.0

Generate code scaffolds.

Terminal window
nestforge-web generate <type> <name> [options]

Types:

  • page - New page component
  • component - New React component
  • api - New API route
  • module - New NestForge module
  • resource - Full CRUD resource

Example:

Terminal window
nestforge-web generate page about
nestforge-web generate api users
nestforge-web generate module blog
VariableDefaultDescription
PORT3000Server port
HOST127.0.0.1Server host
APP_DIRsrc/appFrontend source
NESTFORGE_DIRsrc/nestforgeBackend source
NODE_ENVdevelopmentEnvironment mode