Installation
Install the Igniter.js CLI globally or per-project. Node.js 18.17+ required. Supports npm, pnpm, yarn, and bun.
Installation
The CLI can be installed globally (recommended) or run on-demand with your package manager's executor. It requires Node.js 18.17 or later.
The CLI uses commander for argument parsing, @clack/prompts for interactive prompts, and chokidar for file watching. These are bundled — no external system dependencies.
Global Installation
Install once, use everywhere:
npm install -g @igniter-js/clipnpm add -g @igniter-js/cliyarn global add @igniter-js/clibun add -g @igniter-js/cliVerify the installation:
igniter --helpYou should see the top-level help output listing init, generate, and dev commands.
Run Without Installing
You can run the CLI on-demand without global installation:
npx @igniter-js/cli@latest --helppnpm dlx @igniter-js/cli@latest --helpyarn dlx @igniter-js/cli@latest --helpbunx @igniter-js/cli@latest --helpAdding @latest ensures you always get the most recent version. For CI/CD pipelines, pin to a specific version: @igniter-js/cli@0.0.1.
Per-Project Installation
If you prefer to install the CLI as a dev dependency in a specific project:
npm install -D @igniter-js/cliThen use it via npx:
npx igniter init my-appOr add it to your package.json scripts:
{
"scripts": {
"igniter:init": "igniter init",
"igniter:generate": "igniter generate",
"igniter:dev": "igniter dev"
}
}Requirements
| Requirement | Minimum Version | Notes |
|---|---|---|
| Node.js | 18.17+ | Required for fetch, native fs/promises, and ESM support |
| TypeScript | 5.3+ | For generated code type inference (optional but recommended) |
The CLI itself is built with TypeScript and compiled with tsup. Generated code uses TypeScript features available in 5.3+ — if your project uses an older version, update your tsconfig.json.
Next Steps
Introduction
The official Igniter.js CLI. Create projects, scaffold features, wire add-ons, and keep schema + docs in sync — all from the terminal.
Quick Start
Create a full-stack Igniter.js project in 2 minutes. Next.js starter, PostgreSQL database with Prisma, Better Auth, and your first generated feature — copy-paste ready.