Skip to main content
RapidKit
Back to NPM package
npm wrapper surface

Complete CLI Reference

Every documented npx rapidkit command — workspace intelligence, adopt/import, kits, archives, doctor, infra, and Core-delegated module operations — with ownership labels and no gaps.

Showing 90 of 90 documented npm surface commands across 18 groups.

68
Wrapper-owned
7
Orchestrated lifecycle
15
Core-delegated
90
Total documented

Getting started

Interactive create flows and the my-workspace quick-start alias.

npm wrapper
npx rapidkit create

Prompt: workspace or project

npm wrapper
npx rapidkit create workspace <name> [--profile <profile>] [--author <name>] [--yes]
alias
npx rapidkit my-workspace [--here]

Quick-start workspace alias

npm wrapper
npx rapidkit create project <kit> <name> [--yes] [--skip-install] [--skip-git] [--output <dir>]
alias
npx rapidkit create frontend <id> <name>

Alias for frontend generators (same as create project)

Workspace compliance & CI

Bootstrap, analyze, readiness, pipeline, and autopilot release gates.

npm wrapper
npx rapidkit bootstrap [--profile <profile>] [--json] [--compliance-only]
npm wrapper
npx rapidkit setup <python|node|go|java|dotnet> [--warm-deps]
npm wrapper
npx rapidkit pipeline [--json] [--strict] [--skip-verify] [--skip-analyze] [--skip-autopilot] [--autopilot-mode <audit|safe-fix|enforce>]
npm wrapper
npx rapidkit analyze [--workspace <path>] [--json] [--strict] [--output <file>]
npm wrapper
npx rapidkit readiness [--json] [--strict] [--skip-verify]
npm wrapper
npx rapidkit autopilot release [--mode <audit|safe-fix|enforce>] [--json] [--output <file>] [--since <ref>] [--parallel] [--max-workers <n>]

Workspace intelligence

Model, context, diff, impact, verify, and agent sync artifacts in-repo.

npm wrapper
npx rapidkit workspace model [--json] [--write] [--strict]
npm wrapper
npx rapidkit workspace context --for-agent [codex|claude|cursor|orca] [--json] [--write] [--no-agent-sync]
npm wrapper
npx rapidkit workspace agent-sync [--write] [--refresh-context] [--strict] [--json] [--preset minimal|enterprise] [--target all|vscode|copilot,cursor,claude] [--experimental-hooks]
npm wrapper
npx rapidkit workspace snapshot [--json]
npm wrapper
npx rapidkit workspace diff --from <snapshot-or-report|git[:ref]> [--json]
npm wrapper
npx rapidkit workspace impact --from <snapshot-or-report> [--scope project:<name>] [--json]
npm wrapper
npx rapidkit workspace verify [--from-impact <file>] [--scope project:<name>] [--strict] [--json]
npm wrapper
npx rapidkit workspace explain [--json]
npm wrapper
npx rapidkit workspace trace [--from <path>] [--json]

Workspace contract & registry

Contract init, inspect, verify, graph, sync, policy, and foundation.

npm wrapper
npx rapidkit workspace sync [--json]
npm wrapper
npx rapidkit workspace policy show
npm wrapper
npx rapidkit workspace policy set <key> <value>
npm wrapper
npx rapidkit workspace list
npm wrapper
npx rapidkit workspace foundation ensure [--force] [--json]
npm wrapper
npx rapidkit workspace share [--output <file>] [--include-paths] [--no-doctor]
npm wrapper
npx rapidkit workspace contract init [--force] [--json]
npm wrapper
npx rapidkit workspace contract inspect [--json]
npm wrapper
npx rapidkit workspace contract verify [--strict] [--json]
npm wrapper
npx rapidkit workspace contract graph [--json]
npm wrapper
npx rapidkit workspace init

Workspace archive & hydrate

Portable archive export, inspect, verify, doctor, and hydrate.

npm wrapper
npx rapidkit workspace export --output team-workspace.rapidkit-archive.zip
npm wrapper
npx rapidkit workspace archive inspect team-workspace.rapidkit-archive.zip [--json]
npm wrapper
npx rapidkit workspace archive verify team-workspace.rapidkit-archive.zip [--strict] [--json]
npm wrapper
npx rapidkit workspace archive doctor team-workspace.rapidkit-archive.zip [--strict] [--json]
npm wrapper
npx rapidkit workspace hydrate team-workspace.rapidkit-archive.zip --output ./team-workspace

Adopt & import

Register existing repositories without moving source.

npm wrapper
npx rapidkit adopt [path] [--workspace <path>] [--name <project-name>] [--dry-run] [--json]
npm wrapper
npx rapidkit import <path|git-url> [--workspace <path>] [--name <project-name>] [--git] [--json]

Snapshots

Named workspace snapshots with restore and inspect.

npm wrapper
npx rapidkit snapshot create [name] [--include-projects] [--reason <text>] [--json]
npm wrapper
npx rapidkit snapshot list [--json]
npm wrapper
npx rapidkit snapshot inspect <name> [--json]
npm wrapper
npx rapidkit snapshot restore <name> [--dry-run] [--force] [--json]

Project lifecycle

Runtime-aware init, dev, test, build, and start — orchestrated by npm first.

npm wrapper
npx rapidkit project commands [--json]
npm wrapper
npx rapidkit commands --scope project [--json]
npm orchestrated
npx rapidkit init
npm orchestrated
npx rapidkit dev
npm orchestrated
npx rapidkit test
npm orchestrated
npx rapidkit build
npm orchestrated
npx rapidkit start
npm orchestrated
npx rapidkit lint
npm orchestrated
npx rapidkit format

Project archive lifecycle

Archive, list, restore, and delete projects inside a workspace.

npm wrapper
npx rapidkit project archive <name> [--reason <text>] [--dry-run] [--json]
npm wrapper
npx rapidkit project archives [--json]
npm wrapper
npx rapidkit project restore <archive> [--name <project-name>] [--force] [--dry-run] [--json]
npm wrapper
npx rapidkit project delete <name> [--permanent --confirm <name>] [--dry-run] [--json]

Doctor & health

Workspace and project health with optional fix plans.

npm wrapper
npx rapidkit doctor
npm wrapper
npx rapidkit doctor workspace [--json] [--strict] [--ci] [--fix] [--plan] [--apply]
npm wrapper
npx rapidkit doctor project [--json] [--strict] [--ci] [--fix] [--plan] [--apply]

Workspace fleet run

Orchestrate init, test, build, and start across projects.

npm wrapper
npx rapidkit workspace run <init|test|build|start> [--affected] [--blast-radius] [--since <ref>] [--parallel] [--max-workers <n>] [--strict] [--json]

Infrastructure sidecar

Docker Compose plan, up, down, and status for workspace infra.

npm wrapper
npx rapidkit infra plan [--workspace <path>] [--json] [--dry-run] [--verbose]
npm wrapper
npx rapidkit infra up [--workspace <path>] [--no-plan] [--build]
npm wrapper
npx rapidkit infra down [--workspace <path>] [--volumes]
npm wrapper
npx rapidkit infra status [--workspace <path>] [--json] [--strict]

Cache & mirror

Offline cache and vendor mirror maintenance.

npm wrapper
npx rapidkit cache <status|clear|prune|repair>
npm wrapper
npx rapidkit mirror <status|sync|verify|rotate>

AI (npm wrapper)

Module recommendations and embedding maintenance.

npm wrapper
npx rapidkit ai recommend [query] [-n, --number <count>] [--json]
npm wrapper
npx rapidkit ai info [--json]
npm wrapper
npx rapidkit ai generate-embeddings [--json]
npm wrapper
npx rapidkit ai update-embeddings [--json]

Config (npm wrapper)

User-level RapidKit CLI configuration.

npm wrapper
npx rapidkit config set-api-key [--key <key>]
npm wrapper
npx rapidkit config show
npm wrapper
npx rapidkit config remove-api-key
npm wrapper
npx rapidkit config ai <enable|disable|status>

Shell activation

Print shell activation snippets for workspace environments.

npm wrapper
npx rapidkit shell activate

Discovery & catalog

Command surfaces and engine catalog (create/list/info may delegate to Core).

npm wrapper
npx rapidkit commands [--scope workspace|project] [--json]
Core when supported
npx rapidkit list

Core catalog — may delegate

Core when supported
npx rapidkit info <module>

Core catalog — may delegate

Core when supported
npx rapidkit frameworks

Core catalog — may delegate

Core when supported
npx rapidkit license

Core catalog — may delegate

Core modules (delegated when Core-backed)

Available on FastAPI/NestJS Core-backed projects; blocked on npm-only runtimes.

Core when supported
npx rapidkit add module <module>
Core when supported
npx rapidkit modules list
Core when supported
npx rapidkit modules search <query>
Core when supported
npx rapidkit upgrade module <module>
Core when supported
npx rapidkit diff module <module>
Core when supported
npx rapidkit merge module <module>
Core when supported
npx rapidkit reconcile module <module>
Core when supported
npx rapidkit rollback module <module>
Core when supported
npx rapidkit uninstall module <module>
Core when supported
npx rapidkit checkpoint create [name]
Core when supported
npx rapidkit optimize module <module>

Source of truth: rapidkit-npm/docs/commands-reference.md