Introduction

Overview

@igniter-js/cli is the command-line interface for Igniter.js. It is your single entry point for creating new projects, scaffolding features from database schemas, wiring add-ons (database, auth, jobs, and more), and keeping your TypeScript client schema and OpenAPI docs synchronized as you code.

No boilerplate. No manual wiring. One command, and you have a working project.

Key Capabilities

• Project Creation — igniter init creates a project with any of 6 starters (Next.js, TanStack Start, Express, Bun, Deno) plus 9 configurable add-ons
• Schema-aware Scaffolding — igniter generate feature --schema prisma:User reads your Prisma schema and generates type-safe controllers, procedures, and interfaces
• Auto-regeneration — igniter dev watches your router and features, then regenerates the client schema and OpenAPI spec on every change
• OpenAPI Client Generation — igniter generate caller takes any OpenAPI spec and produces a fully typed, Zod-validated Igniter Caller
• Multi-runtime — starters target different runtimes; add-ons adapt based on the detected framework
• Extensible — starters, add-ons, and schema providers are registry-based; the community can add new ones

Architecture

The CLI is structured around three top-level commands, each backed by a composable architecture of registries, template engines, and file watchers.

igniter
├── init           ← Create a new project or install into existing
│   ├── Starters   (6: nextjs, tanstack-start, express, bun-api, bun-react, deno)
│   ├── Add-ons    (9: database, auth, jobs, store, mcp, logging, telemetry, bots, shadcn-ui)
│   └── Generator  (template engine + file system)
│
├── generate       ← Scaffold code from schemas
│   ├── feature    (with optional Prisma schema provider)
│   ├── controller (inside a feature)
│   ├── procedure  (inside a feature)
│   ├── docs       (OpenAPI spec generation)
│   ├── schema     (client TypeScript schema)
│   └── caller     (OpenAPI → typed IgniterCaller)
│
└── dev            ← Watch mode with TUI
    ├── Watcher    (chokidar — router + features directory)
    ├── Generator  (schema + OpenAPI on change)
    └── TUI        (Ink-based split-pane terminal UI)

Core Systems

Quick Start

npm install -g @igniter-js/cli

pnpm add -g @igniter-js/cli

yarn global add @igniter-js/cli

bun add -g @igniter-js/cli

# Create a Next.js project with database + auth in 60 seconds
igniter init my-app \
  --template nextjs \
  --add-ons database,auth \
  --database postgresql

cd my-app

# Generate a Prisma-backed feature
igniter generate feature users --schema prisma:User

# Start dev mode — schema + docs regenerate on file change
igniter dev

Real-World Use Cases

Next Steps