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.

Workspai CLI
npx workspai create

Prompt: workspace or project

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

Quick-start workspace alias

Workspai CLI
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.

Workspai CLI
npx workspai bootstrap [--profile <profile>] [--json] [--compliance-only]
Workspai CLI
npx workspai setup <python|node|go|java|dotnet> [--warm-deps]
Workspai CLI
npx workspai pipeline [--json] [--strict] [--skip-verify] [--skip-analyze] [--skip-autopilot] [--autopilot-mode <audit|safe-fix|enforce>]
Workspai CLI
npx workspai analyze [--workspace <path>] [--json] [--strict] [--output <file>]
Workspai CLI
npx workspai readiness [--json] [--strict] [--skip-verify]
Workspai CLI
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.

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

Workspace contract & registry

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

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

Workspace archive & hydrate

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

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

Adopt & import

Register existing repositories without moving source.

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

Snapshots

Named workspace snapshots with restore and inspect.

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

Project lifecycle

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

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

Project archive lifecycle

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

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

Doctor & health

Workspace and project health with optional fix plans.

Workspai CLI
npx workspai doctor
Workspai CLI
npx workspai doctor workspace [--json] [--strict] [--ci] [--fix] [--plan] [--apply]
Workspai CLI
npx workspai doctor project [--json] [--strict] [--ci] [--fix] [--plan] [--apply]

Workspace fleet run

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

Workspai CLI
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.

Workspai CLI
npx workspai infra plan [--workspace <path>] [--json] [--dry-run] [--verbose]
Workspai CLI
npx workspai infra up [--workspace <path>] [--no-plan] [--build]
Workspai CLI
npx workspai infra down [--workspace <path>] [--volumes]
Workspai CLI
npx workspai infra status [--workspace <path>] [--json] [--strict]

Cache & mirror

Offline cache and vendor mirror maintenance.

Workspai CLI
npx workspai cache <status|clear|prune|repair>
Workspai CLI
npx workspai mirror <status|sync|verify|rotate>

AI (Workspai CLI)

Module recommendations and embedding maintenance.

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

Config (Workspai CLI)

User-level Workspai CLI configuration.

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

Shell activation

Print shell activation snippets for workspace environments.

Workspai CLI
npx workspai shell activate

Discovery & catalog

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

Workspai CLI
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