@forinda/kickjs-cli

Command-line interface for scaffolding projects, generating code, and running the dev server.

Installation

# Global install
pnpm add -g @forinda/kickjs-cli

# Or use npx
npx @forinda/kickjs-cli new my-api

Link local build (for contributors)

pnpm build
cd packages/cli && pnpm link --global

kick now points to your local build. Re-run pnpm build after changes.

CLI Commands

Command	Alias	Description
kick new <name>	kick init	Create a new KickJS project
kick dev		Start dev server with Vite HMR
kick list	kick ls	List all available KickJS packages
kick add <packages...>		Install KickJS packages with peer deps
kick generate --list	kick g --list	List all available generators
kick generate module <name>	kick g module	Generate a full DDD module with all layers
kick generate scaffold <name> <fields...>	kick g scaffold	CRUD module from field definitions
kick generate adapter <name>	kick g adapter	Generate an AppAdapter scaffold
kick generate middleware <name>	kick g middleware	Generate an Express middleware function
kick generate guard <name>	kick g guard	Generate a route guard
kick generate service <name>	kick g service	Generate a @Service() class
kick generate controller <name>	kick g controller	Generate a @Controller() class with routes
kick generate dto <name>	kick g dto	Generate a Zod DTO schema
kick generate resolver <name>	kick g resolver	Generate a GraphQL @Resolver class
kick generate job <name>	kick g job	Generate a @Job queue processor
kick generate test <name>	kick g test	Generate a Vitest test scaffold
kick generate config	kick g config	Generate kick.config.ts
kick info		Print system and framework info
kick inspect		Inspect a running KickJS application
kick tinker		Interactive REPL

Command Options

kick new [name] (use . for current directory)

• -d, --directory <dir> -- Target directory (defaults to project name)
• --pm <manager> -- Package manager: pnpm | npm | yarn (prompted if omitted)
• --git / --no-git -- Initialize git repository (prompted if omitted)
• --install / --no-install -- Install dependencies (prompted if omitted)

kick dev

• -e, --entry <file> -- Entry file (default: src/index.ts)
• -p, --port <port> -- Port number

kick g module

• --pattern <type> -- Module structure: rest | ddd | cqrs | minimal (default: from config or ddd)
• --no-entity -- Skip entity and value object generation (DDD only)
• --no-tests -- Skip test file generation
• --repo <type> -- Repository implementation: inmemory | drizzle | prisma (default: from config or inmemory)
• --minimal -- Shorthand for --pattern minimal
• --modules-dir <dir> -- Modules directory (default: from config or src/modules)
• -f, --force -- Overwrite existing files without prompting

kick g controller / service / dto / guard / middleware

• -o, --out <dir> -- Output directory (overrides --module)
• -m, --module <name> -- Place inside a module's DDD folder structure

kick g adapter / resolver / job

• -o, --out <dir> -- Output directory (defaults vary per generator)

defineConfig

Helper to define a type-safe kick.config.ts.

function defineConfig(config: KickConfig): KickConfig

KickConfig

interface KickConfig {
  modulesDir?: string                     // default: 'src/modules'
  defaultRepo?: 'drizzle' | 'inmemory' | 'prisma'
  schemaDir?: string
  commands?: KickCommandDefinition[]
  style?: {
    semicolons?: boolean
    quotes?: 'single' | 'double'
    trailingComma?: 'all' | 'es5' | 'none'
    indent?: number
  }
}

KickCommandDefinition

Register custom CLI commands via kick.config.ts.

interface KickCommandDefinition {
  name: string              // e.g. 'db:migrate'
  description: string
  steps: string | string[]  // shell command(s) to run
  aliases?: string[]
}

Programmatic Exports

Generator functions for use outside the CLI.

function generateModule(options: ModuleOptions): Promise<string[]>
function generateScaffold(options: ScaffoldOptions): Promise<string[]>
function generateAdapter(options: { name: string; outDir: string }): Promise<string[]>
function generateMiddleware(options: { name: string; outDir: string }): Promise<string[]>
function generateGuard(options: { name: string; outDir: string }): Promise<string[]>
function generateService(options: { name: string; outDir: string }): Promise<string[]>
function generateController(options: { name: string; outDir: string }): Promise<string[]>
function generateDto(options: { name: string; outDir: string }): Promise<string[]>
function generateResolver(options: { name: string; outDir: string }): Promise<string[]>
function generateJob(options: { name: string; outDir: string; queue?: string }): Promise<string[]>
function generateConfig(options: ConfigOptions): Promise<string[]>
function initProject(options: { name: string; directory: string; packageManager: string }): Promise<void>
function loadKickConfig(cwd: string): Promise<KickConfig | null>

RepoType

type RepoType = 'drizzle' | 'inmemory' | 'prisma'

Naming Utilities

function toPascalCase(str: string): string
function toCamelCase(str: string): string
function toKebabCase(str: string): string
function pluralize(str: string): string