@forinda/kickjs-cli

CLI for KickJS — project scaffolding, REST and minimal module generators, dev/build/start commands.

Install

pnpm add -D @forinda/kickjs-cli

# or scaffold a fresh project
npx @forinda/kickjs-cli new my-api

Commands

The CLI is a dev dependency, so in a shell run it through your package manager — npx kick dev, pnpm exec kick dev, yarn kick dev, bunx kick dev — or through the project's scripts (npm run dev). A bare kick needs a global install.

kick new <name>           # Scaffold a new KickJS project
kick dev                  # Start dev server with Vite HMR
kick build                # Production build via Vite
kick start                # Run production build

kick g module <name>      # Controller, service, repository, DTOs, tests
kick g scaffold <name> <fields…>  # CRUD module from field definitions
kick g controller|service|middleware|guard|adapter|plugin|contributor|dto|test <name>
kick g agents             # Regenerate AGENTS.md / CLAUDE.md / skills after an upgrade

kick rm module <name>     # Remove a module
kick add <pkg>            # Install a KickJS package + peers
kick add upload           # Install the multipart driver for your runtime
kick add --list           # Show all available packages

kick doctor               # Pre-flight checks (engine peers, upload driver, env wiring)
kick mcp start            # Run app as an MCP stdio server
kick typegen              # Refresh KickRoutes / KickEnv / KickRuntimeRegister type maps

kick new is interactive (template, runtime, package manager, repository, package multi-select, git init, install) — every prompt has a flag for CI: --template rest|minimal|fullstack, --runtime express|fastify|h3, --pm pnpm|npm|yarn|bun, --repo inmemory|<db-name> (e.g. postgres), --packages swagger,ws,queue,devtools, --no-git, --no-install, --force, -y/--yes.

HTTP runtimes

KickJS runs on Express (default), Fastify, or h3 — pick the engine at scaffold time with kick new --runtime, and the CLI installs the right engine peers and writes runtime into kick.config.ts. That field then drives the dep-aware commands:

kick new my-api --runtime fastify   # scaffolds fastify + @fastify/middie, runtime: 'fastify'
kick add upload                     # → @fastify/multipart (express → multer, h3 → built-in)
kick doctor                         # verifies the engine peers + upload driver are present
kick typegen                        # emits KickRuntimeRegister so ctx.app / getRuntimeApp() are typed to the engine

Documentation

kickjs.app/guide/cli-commands — every command + flag, custom commands via kick.config.ts, generator architecture.

License

MIT