API Reference Complete reference for every CLI command, flag, option, and subcommand. Includes all supported values and default behaviors.
This page documents every command, flag, and option available in @igniter-js/cli. All defaults and behaviors are verified against the actual implementation in packages/cli/src/.
These apply to the top-level igniter command:
Option Description --helpShow help for the current command --versionShow the CLI version (0.0.1)
igniter init [project-name] [options] Argument Type Required Description project-namestringNo Name of the project directory. If omitted, prompts interactively.
Option Type Default Description --mode"install" | "new-project"new-projectOperation mode --pm, --package-manager"npm" | "yarn" | "pnpm" | "bun"auto-detected Package manager --templatestringinteractive prompt Starter template --add-onsstring— Comma-separated add-ons with inline options --database"none" | "postgresql" | "mysql" | "sqlite"— Database provider (shorthand) --no-gitflag falseSkip git init --no-installflag falseSkip dependency installation --no-dockerflag falseSkip Docker setup
Value Framework Runtime Type nextjsNext.js 15 Node.js Full-stack tanstack-startTanStack Start Node.js Full-stack express-rest-apiExpress Node.js Backend API bun-rest-apiBun Bun Backend API bun-react-appBun + React Bun Full-stack deno-rest-apiDeno Deno Backend API
Value Has Options Description databaseYes ORM + provider selection authYes Better Auth + plugins jobsNo Background job processing storeNo Redis key-value store mcpNo MCP server for AI agents loggingNo Structured logging telemetryNo OpenTelemetry botsNo Multi-platform bots shadcn-uiNo shadcn/ui init
--add-ons "addon-id[:option1[:option2+value2]]" Separator Purpose ,Separate add-ons :Separate positional options +Separate multi-select values
igniter generate <subcommand> [options] igniter generate feature [name] [options] Option Type Default Description [name]stringinteractive Feature name (kebab-case) --schemastring— Schema provider + model (e.g., prisma:User) --schema-pathstringauto-detected Custom schema file path
igniter generate controller [name] [options] Option Type Default Description [name]stringinteractive Controller name (kebab-case) -f, --featurestringinteractive Target feature name
igniter generate procedure [name] [options] Option Type Default Description [name]stringinteractive Procedure name (kebab-case) -f, --featurestringinteractive Target feature name
igniter generate docs [options] Option Type Default Description --routerstringsrc/igniter.router.tsRouter file path --outputstring./src/docsOutput directory
igniter generate schema [options] Option Type Default Description --routerstringsrc/igniter.router.tsRouter file path --outputstringsrc/igniter.schema.tsOutput file path
igniter generate caller [options] Option Type Default Description --namestringinteractive Caller name prefix --urlstring— Remote OpenAPI URL --pathstring— Local OpenAPI path --outputstringsrc/callers/<hostname>Output directory
Option Type Default Description --routerstringsrc/igniter.router.tsRouter file path --outputstringsrc/igniter.schema.tsSchema output path --docs-outputstring./src/docsDocs output directory --cmdstringauto-detected Dev server command
Package Manager Default Command npmnpm run devpnpmpnpm devyarnyarn devbunbun dev
The CLI detects your package manager from process.env.npm_config_user_agent:
User Agent Prefix Package Manager Executor yarn/yarnyarn dlxpnpm/pnpmpnpxbun/bunbunx(any other) npmnpx
Detection Rule Detected Framework next.config.js or next.config.ts existsnextjs@tanstack/react-start in package.json dependenciestanstack-startNeither matched generic
Code Meaning 0Success 1Error (initialization failed, file not found, validation error)