RapidKit
Back to Workspai CLI
Workspai npm CLI

Complete CLI Reference

Every documented npx workspai 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 workspai create

Prompt: workspace or project

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

Quick-start workspace alias

npm wrapper
npx workspai create project <kit> <name> [--yes] [--skip-install] [--skip-git] [--output <dir>]
alias
npx workspai 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 workspai bootstrap [--profile <profile>] [--json] [--compliance-only]
npm wrapper
npx workspai setup <python|node|go|java|dotnet> [--warm-deps]
npm wrapper
npx workspai pipeline [--json] [--strict] [--skip-verify] [--skip-analyze] [--skip-autopilot] [--autopilot-mode <audit|safe-fix|enforce>]
npm wrapper
npx workspai analyze [--workspace <path>] [--json] [--strict] [--output <file>]
npm wrapper
npx workspai readiness [--json] [--strict] [--skip-verify]
npm wrapper
npx workspai 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 workspai workspace model [--json] [--write] [--strict]
npm wrapper
npx workspai workspace context --for-agent [codex|claude|cursor|orca] [--json] [--write] [--no-agent-sync]
npm wrapper
npx workspai workspace agent-sync [--write] [--refresh-context] [--strict] [--json] [--preset minimal|enterprise] [--target all|vscode|copilot,cursor,claude] [--experimental-hooks]
npm wrapper
npx workspai workspace snapshot [--json]
npm wrapper
npx workspai workspace diff --from <snapshot-or-report|git[:ref]> [--json]
npm wrapper
npx workspai workspace impact --from <snapshot-or-report> [--scope project:<name>] [--json]
npm wrapper
npx workspai workspace verify [--from-impact <file>] [--scope project:<name>] [--strict] [--json]
npm wrapper
npx workspai workspace explain [--json]
npm wrapper
npx workspai workspace trace [--from <path>] [--json]

Workspace contract & registry

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

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

Workspace archive & hydrate

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

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

Adopt & import

Register existing repositories without moving source.

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

Snapshots

Named workspace snapshots with restore and inspect.

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

Project lifecycle

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

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

Project archive lifecycle

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

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

Doctor & health

Workspace and project health with optional fix plans.

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

Workspace fleet run

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

npm wrapper
npx workspai 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 workspai infra plan [--workspace <path>] [--json] [--dry-run] [--verbose]
npm wrapper
npx workspai infra up [--workspace <path>] [--no-plan] [--build]
npm wrapper
npx workspai infra down [--workspace <path>] [--volumes]
npm wrapper
npx workspai infra status [--workspace <path>] [--json] [--strict]

Cache & mirror

Offline cache and vendor mirror maintenance.

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

AI (npm wrapper)

Module recommendations and embedding maintenance.

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

Config (npm wrapper)

User-level Workspai CLI configuration.

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

Shell activation

Print shell activation snippets for workspace environments.

npm wrapper
npx workspai shell activate

Discovery & catalog

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

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

Core catalog — may delegate

Core when supported
npx workspai info <module>

Core catalog — may delegate

Core when supported
npx workspai frameworks

Core catalog — may delegate

Core when supported
npx workspai 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 workspai add module <module>
Core when supported
npx workspai modules list
Core when supported
npx workspai modules search <query>
Core when supported
npx workspai upgrade module <module>
Core when supported
npx workspai diff module <module>
Core when supported
npx workspai merge module <module>
Core when supported
npx workspai reconcile module <module>
Core when supported
npx workspai rollback module <module>
Core when supported
npx workspai uninstall module <module>
Core when supported
npx workspai checkpoint create [name]
Core when supported
npx workspai optimize module <module>

Source of truth: workspai/packages/cli/README.md