Command capabilities / Capability contract
Runtime Command Surface V1
Defines the versioned runtime command surface v1 boundary used by Workspai and its consumers.
- Schema version
rapidkit-runtime-command-surface-v1- Contract path
contracts/runtime-command-surface.v1.json- Publication
- capability-contract
- Defined fields
- 247
- Artifact bindings
- 0
Why this contract exists
Architecture role
Publishes the supported CLI capability surface for documentation and external consumers.
Consumption boundary
- • Workspai CLI
- • Documentation portal
- • Extensions and adapters
Related commands
Commands are linked only when the runtime contract identifies a direct production relationship. Supporting contracts may be consumed without having a single producer command.
Produced artifacts
These durable files are emitted by registered commands and validated against this contract.
No canonical file artifact is registered for this contract. It may describe capabilities, embedded data, runtime exchange, or supporting state instead of a standalone report.
Field reference
Every declared schema property or published capability path is listed here. Required means the contract declares or publishes that field at the shown boundary.
| Field path | Type | Required | Meaning | Constraints |
|---|---|---|---|---|
| artifactContracts | array | Yes | Published artifactcontracts capability data. | — |
| artifactContracts[] | object | Yes | Published artifactcontracts[] capability data. | — |
| artifactContracts[].artifactPath | string | Yes | Published artifactpath capability data. | — |
| artifactContracts[].contractPath | string | Yes | Published contractpath capability data. | — |
| artifactContracts[].producerCommands | array | Yes | Published producercommands capability data. | — |
| artifactContracts[].producerCommands[] | array | Yes | Published producercommands[] capability data. | — |
| artifactContracts[].producerCommands[][] | string | Yes | Published producercommands[][] capability data. | — |
| artifactContracts[].schemaVersion | string | number | Yes | Published schemaversion capability data. | — |
| commandDocumentation | array | Yes | Published commanddocumentation capability data. | — |
| commandDocumentation[] | object | Yes | Published commanddocumentation[] capability data. | — |
| commandDocumentation[].canonicalArgv | array | Yes | Published canonicalargv capability data. | — |
| commandDocumentation[].canonicalArgv[] | string | Yes | Published canonicalargv[] capability data. | — |
| commandDocumentation[].exitSemantics | object | Yes | Published exitsemantics capability data. | — |
| commandDocumentation[].exitSemantics.default | string | Yes | Published default capability data. | — |
| commandDocumentation[].exitSemantics.failure | string | Yes | Published failure capability data. | — |
| commandDocumentation[].exitSemantics.strict | string | Yes | Published strict capability data. | — |
| commandDocumentation[].input | object | Yes | Published input capability data. | — |
| commandDocumentation[].input.contractPath | string | Yes | Published contractpath capability data. | — |
| commandDocumentation[].input.mediaType | string | Yes | Published mediatype capability data. | — |
| commandDocumentation[].input.required | boolean | Yes | Published required capability data. | — |
| commandDocumentation[].input.schemaVersion | string | Yes | Published schemaversion capability data. | — |
| commandDocumentation[].input.transport | string | Yes | Published transport capability data. | — |
| commandDocumentation[].invocation | string | Yes | Published invocation capability data. | — |
| commandDocumentation[].output | object | Yes | Published output capability data. | — |
| commandDocumentation[].output.defaultFormat | string | Yes | Published defaultformat capability data. | — |
| commandDocumentation[].output.modes | array | Yes | Published modes capability data. | — |
| commandDocumentation[].output.modes[] | object | Yes | Published modes[] capability data. | — |
| commandDocumentation[].output.modes[].format | string | Yes | Published format capability data. | — |
| commandDocumentation[].output.modes[].mediaType | string | Yes | Published mediatype capability data. | — |
| commandDocumentation[].output.modes[].selector | string | Yes | Published selector capability data. | — |
| commandDocumentation[].summary | string | Yes | Published summary capability data. | — |
| coreProjectCommands | array | Yes | Published coreprojectcommands capability data. | — |
| coreProjectCommands[] | string | Yes | Published coreprojectcommands[] capability data. | — |
| createPlanner | object | Yes | Published createplanner capability data. | — |
| createPlanner.existingRuntimeSignals | array | Yes | Published existingruntimesignals capability data. | — |
| createPlanner.existingRuntimeSignals[] | string | Yes | Published existingruntimesignals[] capability data. | — |
| createPlanner.lanes | object | Yes | Published lanes capability data. | — |
| createPlanner.lanes.existing | object | Yes | Published existing capability data. | — |
| createPlanner.lanes.existing.meaning | string | Yes | Published meaning capability data. | — |
| createPlanner.lanes.existing.status | string | Yes | Published status capability data. | — |
| createPlanner.lanes.native | object | Yes | Published native capability data. | — |
| createPlanner.lanes.native.meaning | string | Yes | Published meaning capability data. | — |
| createPlanner.lanes.native.status | string | Yes | Published status capability data. | — |
| createPlanner.lanes.official | object | Yes | Published official capability data. | — |
| createPlanner.lanes.official.meaning | string | Yes | Published meaning capability data. | — |
| createPlanner.lanes.official.status | string | Yes | Published status capability data. | — |
| createPlanner.nativeCreateKits | array | Yes | Published nativecreatekits capability data. | — |
| createPlanner.nativeCreateKits[] | string | Yes | Published nativecreatekits[] capability data. | — |
| createPlanner.officialCreate | array | Yes | Published officialcreate capability data. | — |
| createPlanner.officialCreate[] | string | Yes | Published officialcreate[] capability data. | — |
| globalCommands | array | Yes | Published globalcommands capability data. | — |
| globalCommands[] | string | Yes | Published globalcommands[] capability data. | — |
| jsonOperationResult | object | Yes | Published jsonoperationresult capability data. | — |
| jsonOperationResult.contractPath | string | Yes | Published contractpath capability data. | — |
| jsonOperationResult.schemaVersion | string | Yes | Published schemaversion capability data. | — |
| lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| moduleMutationCommands | array | Yes | Published modulemutationcommands capability data. | — |
| moduleMutationCommands[] | string | Yes | Published modulemutationcommands[] capability data. | — |
| moduleSuggestionFrameworks | array | Yes | Published modulesuggestionframeworks capability data. | — |
| moduleSuggestionFrameworks[] | string | Yes | Published modulesuggestionframeworks[] capability data. | — |
| moduleUnsupportedFrameworks | array | Yes | Published moduleunsupportedframeworks capability data. | — |
| moduleUnsupportedFrameworks[] | string | Yes | Published moduleunsupportedframeworks[] capability data. | — |
| npmOwnedScopedCommands | array | Yes | Published npmownedscopedcommands capability data. | — |
| npmOwnedScopedCommands[] | array | Yes | Published npmownedscopedcommands[] capability data. | — |
| npmOwnedScopedCommands[][] | string | Yes | Published npmownedscopedcommands[][] capability data. | — |
| npmOwnedTopLevelCommands | array | Yes | Published npmownedtoplevelcommands capability data. | — |
| npmOwnedTopLevelCommands[] | string | Yes | Published npmownedtoplevelcommands[] capability data. | — |
| runtimeMatrix | object | Yes | Published runtimematrix capability data. | — |
| runtimeMatrix.bun | object | Yes | Published bun capability data. | — |
| runtimeMatrix.bun.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.bun.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.bun.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.bun.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.bun.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.bun.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.bun.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.c | object | Yes | Published c capability data. | — |
| runtimeMatrix.c.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.c.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.c.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.c.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.c.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.c.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.c.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.clojure | object | Yes | Published clojure capability data. | — |
| runtimeMatrix.clojure.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.clojure.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.clojure.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.clojure.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.clojure.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.clojure.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.clojure.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.cpp | object | Yes | Published cpp capability data. | — |
| runtimeMatrix.cpp.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.cpp.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.cpp.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.cpp.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.cpp.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.cpp.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.cpp.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.deno | object | Yes | Published deno capability data. | — |
| runtimeMatrix.deno.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.deno.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.deno.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.deno.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.deno.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.deno.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.deno.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.dotnet | object | Yes | Published dotnet capability data. | — |
| runtimeMatrix.dotnet.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.dotnet.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.dotnet.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.dotnet.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.dotnet.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.dotnet.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.dotnet.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.elixir | object | Yes | Published elixir capability data. | — |
| runtimeMatrix.elixir.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.elixir.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.elixir.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.elixir.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.elixir.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.elixir.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.elixir.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.go | object | Yes | Published go capability data. | — |
| runtimeMatrix.go.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.go.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.go.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.go.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.go.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.go.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.go.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.java | object | Yes | Published java capability data. | — |
| runtimeMatrix.java.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.java.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.java.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.java.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.java.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.java.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.java.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.kotlin | object | Yes | Published kotlin capability data. | — |
| runtimeMatrix.kotlin.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.kotlin.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.kotlin.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.kotlin.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.kotlin.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.kotlin.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.kotlin.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.node | object | Yes | Published node capability data. | — |
| runtimeMatrix.node.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.node.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.node.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.node.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.node.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.node.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.node.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.php | object | Yes | Published php capability data. | — |
| runtimeMatrix.php.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.php.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.php.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.php.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.php.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.php.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.php.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.python | object | Yes | Published python capability data. | — |
| runtimeMatrix.python.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.python.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.python.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.python.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.python.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.python.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.python.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.ruby | object | Yes | Published ruby capability data. | — |
| runtimeMatrix.ruby.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.ruby.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.ruby.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.ruby.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.ruby.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.ruby.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.ruby.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.rust | object | Yes | Published rust capability data. | — |
| runtimeMatrix.rust.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.rust.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.rust.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.rust.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.rust.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.rust.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.rust.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.scala | object | Yes | Published scala capability data. | — |
| runtimeMatrix.scala.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.scala.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.scala.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.scala.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.scala.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.scala.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.scala.tier | string | Yes | Published tier capability data. | — |
| runtimeMatrix.unknown | object | Yes | Published unknown capability data. | — |
| runtimeMatrix.unknown.doctor | string | Yes | Published doctor capability data. | — |
| runtimeMatrix.unknown.import | boolean | Yes | Published import capability data. | — |
| runtimeMatrix.unknown.lifecycleCommands | array | Yes | Published lifecyclecommands capability data. | — |
| runtimeMatrix.unknown.lifecycleCommands[] | string | Yes | Published lifecyclecommands[] capability data. | — |
| runtimeMatrix.unknown.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| runtimeMatrix.unknown.scaffold | boolean | Yes | Published scaffold capability data. | — |
| runtimeMatrix.unknown.tier | string | Yes | Published tier capability data. | — |
| scaffoldKits | array | Yes | Published scaffoldkits capability data. | — |
| scaffoldKits[] | string | Yes | Published scaffoldkits[] capability data. | — |
| schemaVersion | string | Yes | Published schemaversion capability data. | — |
| universalCommands | array | Yes | Published universalcommands capability data. | — |
| universalCommands[] | string | Yes | Published universalcommands[] capability data. | — |
| workspaceActions | array | Yes | Published workspaceactions capability data. | — |
| workspaceActions[] | object | Yes | Published workspaceactions[] capability data. | — |
| workspaceActions[].artifact | null | string | Yes | Published artifact capability data. | — |
| workspaceActions[].examples | array | Yes | Published examples capability data. | — |
| workspaceActions[].examples[] | string | Yes | Published examples[] capability data. | — |
| workspaceActions[].id | string | Yes | Published id capability data. | — |
| workspaceActions[].options | array | Yes | Published options capability data. | — |
| workspaceActions[].options[] | object | Yes | Published options[] capability data. | — |
| workspaceActions[].options[].description | string | Yes | Published description capability data. | — |
| workspaceActions[].options[].flag | string | Yes | Published flag capability data. | — |
| workspaceActions[].subactions | array | Yes | Published subactions capability data. | — |
| workspaceActions[].subactions[] | string | Yes | Published subactions[] capability data. | — |
| workspaceActions[].summary | string | Yes | Published summary capability data. | — |
| workspaceActions[].usage | string | Yes | Published usage capability data. | — |
| workspaceArchive | object | Yes | Published workspacearchive capability data. | — |
| workspaceArchive.commands | array | Yes | Published commands capability data. | — |
| workspaceArchive.commands[] | string | Yes | Published commands[] capability data. | — |
| workspaceArchive.contractPath | string | Yes | Published contractpath capability data. | — |
| workspaceArchive.flags | array | Yes | Published flags capability data. | — |
| workspaceArchive.flags[] | string | Yes | Published flags[] capability data. | — |
| workspaceArchive.schemaVersion | string | Yes | Published schemaversion capability data. | — |
| workspaceIntelligenceExecution | array | Yes | Published workspaceintelligenceexecution capability data. | — |
| workspaceIntelligenceExecution[] | object | Yes | Published workspaceintelligenceexecution[] capability data. | — |
| workspaceIntelligenceExecution[].argv | array | Yes | Published argv capability data. | — |
| workspaceIntelligenceExecution[].argv[] | string | Yes | Published argv[] capability data. | — |
| workspaceIntelligenceExecution[].id | string | Yes | Published id capability data. | — |
| workspaceIntelligenceExecution[].produces | array | Yes | Published produces capability data. | — |
| workspaceIntelligenceExecution[].produces[] | object | Yes | Published produces[] capability data. | — |
| workspaceIntelligenceExecution[].produces[].contractPath | string | null | Yes | Published contractpath capability data. | — |
| workspaceIntelligenceExecution[].produces[].path | string | Yes | Published path capability data. | — |
| workspaceIntelligenceExecution[].produces[].schemaVersion | string | null | Yes | Published schemaversion capability data. | — |
| workspaceIntelligenceRootCommands | array | Yes | Published workspaceintelligencerootcommands capability data. | — |
| workspaceIntelligenceRootCommands[] | string | Yes | Published workspaceintelligencerootcommands[] capability data. | — |
| workspaceIntelligenceSubcommands | array | Yes | Published workspaceintelligencesubcommands capability data. | — |
| workspaceIntelligenceSubcommands[] | string | Yes | Published workspaceintelligencesubcommands[] capability data. | — |
| workspaceSubcommands | array | Yes | Published workspacesubcommands capability data. | — |
| workspaceSubcommands[] | string | Yes | Published workspacesubcommands[] capability data. | — |
Canonical machine-readable definition
The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.
Show raw JSON
{
"schemaVersion": "rapidkit-runtime-command-surface-v1",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
],
"moduleMutationCommands": [
"add",
"modules",
"upgrade",
"diff",
"merge",
"reconcile",
"rollback",
"uninstall",
"checkpoint",
"snapshot",
"optimize"
],
"globalCommands": [
"create",
"list",
"info",
"frameworks",
"license"
],
"universalCommands": [
"version",
"commands",
"doctor",
"project"
],
"coreProjectCommands": [
"docs"
],
"npmOwnedTopLevelCommands": [
"analyze",
"readiness",
"doctor",
"workspace",
"autopilot",
"pipeline",
"import",
"adopt",
"goal",
"agent",
"snapshot",
"bootstrap",
"setup",
"cache",
"mirror",
"ai",
"config",
"product",
"infra",
"shell",
"commands",
"create",
"project"
],
"npmOwnedScopedCommands": [
[
"ai",
"generate-embeddings"
],
[
"ai",
"info"
],
[
"ai",
"recommend"
],
[
"ai",
"update-embeddings"
],
[
"agent",
"bootstrap"
],
[
"config",
"ai"
],
[
"config",
"remove-api-key"
],
[
"config",
"set-api-key"
],
[
"config",
"show"
],
[
"infra",
"down"
],
[
"infra",
"plan"
],
[
"infra",
"status"
],
[
"infra",
"up"
],
[
"product",
"manifest"
],
[
"product",
"manifest",
"create"
],
[
"product",
"plan"
],
[
"project",
"commands"
],
[
"project",
"agent-entry"
],
[
"project",
"coverage"
],
[
"project",
"workspace"
],
[
"project",
"archives"
],
[
"project",
"archive"
],
[
"project",
"restore"
],
[
"project",
"delete"
],
[
"snapshot",
"create"
],
[
"snapshot",
"inspect"
],
[
"snapshot",
"list"
],
[
"snapshot",
"restore"
]
],
"commandDocumentation": [
{
"invocation": "add",
"summary": "Add a supported module or capability to the active project through its runtime adapter.",
"canonicalArgv": [
"add"
]
},
{
"invocation": "adopt",
"summary": "Register an existing local repository as a governed Workspai project without recreating its source.",
"canonicalArgv": [
"adopt"
]
},
{
"invocation": "agent",
"summary": "Resolve portable project entry contracts and issue canonical-first grounding receipts for coding agents.",
"canonicalArgv": [
"agent"
]
},
{
"invocation": "agent bootstrap",
"summary": "Validate host discovery, workspace membership, evidence freshness, live inputs, and active Goal bindings before broad source discovery.",
"canonicalArgv": [
"agent",
"bootstrap"
]
},
{
"invocation": "ai",
"summary": "Manage AI configuration, recommendations, and embedding operations for the active workspace.",
"canonicalArgv": [
"ai"
]
},
{
"invocation": "ai generate-embeddings",
"summary": "Generate the initial semantic embedding index from the current project or workspace sources.",
"canonicalArgv": [
"ai",
"generate-embeddings"
]
},
{
"invocation": "ai info",
"summary": "Report the active AI provider, model, and embedding configuration.",
"canonicalArgv": [
"ai",
"info"
]
},
{
"invocation": "ai recommend",
"summary": "Recommend relevant modules or actions from the detected project context and configured AI provider.",
"canonicalArgv": [
"ai",
"recommend"
]
},
{
"invocation": "ai update-embeddings",
"summary": "Refresh the semantic embedding index after source or workspace context changes.",
"canonicalArgv": [
"ai",
"update-embeddings"
]
},
{
"invocation": "analyze",
"summary": "Evaluate workspace evidence and produce governance findings for downstream readiness and release decisions.",
"canonicalArgv": [
"analyze"
]
},
{
"invocation": "analyze --json",
"summary": "Emit the workspace analysis result as structured JSON for CI and contract-aware consumers.",
"canonicalArgv": [
"analyze",
"--json"
]
},
{
"invocation": "autopilot",
"summary": "Coordinate supported automated governance actions while preserving explicit evidence and release gates.",
"canonicalArgv": [
"autopilot"
]
},
{
"invocation": "autopilot release",
"summary": "Build a governed release proposal from current analysis, readiness, and verification evidence.",
"canonicalArgv": [
"autopilot",
"release"
]
},
{
"invocation": "bootstrap",
"summary": "Establish the selected workspace profile, toolchain, and dependency baseline before project execution.",
"canonicalArgv": [
"bootstrap"
]
},
{
"invocation": "build",
"summary": "Run the detected project build lifecycle through the owning runtime adapter.",
"canonicalArgv": [
"build"
]
},
{
"invocation": "cache",
"summary": "Inspect or clear Workspai cache entries used by workspace and project operations.",
"canonicalArgv": [
"cache"
]
},
{
"invocation": "checkpoint",
"summary": "Capture a named project or workspace checkpoint that can anchor later comparison or recovery.",
"canonicalArgv": [
"checkpoint"
]
},
{
"invocation": "commands",
"summary": "Publish the installed CLI command inventory, ownership boundaries, aliases, options, and integrity verdict.",
"canonicalArgv": [
"commands"
]
},
{
"invocation": "config",
"summary": "Manage persisted Workspai CLI and provider configuration for the current user environment.",
"canonicalArgv": [
"config"
]
},
{
"invocation": "config ai",
"summary": "Inspect or update the active AI provider, model, and embedding configuration.",
"canonicalArgv": [
"config",
"ai"
]
},
{
"invocation": "config remove-api-key",
"summary": "Remove a persisted provider API key from Workspai configuration.",
"canonicalArgv": [
"config",
"remove-api-key"
]
},
{
"invocation": "config set-api-key",
"summary": "Store a provider API key for authenticated AI operations.",
"canonicalArgv": [
"config",
"set-api-key"
]
},
{
"invocation": "config show",
"summary": "Display the effective Workspai configuration with secret values protected.",
"canonicalArgv": [
"config",
"show"
]
},
{
"invocation": "create",
"summary": "Create a supported workspace, project, or module through the canonical planner and generator boundary.",
"canonicalArgv": [
"create"
]
},
{
"invocation": "dev",
"summary": "Run the detected project development lifecycle with its runtime-specific development command.",
"canonicalArgv": [
"dev"
]
},
{
"invocation": "diff",
"summary": "Compare governed project state against a selected baseline and report the observed changes.",
"canonicalArgv": [
"diff"
]
},
{
"invocation": "docs",
"summary": "Generate or validate documentation through the detected project documentation lifecycle.",
"canonicalArgv": [
"docs"
]
},
{
"invocation": "doctor",
"summary": "Diagnose the active project or workspace and produce actionable findings with evidence-backed remediation guidance.",
"canonicalArgv": [
"doctor"
]
},
{
"invocation": "doctor capabilities --validate --write",
"summary": "Validate every registered Doctor adapter and persist the governed capability and validation artifacts in the selected workspace.",
"canonicalArgv": [
"doctor",
"capabilities",
"--validate",
"--write"
]
},
{
"invocation": "doctor capabilities --write",
"summary": "Persist the canonical Doctor capability matrix as a governed workspace artifact.",
"canonicalArgv": [
"doctor",
"capabilities",
"--write"
]
},
{
"invocation": "doctor project",
"summary": "Diagnose the current project and emit structured project evidence.",
"canonicalArgv": [
"doctor",
"project"
]
},
{
"invocation": "doctor workspace",
"summary": "Diagnose cross-project workspace health, contracts, policies, toolchains, and operational evidence.",
"canonicalArgv": [
"doctor",
"workspace"
]
},
{
"invocation": "doctor workspace --json",
"summary": "Emit workspace Doctor findings as structured evidence for verification and automation consumers.",
"canonicalArgv": [
"doctor",
"workspace",
"--json"
]
},
{
"invocation": "format",
"summary": "Run the detected project formatter while respecting workspace policy and runtime ownership.",
"canonicalArgv": [
"format"
]
},
{
"invocation": "frameworks",
"summary": "List scaffold frameworks and kits currently supported by the installed CLI.",
"canonicalArgv": [
"frameworks"
]
},
{
"invocation": "goal",
"summary": "Compile a plain-language engineering intent into a scope-bound, evidence-pinned Goal Pack and portable agent handoff without mutating source.",
"canonicalArgv": [
"goal",
"<intent>",
"--json"
],
"output": {
"defaultFormat": "human-or-json",
"modes": [
{
"selector": "--json",
"format": "json",
"mediaType": "application/json"
}
]
},
"exitSemantics": {
"default": "A contract-valid Goal Pack returns exit code 0, including explicit needs-confirmation, needs-evidence, or blocked planning states.",
"strict": "Not applicable; Goal planning does not execute or verify source changes.",
"failure": "Resolution, freshness, contract, integrity, or publication failure returns exit code 1."
}
},
{
"invocation": "help",
"summary": "Display contextual CLI usage, arguments, options, and command discovery guidance.",
"canonicalArgv": [
"help"
]
},
{
"invocation": "import",
"summary": "Copy or clone an existing project into the workspace and register its detected runtime capabilities.",
"canonicalArgv": [
"import"
]
},
{
"invocation": "info",
"summary": "Report detected project, runtime, workspace, and toolchain information for the current scope.",
"canonicalArgv": [
"info"
]
},
{
"invocation": "infra",
"summary": "Manage governed infrastructure planning and lifecycle operations for the active workspace.",
"canonicalArgv": [
"infra"
]
},
{
"invocation": "infra down",
"summary": "Stop the workspace infrastructure stack and optionally remove governed volumes.",
"canonicalArgv": [
"infra",
"down"
]
},
{
"invocation": "infra plan",
"summary": "Generate a versioned infrastructure plan without applying infrastructure changes.",
"canonicalArgv": [
"infra",
"plan"
]
},
{
"invocation": "infra status",
"summary": "Inspect infrastructure service state and expose a strict machine-checkable status verdict.",
"canonicalArgv": [
"infra",
"status"
]
},
{
"invocation": "infra up",
"summary": "Start the workspace infrastructure stack from its governed configuration.",
"canonicalArgv": [
"infra",
"up"
]
},
{
"invocation": "init",
"summary": "Initialize dependencies and required setup for the active project or complete workspace scope.",
"canonicalArgv": [
"init"
]
},
{
"invocation": "license",
"summary": "Inspect or validate the effective Workspai license and feature entitlement state.",
"canonicalArgv": [
"license"
]
},
{
"invocation": "lint",
"summary": "Run the detected project lint lifecycle under workspace compatibility and policy gates.",
"canonicalArgv": [
"lint"
]
},
{
"invocation": "list",
"summary": "List detected or registered resources for the current command scope.",
"canonicalArgv": [
"list"
]
},
{
"invocation": "merge",
"summary": "Combine supported governed configuration or project state through the owning runtime operation.",
"canonicalArgv": [
"merge"
]
},
{
"invocation": "mirror",
"summary": "Manage local package or dependency mirrors used by offline and controlled development workflows.",
"canonicalArgv": [
"mirror"
]
},
{
"invocation": "mirror status",
"summary": "Inspect mirror configuration, lock state, and cached artifact inventory.",
"canonicalArgv": [
"mirror",
"status"
]
},
{
"invocation": "mirror sync",
"summary": "Synchronize governed mirror artifacts and publish integrity evidence.",
"canonicalArgv": [
"mirror",
"sync"
]
},
{
"invocation": "modules",
"summary": "List supported project modules and their runtime-specific capability state.",
"canonicalArgv": [
"modules"
]
},
{
"invocation": "optimize",
"summary": "Apply supported project optimization operations through the detected runtime adapter.",
"canonicalArgv": [
"optimize"
]
},
{
"invocation": "pipeline",
"summary": "Run the governance pipeline from sync and diagnostics through analysis, readiness, verification, and optional release automation.",
"canonicalArgv": [
"pipeline",
"--json"
],
"output": {
"defaultFormat": "human-or-json",
"modes": [
{
"selector": "--json",
"format": "json",
"mediaType": "application/json"
}
]
},
"exitSemantics": {
"default": "Warning-only pipeline reports are advisory and return exit code 0.",
"strict": "With --strict, warning-only pipeline reports return a non-zero exit code.",
"failure": "Execution failures and failed stages return a non-zero exit code in every mode."
}
},
{
"invocation": "product",
"summary": "Manage governed product manifests and factory planning operations.",
"canonicalArgv": [
"product"
]
},
{
"invocation": "product manifest",
"summary": "Inspect or create the product manifest that defines product factory inputs.",
"canonicalArgv": [
"product",
"manifest"
]
},
{
"invocation": "product manifest create",
"summary": "Create a governed product manifest for product planning operations.",
"canonicalArgv": [
"product",
"manifest",
"create"
]
},
{
"invocation": "product plan",
"summary": "Generate a product factory plan from the current product definition.",
"canonicalArgv": [
"product",
"plan"
]
},
{
"invocation": "project",
"summary": "Expose project-scoped command discovery, archive, restore, and deletion operations.",
"canonicalArgv": [
"project"
]
},
{
"invocation": "project agent-entry",
"summary": "Verify portable entry adapters and canonical evidence bindings for one or every supported agent host.",
"canonicalArgv": [
"project",
"agent-entry"
]
},
{
"invocation": "project archive",
"summary": "Move a project into governed archive storage while preserving registry metadata and recovery evidence.",
"canonicalArgv": [
"project",
"archive"
]
},
{
"invocation": "project archives",
"summary": "List governed project archives and their available restoration metadata.",
"canonicalArgv": [
"project",
"archives"
]
},
{
"invocation": "project commands",
"summary": "Discover commands supported by the selected project runtime and its current capability tier.",
"canonicalArgv": [
"project",
"commands"
]
},
{
"invocation": "project coverage",
"summary": "Run or inspect runtime-native test coverage and publish normalized, project-scoped evidence against an explicit target.",
"canonicalArgv": [
"project",
"coverage"
]
},
{
"invocation": "project delete",
"summary": "Delete a registered project through guarded workspace safety and recovery checks.",
"canonicalArgv": [
"project",
"delete"
]
},
{
"invocation": "project restore",
"summary": "Restore an archived project to its workspace path and reconcile registry ownership.",
"canonicalArgv": [
"project",
"restore"
]
},
{
"invocation": "project workspace",
"summary": "Resolve or repair the machine-local binding from the current project to its canonical Workspai workspace.",
"canonicalArgv": [
"project",
"workspace"
]
},
{
"invocation": "project workspace relink",
"summary": "Rebuild the machine-local project binding after validating canonical workspace contract membership.",
"canonicalArgv": [
"project",
"workspace",
"relink"
]
},
{
"invocation": "readiness",
"summary": "Evaluate whether current workspace evidence satisfies release-readiness requirements and blockers.",
"canonicalArgv": [
"readiness"
]
},
{
"invocation": "readiness --json --skip-verify",
"summary": "Refresh pre-verification readiness evidence without consuming a verify artifact from an earlier chain run.",
"canonicalArgv": [
"readiness",
"--json",
"--skip-verify"
]
},
{
"invocation": "reconcile",
"summary": "Reconcile detected project or workspace state with its governed metadata and registered configuration.",
"canonicalArgv": [
"reconcile"
]
},
{
"invocation": "rollback",
"summary": "Restore supported generated or governed state to the previous recorded operation boundary.",
"canonicalArgv": [
"rollback"
]
},
{
"invocation": "setup",
"summary": "Install or validate runtime-specific prerequisites required by the selected workspace profile.",
"canonicalArgv": [
"setup"
]
},
{
"invocation": "shell",
"summary": "Open a workspace-aware shell with resolved project, runtime, and toolchain context.",
"canonicalArgv": [
"shell"
]
},
{
"invocation": "snapshot",
"summary": "Manage governed workspace recovery snapshots independently from Workspace Intelligence model baselines.",
"canonicalArgv": [
"snapshot"
]
},
{
"invocation": "snapshot create",
"summary": "Create a governed workspace snapshot for comparison or recovery.",
"canonicalArgv": [
"snapshot",
"create"
]
},
{
"invocation": "snapshot inspect",
"summary": "Inspect snapshot metadata, contents, and recovery compatibility without restoring it.",
"canonicalArgv": [
"snapshot",
"inspect"
]
},
{
"invocation": "snapshot list",
"summary": "List governed workspace snapshots available for inspection or recovery.",
"canonicalArgv": [
"snapshot",
"list"
]
},
{
"invocation": "snapshot restore",
"summary": "Restore a governed snapshot through the workspace recovery boundary.",
"canonicalArgv": [
"snapshot",
"restore"
]
},
{
"invocation": "start",
"summary": "Run the detected project production or service-start lifecycle command.",
"canonicalArgv": [
"start"
]
},
{
"invocation": "test",
"summary": "Run the detected project test lifecycle under workspace compatibility and policy gates.",
"canonicalArgv": [
"test"
]
},
{
"invocation": "uninstall",
"summary": "Remove a supported module, tool, or generated integration through its owning operation.",
"canonicalArgv": [
"uninstall"
]
},
{
"invocation": "upgrade",
"summary": "Upgrade supported Workspai-managed dependencies or generated project capabilities.",
"canonicalArgv": [
"upgrade"
]
},
{
"invocation": "version",
"summary": "Report the installed CLI version and published contract compatibility metadata.",
"canonicalArgv": [
"version"
]
},
{
"invocation": "workspace",
"summary": "Dispatch workspace discovery, intelligence, governance, portability, and fleet lifecycle operations.",
"canonicalArgv": [
"workspace"
]
},
{
"invocation": "workspace agent-sync",
"summary": "Project current workspace context into governed agent instructions, reports, skills, and integration files.",
"canonicalArgv": [
"workspace",
"agent-sync"
]
},
{
"invocation": "workspace agent-sync --write",
"summary": "Publish the governed agent surface generation as a recoverable workspace transaction.",
"canonicalArgv": [
"workspace",
"agent-sync",
"--write"
]
},
{
"invocation": "workspace agent-sync --write --json --preset enterprise",
"summary": "Generate the enterprise agent-grounding pack, persist every governed artifact, and emit a structured result.",
"canonicalArgv": [
"workspace",
"agent-sync",
"--write",
"--json",
"--preset",
"enterprise"
]
},
{
"invocation": "workspace archive",
"summary": "Create or inspect a governed workspace archive.",
"canonicalArgv": [
"workspace",
"archive"
]
},
{
"invocation": "workspace connect",
"summary": "Register and reconcile an existing workspace in place.",
"canonicalArgv": [
"workspace",
"connect"
]
},
{
"invocation": "workspace context",
"summary": "Build a scoped workspace context projection from the current model and evidence for human or agent consumption.",
"canonicalArgv": [
"workspace",
"context"
]
},
{
"invocation": "workspace context --for-agent --json --write --no-agent-sync",
"summary": "Persist structured agent context without mutating downstream agent instruction surfaces.",
"canonicalArgv": [
"workspace",
"context",
"--for-agent",
"--json",
"--write",
"--no-agent-sync"
]
},
{
"invocation": "workspace contract",
"summary": "Inspect and verify explicit workspace contracts.",
"canonicalArgv": [
"workspace",
"contract"
]
},
{
"invocation": "workspace contract sync",
"summary": "Reconcile discovered projects into the canonical workspace contract and registry summary.",
"canonicalArgv": [
"workspace",
"contract",
"sync"
]
},
{
"invocation": "workspace contract verify --strict --json",
"summary": "Strictly validate workspace contracts and emit a structured evidence artifact that blocks on violations.",
"canonicalArgv": [
"workspace",
"contract",
"verify",
"--strict",
"--json"
]
},
{
"invocation": "workspace diff",
"summary": "Compare the current canonical workspace model with a snapshot or source-control baseline.",
"canonicalArgv": [
"workspace",
"diff"
]
},
{
"invocation": "workspace diff --from .workspai/reports/workspace-model-snapshot.json --json",
"summary": "Compute structured model changes from the canonical snapshot artifact for downstream impact analysis.",
"canonicalArgv": [
"workspace",
"diff",
"--from",
".workspai/reports/workspace-model-snapshot.json",
"--json"
]
},
{
"invocation": "workspace eval",
"summary": "Measure model usage, agent activity, cost provenance, and verified task outcomes without storing prompt or response bodies.",
"canonicalArgv": [
"workspace",
"eval",
"status",
"--json"
],
"input": {
"transport": "stdin",
"mediaType": "application/json",
"required": false,
"schemaVersion": "model-usage-event.v1",
"contractPath": "contracts/workspace-intelligence/model-usage-event.v1.json"
},
"output": {
"defaultFormat": "human-or-json",
"modes": [
{
"selector": "init <task> [strategy] --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "record --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "status --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "report --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "compare --from <report> --json",
"format": "json",
"mediaType": "application/json"
}
]
}
},
{
"invocation": "workspace eval init",
"summary": "Initialize one live, versioned Workspace Intelligence evaluation run for a fixed task and retrieval strategy.",
"canonicalArgv": [
"workspace",
"eval",
"init"
]
},
{
"invocation": "workspace eval record --json",
"summary": "Validate one privacy-bounded usage or outcome event from stdin and append it to the live evaluation artifact.",
"canonicalArgv": [
"workspace",
"eval",
"record",
"--json"
]
},
{
"invocation": "workspace eval report --json",
"summary": "Finalize the live evaluation into an authoritative last-run report for IDE, CI, and comparison consumers.",
"canonicalArgv": [
"workspace",
"eval",
"report",
"--json"
]
},
{
"invocation": "workspace explain",
"summary": "Explain a workspace relationship, project, or blocker from traceable model and evidence references.",
"canonicalArgv": [
"workspace",
"explain"
]
},
{
"invocation": "workspace explain release-blocked --json --write",
"summary": "Persist a structured explanation of release blockers and the evidence that caused the verdict.",
"canonicalArgv": [
"workspace",
"explain",
"release-blocked",
"--json",
"--write"
]
},
{
"invocation": "workspace export",
"summary": "Export workspace intelligence into a portable consumer representation.",
"canonicalArgv": [
"workspace",
"export"
]
},
{
"invocation": "workspace feedback",
"summary": "Record structured feedback about Workspace Intelligence output.",
"canonicalArgv": [
"workspace",
"feedback",
"record",
"--json"
],
"input": {
"transport": "stdin",
"mediaType": "application/json",
"required": true,
"schemaVersion": "agent-action-outcome.v1",
"contractPath": "contracts/workspace-intelligence/agent-action-outcome.v1.json"
},
"output": {
"defaultFormat": "human-or-json",
"modes": [
{
"selector": "--json",
"format": "json",
"mediaType": "application/json"
}
]
}
},
{
"invocation": "workspace feedback record --json",
"summary": "Validate an agent action outcome from stdin and append it to governed Workspace Intelligence history.",
"canonicalArgv": [
"workspace",
"feedback",
"record",
"--json"
]
},
{
"invocation": "workspace foundation",
"summary": "Inspect or establish the foundational metadata required by workspace operations.",
"canonicalArgv": [
"workspace",
"foundation"
]
},
{
"invocation": "workspace goal",
"summary": "Plan, resume, and evidence-verify a durable engineering goal with explicit scope, constraints, and success criteria.",
"canonicalArgv": [
"workspace",
"goal"
]
},
{
"invocation": "workspace goal plan",
"summary": "Create or deterministically resume a goal contract and capture its current baseline.",
"canonicalArgv": [
"workspace",
"goal",
"plan"
]
},
{
"invocation": "workspace goal verify",
"summary": "Run the goal-specific checks and publish an evidence-derived verified, blocked, or failed state.",
"canonicalArgv": [
"workspace",
"goal",
"verify"
]
},
{
"invocation": "workspace graph",
"summary": "Query or export the evidence-backed workspace graph derived from the canonical model.",
"canonicalArgv": [
"workspace",
"graph",
"emit",
"--json"
],
"output": {
"defaultFormat": "human-or-json",
"modes": [
{
"selector": "search <query> --limit <count> --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "benchmark <query> --limit <count> --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "emit --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "explain <project> --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "entities [kind] --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "evidence <id-or-unique-label> --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "path <from> <to> --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "overlay --from <graph> --json",
"format": "json",
"mediaType": "application/json"
},
{
"selector": "dot",
"format": "raw-text",
"mediaType": "text/vnd.graphviz"
},
{
"selector": "mermaid",
"format": "raw-text",
"mediaType": "text/vnd.mermaid"
},
{
"selector": "jsonld",
"format": "raw-text",
"mediaType": "application/ld+json"
},
{
"selector": "graphml",
"format": "raw-text",
"mediaType": "application/graphml+xml"
},
{
"selector": "gexf",
"format": "raw-text",
"mediaType": "application/gexf+xml"
}
]
}
},
{
"invocation": "workspace hydrate",
"summary": "Restore or materialize workspace state from a portable representation.",
"canonicalArgv": [
"workspace",
"hydrate"
]
},
{
"invocation": "workspace impact",
"summary": "Calculate the blast radius of a workspace diff across projects, dependencies, tests, policies, and gates.",
"canonicalArgv": [
"workspace",
"impact"
]
},
{
"invocation": "workspace impact --from .workspai/reports/workspace-model-diff-last-run.json --json",
"summary": "Compute structured impact evidence from the latest canonical workspace model diff artifact.",
"canonicalArgv": [
"workspace",
"impact",
"--from",
".workspai/reports/workspace-model-diff-last-run.json",
"--json"
]
},
{
"invocation": "workspace import",
"summary": "Import and register a verified portable workspace archive.",
"canonicalArgv": [
"workspace",
"import"
]
},
{
"invocation": "workspace init",
"summary": "Initialize workspace and project dependencies through the shared init flow.",
"canonicalArgv": [
"workspace",
"init"
]
},
{
"invocation": "workspace intelligence",
"summary": "Run the canonical Workspace Intelligence dependency graph as one evidence-coherent operation.",
"canonicalArgv": [
"workspace",
"intelligence"
]
},
{
"invocation": "workspace intelligence run",
"summary": "Execute every required Workspace Intelligence stage in dependency order and persist one authoritative run result.",
"canonicalArgv": [
"workspace",
"intelligence",
"run"
]
},
{
"invocation": "workspace list",
"summary": "List registered workspaces through the canonical workspace discovery boundary.",
"canonicalArgv": [
"workspace",
"list"
]
},
{
"invocation": "workspace mcp",
"summary": "Expose Workspace Intelligence through the MCP integration boundary.",
"canonicalArgv": [
"workspace",
"mcp"
]
},
{
"invocation": "workspace model",
"summary": "Discover and normalize workspace entities, relationships, ownership, runtime, contract, and evidence state.",
"canonicalArgv": [
"workspace",
"model"
]
},
{
"invocation": "workspace model --json --write",
"summary": "Persist the canonical workspace model and emit the same versioned representation as JSON.",
"canonicalArgv": [
"workspace",
"model",
"--json",
"--write"
]
},
{
"invocation": "workspace policy",
"summary": "Inspect or update workspace governance policy.",
"canonicalArgv": [
"workspace",
"policy"
]
},
{
"invocation": "workspace registry",
"summary": "Inspect and maintain the canonical workspace registry boundary.",
"canonicalArgv": [
"workspace",
"registry"
]
},
{
"invocation": "workspace remediation-plan",
"summary": "Generate a structured remediation plan from current workspace evidence.",
"canonicalArgv": [
"workspace",
"remediation-plan"
]
},
{
"invocation": "workspace repair",
"summary": "Own a durable repair transaction from governed planning and approval through checkpoint, execution, validation, canonical verification, closure, or rollback.",
"canonicalArgv": [
"workspace",
"repair"
]
},
{
"invocation": "workspace repair approve",
"summary": "Bind explicit local approval to the exact hash of an immutable repair transaction plan.",
"canonicalArgv": [
"workspace",
"repair",
"approve"
]
},
{
"invocation": "workspace repair cancel",
"summary": "Cancel an unmutated repair transaction and expire any prior approval.",
"canonicalArgv": [
"workspace",
"repair",
"cancel"
]
},
{
"invocation": "workspace repair decide",
"summary": "Submit an available decision and either roll back, release control, or compile a fresh immutable policy plan.",
"canonicalArgv": [
"workspace",
"repair",
"decide"
]
},
{
"invocation": "workspace repair execute",
"summary": "Checkpoint bounded files and execute approved repair, reconcile, audit, test, build, and canonical verification stages.",
"canonicalArgv": [
"workspace",
"repair",
"execute"
]
},
{
"invocation": "workspace repair plan",
"summary": "Resolve current canonical remediation evidence into an immutable, risk-bounded repair transaction plan.",
"canonicalArgv": [
"workspace",
"repair",
"plan"
]
},
{
"invocation": "workspace repair propose",
"summary": "Validate a model-authored, hash-pinned source proposal and compile it into a CLI-owned immutable repair transaction.",
"canonicalArgv": [
"workspace",
"repair",
"propose"
]
},
{
"invocation": "workspace repair resume",
"summary": "Resume an interrupted approved transaction from its first unfinished durable stage.",
"canonicalArgv": [
"workspace",
"repair",
"resume"
]
},
{
"invocation": "workspace repair rollback",
"summary": "Restore bounded checkpoint files only when their post-repair hashes still match the transaction.",
"canonicalArgv": [
"workspace",
"repair",
"rollback"
]
},
{
"invocation": "workspace run",
"summary": "Run a supported lifecycle command across registered workspace projects.",
"canonicalArgv": [
"workspace",
"run"
]
},
{
"invocation": "workspace share",
"summary": "Prepare a governed workspace sharing surface.",
"canonicalArgv": [
"workspace",
"share"
]
},
{
"invocation": "workspace snapshot",
"summary": "Capture a versioned workspace or model baseline for comparison and recovery.",
"canonicalArgv": [
"workspace",
"snapshot"
]
},
{
"invocation": "workspace sync",
"summary": "Reconcile registered projects and workspace identity with the current filesystem state.",
"canonicalArgv": [
"workspace",
"sync"
]
},
{
"invocation": "workspace trace",
"summary": "Trace a change or finding through its evidence and dependency relationships.",
"canonicalArgv": [
"workspace",
"trace"
]
},
{
"invocation": "workspace verify",
"summary": "Combine impact, diagnostics, contracts, analysis, and readiness evidence into a governed verification verdict.",
"canonicalArgv": [
"workspace",
"verify"
]
},
{
"invocation": "workspace verify --from-impact .workspai/reports/workspace-impact-last-run.json --json",
"summary": "Verify the latest impact artifact and append the structured outcome to Workspace Intelligence history.",
"canonicalArgv": [
"workspace",
"verify",
"--from-impact",
".workspai/reports/workspace-impact-last-run.json",
"--json"
]
},
{
"invocation": "workspace watch",
"summary": "Observe relevant workspace changes and publish versioned watch events.",
"canonicalArgv": [
"workspace",
"watch",
"--json"
],
"output": {
"defaultFormat": "human-or-json",
"modes": [
{
"selector": "--json",
"format": "json",
"mediaType": "application/x-ndjson"
},
{
"selector": "--graph-stream --json",
"format": "json",
"mediaType": "application/x-ndjson"
}
]
}
},
{
"invocation": "workspace why",
"summary": "Explain why a relationship, verdict, or workspace fact exists.",
"canonicalArgv": [
"workspace",
"why"
]
}
],
"artifactContracts": [
{
"artifactPath": ".workspai/reports/workspace-model.json",
"schemaVersion": "workspace-model.v1",
"contractPath": "contracts/workspace-intelligence/workspace-model.v1.json",
"producerCommands": [
[
"workspace",
"model",
"--json",
"--write"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-knowledge-graph.json",
"schemaVersion": "workspace-knowledge-graph.v1",
"contractPath": "contracts/workspace-intelligence/workspace-knowledge-graph.v1.json",
"producerCommands": [
[
"workspace",
"model",
"--json",
"--write"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-model-snapshot.json",
"schemaVersion": "workspace-model-snapshot.v1",
"contractPath": "contracts/workspace-intelligence/workspace-model-snapshot.v1.json",
"producerCommands": [
[
"workspace",
"snapshot"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-model-diff-last-run.json",
"schemaVersion": "workspace-model-diff.v1",
"contractPath": "contracts/workspace-intelligence/workspace-model-diff.v1.json",
"producerCommands": [
[
"workspace",
"diff",
"--from",
".workspai/reports/workspace-model-snapshot.json",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-impact-last-run.json",
"schemaVersion": "workspace-impact.v1",
"contractPath": "contracts/workspace-intelligence/workspace-impact.v1.json",
"producerCommands": [
[
"workspace",
"impact",
"--from",
".workspai/reports/workspace-model-diff-last-run.json",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/analyze-last-run.json",
"schemaVersion": "rapidkit-analyze-v1",
"contractPath": "contracts/analyze-last-run.v1.json",
"producerCommands": [
[
"analyze",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-last-run.json",
"schemaVersion": "doctor-workspace-evidence-v1",
"contractPath": "contracts/doctor-workspace-evidence.v1.json",
"producerCommands": [
[
"doctor",
"workspace",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-contract-verify-last-run.json",
"schemaVersion": "workspace-contract-verify.v1",
"contractPath": "contracts/workspace-intelligence/workspace-contract-verify.v1.json",
"producerCommands": [
[
"workspace",
"contract",
"verify",
"--strict",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/release-readiness-last-run.json",
"schemaVersion": "release-readiness-v1",
"contractPath": "contracts/release-readiness.v1.json",
"producerCommands": [
[
"readiness",
"--json",
"--skip-verify"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-verify-last-run.json",
"schemaVersion": "workspace-verify.v1",
"contractPath": "contracts/workspace-intelligence/workspace-verify.v1.json",
"producerCommands": [
[
"workspace",
"verify",
"--from-impact",
".workspai/reports/workspace-impact-last-run.json",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-intelligence-history.json",
"schemaVersion": "workspace-intelligence-history.v1",
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-history.v1.json",
"producerCommands": [
[
"workspace",
"verify",
"--from-impact",
".workspai/reports/workspace-impact-last-run.json",
"--json"
],
[
"workspace",
"feedback",
"record",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-context-agent.json",
"schemaVersion": "workspace-context.v1",
"contractPath": "contracts/workspace-intelligence/workspace-context.v1.json",
"producerCommands": [
[
"workspace",
"context",
"--for-agent",
"--json",
"--write",
"--no-agent-sync"
]
]
},
{
"artifactPath": ".workspai/reports/INDEX.json",
"schemaVersion": "rapidkit-agent-reports-index.v1",
"contractPath": "contracts/workspace-intelligence/agent-reports-index.v1.json",
"producerCommands": [
[
"workspace",
"agent-sync",
"--write",
"--json",
"--preset",
"enterprise"
]
]
},
{
"artifactPath": ".workspai/reports/agent-customization-pack.json",
"schemaVersion": "rapidkit-agent-customization-pack.v1",
"contractPath": "contracts/workspace-intelligence/agent-customization-pack-report.v1.json",
"producerCommands": [
[
"workspace",
"agent-sync",
"--write",
"--json",
"--preset",
"enterprise"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-skills-index.json",
"schemaVersion": "workspace-skills-index.v1",
"contractPath": "contracts/workspace-intelligence/workspace-skills-index.v1.json",
"producerCommands": [
[
"workspace",
"agent-sync",
"--write",
"--json",
"--preset",
"enterprise"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-explain-last-run.json",
"schemaVersion": "workspace-explain.v1",
"contractPath": "contracts/workspace-intelligence/workspace-explain.v1.json",
"producerCommands": [
[
"workspace",
"explain",
"release-blocked",
"--json",
"--write"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-intelligence-run-last-run.json",
"schemaVersion": "workspace-intelligence-run.v1",
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-run.v1.json",
"producerCommands": [
[
"workspace",
"intelligence",
"run"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-intelligence-evaluation-live.json",
"schemaVersion": "workspace-intelligence-evaluation.v1",
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-evaluation.v1.json",
"producerCommands": [
[
"workspace",
"eval",
"init"
],
[
"workspace",
"eval",
"record",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-intelligence-evaluation-last-run.json",
"schemaVersion": "workspace-intelligence-evaluation.v1",
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-evaluation.v1.json",
"producerCommands": [
[
"workspace",
"eval",
"report",
"--json"
]
]
},
{
"artifactPath": ".workspai/reports/verified-goal-last-run.json",
"schemaVersion": "workspai.verified-goal-status.v1",
"contractPath": "contracts/workspace-intelligence/verified-goal-status.v1.json",
"producerCommands": [
[
"workspace",
"goal",
"plan"
],
[
"workspace",
"goal",
"verify"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-repair-last-run.json",
"schemaVersion": "workspai.workspace-repair-transaction.v1",
"contractPath": "contracts/workspace-intelligence/workspace-repair-transaction.v1.json",
"producerCommands": [
[
"workspace",
"repair",
"plan"
],
[
"workspace",
"repair",
"propose"
],
[
"workspace",
"repair",
"approve"
],
[
"workspace",
"repair",
"decide"
],
[
"workspace",
"repair",
"execute"
],
[
"workspace",
"repair",
"resume"
],
[
"workspace",
"repair",
"rollback"
],
[
"workspace",
"repair",
"cancel"
]
]
},
{
"artifactPath": ".workspai/goals/index.json",
"schemaVersion": "workspai.goal-index.v1",
"contractPath": "contracts/workspace-intelligence/goal-index.v1.json",
"producerCommands": [
[
"goal"
]
]
},
{
"artifactPath": ".workspai/workspace-link.local.json",
"schemaVersion": "project-workspace-link.v1",
"contractPath": "contracts/project-workspace-link.v1.json",
"producerCommands": [
[
"adopt"
],
[
"import"
],
[
"project",
"workspace",
"relink"
],
[
"workspace",
"sync"
]
]
},
{
"artifactPath": ".workspai/reports/project-context-agent.json",
"schemaVersion": "project-context-agent.v1",
"contractPath": "contracts/workspace-intelligence/project-context-agent.v1.json",
"producerCommands": [
[
"adopt"
],
[
"import"
],
[
"workspace",
"sync"
],
[
"workspace",
"agent-sync",
"--write"
]
]
},
{
"artifactPath": ".workspai/agent-entry.v1.json",
"schemaVersion": "workspai.agent-entry.v1",
"contractPath": "contracts/workspace-intelligence/project-agent-entry.v1.json",
"producerCommands": [
[
"adopt"
],
[
"import"
],
[
"workspace",
"sync"
],
[
"workspace",
"agent-sync",
"--write"
]
]
},
{
"artifactPath": ".workspai/workspace.contract.json",
"schemaVersion": 1,
"contractPath": "contracts/workspace-contract.v1.json",
"producerCommands": [
[
"workspace",
"sync"
],
[
"workspace",
"contract",
"sync"
]
]
},
{
"artifactPath": ".workspai/cache/workspace-model.v1.json",
"schemaVersion": "workspace-model-cache.v1",
"contractPath": "contracts/workspace-model-cache.v1.json",
"producerCommands": [
[
"workspace",
"model"
]
]
},
{
"artifactPath": ".workspai/workspace-registry.v1.json",
"schemaVersion": "workspace-registry.v1",
"contractPath": "contracts/workspace-registry.v1.json",
"producerCommands": [
[
"workspace",
"sync"
]
]
},
{
"artifactPath": ".workspai/compatibility-matrix.json",
"schemaVersion": "rapidkit.compatibility-matrix.v1",
"contractPath": "contracts/compatibility-matrix.v1.json",
"producerCommands": [
[
"bootstrap"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-workspace-cache.json",
"schemaVersion": "doctor-workspace-cache-v2",
"contractPath": "contracts/doctor-workspace-cache.v2.json",
"producerCommands": [
[
"doctor",
"workspace"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-capabilities.json",
"schemaVersion": "workspai.doctor-capabilities.v1",
"contractPath": "contracts/workspace-intelligence/doctor-capabilities.v1.json",
"producerCommands": [
[
"doctor",
"capabilities",
"--write"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-validation-last-run.json",
"schemaVersion": "workspai.doctor-validation.v1",
"contractPath": "contracts/workspace-intelligence/doctor-validation.v1.json",
"producerCommands": [
[
"doctor",
"capabilities",
"--validate",
"--write"
]
]
},
{
"artifactPath": ".workspai/reports/bootstrap-compliance.latest.json",
"schemaVersion": "bootstrap-compliance.v1",
"contractPath": "contracts/bootstrap-compliance.v1.json",
"producerCommands": [
[
"bootstrap"
]
]
},
{
"artifactPath": ".workspai/reports/mirror-ops.latest.json",
"schemaVersion": "mirror-ops.v1",
"contractPath": "contracts/mirror-ops.v1.json",
"producerCommands": [
[
"mirror",
"status"
]
]
},
{
"artifactPath": ".workspai/reports/transparency-evidence.latest.json",
"schemaVersion": "transparency-evidence.v1",
"contractPath": "contracts/transparency-evidence.v1.json",
"producerCommands": [
[
"mirror",
"sync"
]
]
},
{
"artifactPath": ".workspai/reports/share-bundle.json",
"schemaVersion": "1.1",
"contractPath": "contracts/workspace-share-bundle.v1.json",
"producerCommands": [
[
"workspace",
"share"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-project-last-run.json",
"schemaVersion": "doctor-project-evidence-v1",
"contractPath": "contracts/doctor-project-evidence.v1.json",
"producerCommands": [
[
"doctor",
"project"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-receipt-last-run.json",
"schemaVersion": "workspai.doctor-receipt.v1",
"contractPath": "contracts/workspace-intelligence/doctor-receipt.v1.json",
"producerCommands": [
[
"doctor",
"workspace"
],
[
"doctor",
"project"
]
]
},
{
"artifactPath": ".workspai/reports/project-test-coverage-last-run.json",
"schemaVersion": "workspai.project-test-coverage.v1",
"contractPath": "contracts/project-test-coverage.v1.json",
"producerCommands": [
[
"project",
"coverage"
]
]
},
{
"artifactPath": ".workspai/reports/goal-pack-last-run.json",
"schemaVersion": "workspai.goal-pack.v1",
"contractPath": "contracts/workspace-intelligence/goal-pack.v1.json",
"producerCommands": [
[
"goal"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-remediation-plan-last-run.json",
"schemaVersion": "doctor-remediation-plan-v2",
"contractPath": "contracts/doctor-remediation-plan.v2.json",
"producerCommands": [
[
"workspace",
"remediation-plan"
]
]
},
{
"artifactPath": ".workspai/reports/artifact-remediation-plan-last-run.json",
"schemaVersion": "artifact-remediation-plan-v1",
"contractPath": "contracts/artifact-remediation-plan.v1.json",
"producerCommands": [
[
"workspace",
"remediation-plan"
]
]
},
{
"artifactPath": ".workspai/reports/doctor-fix-result-last-run.json",
"schemaVersion": "rapidkit-doctor-fix-result-v1",
"contractPath": "contracts/workspace-intelligence/doctor-fix-result.v1.json",
"producerCommands": [
[
"doctor",
"workspace"
]
]
},
{
"artifactPath": ".workspai/reports/pipeline-last-run.json",
"schemaVersion": "rapidkit-pipeline-v1",
"contractPath": "contracts/pipeline-last-run.v1.json",
"producerCommands": [
[
"pipeline"
]
]
},
{
"artifactPath": ".workspai/reports/autopilot-release-last-run.json",
"schemaVersion": "autopilot-release-v1",
"contractPath": "contracts/autopilot-release.v1.json",
"producerCommands": [
[
"autopilot",
"release"
]
]
},
{
"artifactPath": ".workspai/reports/autopilot-release.json",
"schemaVersion": "autopilot-release-v1",
"contractPath": "contracts/autopilot-release.v1.json",
"producerCommands": [
[
"autopilot",
"release"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-run-last.json",
"schemaVersion": "workspace-run-v1",
"contractPath": "contracts/workspace-run-last.v1.json",
"producerCommands": [
[
"workspace",
"run"
]
]
},
{
"artifactPath": ".workspai/reports/workspai-mcp-design.json",
"schemaVersion": "workspai-mcp-design.v1",
"contractPath": "contracts/workspace-intelligence/mcp-design.v1.json",
"producerCommands": [
[
"workspace",
"agent-sync",
"--write"
]
]
},
{
"artifactPath": ".workspai/reports/rapidkit-mcp-design.json",
"schemaVersion": "workspai-mcp-design.v1",
"contractPath": "contracts/workspace-intelligence/mcp-design.v1.json",
"producerCommands": [
[
"workspace",
"agent-sync",
"--write"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-why-last-run.json",
"schemaVersion": "workspace-explain.v1",
"contractPath": "contracts/workspace-intelligence/workspace-explain.v1.json",
"producerCommands": [
[
"workspace",
"why"
]
]
},
{
"artifactPath": ".workspai/reports/workspace-trace-last-run.json",
"schemaVersion": "workspace-explain.v1",
"contractPath": "contracts/workspace-intelligence/workspace-explain.v1.json",
"producerCommands": [
[
"workspace",
"trace"
]
]
},
{
"artifactPath": ".vscode/workspai-agent-hooks.json",
"schemaVersion": "workspai-agent-hooks.v1",
"contractPath": "contracts/workspace-intelligence/agent-hooks.v1.json",
"producerCommands": [
[
"workspace",
"agent-sync"
]
]
},
{
"artifactPath": ".workspai/reports/infra-plan.json",
"schemaVersion": "rapidkit.infra-plan.v1",
"contractPath": "contracts/infra-plan.v1.json",
"producerCommands": [
[
"infra",
"plan"
]
]
}
],
"workspaceSubcommands": [
"list",
"sync",
"registry",
"foundation",
"intelligence",
"model",
"snapshot",
"diff",
"impact",
"verify",
"goal",
"graph",
"watch",
"context",
"agent-sync",
"remediation-plan",
"repair",
"explain",
"why",
"trace",
"feedback",
"eval",
"mcp",
"policy",
"contract",
"share",
"export",
"archive",
"hydrate",
"import",
"connect",
"run",
"init"
],
"workspaceActions": [
{
"id": "list",
"usage": "workspai workspace list [--json]",
"summary": "List registered Workspai workspaces.",
"options": [
{
"flag": "--json",
"description": "Emit machine-readable JSON."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace list",
"workspai workspace list --json"
]
},
{
"id": "sync",
"usage": "workspai workspace sync [--project-grounding <mode>] [--json]",
"summary": "Synchronize canonical workspace registration and project metadata.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--project-grounding",
"description": "Select the project entrypoint policy: managed, local, or off."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace sync --json"
]
},
{
"id": "registry",
"usage": "workspai workspace registry [--refresh] [--json]",
"summary": "Inspect the canonical workspace registry summary.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--refresh",
"description": "Refresh the underlying registry or context before reading it."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace registry --refresh --json"
]
},
{
"id": "foundation",
"usage": "workspai workspace foundation [--force] [--json]",
"summary": "Create or repair the standard workspace foundation files.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--force",
"description": "Replace an existing generated target where supported."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace foundation --json"
]
},
{
"id": "intelligence",
"usage": "workspai workspace intelligence run [--for-agent <agent>] [--strict] [--json]",
"summary": "Run the canonical Workspace Intelligence chain in contract order.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--for-agent",
"description": "Build output for an agent surface (for example codex, copilot, or cursor)."
}
],
"subactions": [
"run"
],
"artifact": ".workspai/reports/workspace-intelligence-run-last-run.json",
"examples": [
"workspai workspace intelligence run --strict",
"workspai workspace intelligence run --for-agent codex --json"
]
},
{
"id": "model",
"usage": "workspai workspace model [--cache|--incremental] [--write] [--strict] [--json]",
"summary": "Build the canonical workspace model from registered and observed sources.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--include-evidence",
"description": "Read and include referenced evidence metadata."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
},
{
"flag": "--cache",
"description": "Reuse the model cache when the structural inputs are unchanged."
},
{
"flag": "--incremental",
"description": "Reuse unchanged projects and rebuild affected graph relations."
},
{
"flag": "--write",
"description": "Persist the command artifact under .workspai/reports."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-model.json",
"examples": [
"workspai workspace model --write --json",
"workspai workspace model --incremental --write --json"
]
},
{
"id": "snapshot",
"usage": "workspai workspace snapshot [--json]",
"summary": "Persist the current model as the comparison baseline.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--include-evidence",
"description": "Read and include referenced evidence metadata."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-model-snapshot.json",
"examples": [
"workspai workspace snapshot --json"
]
},
{
"id": "diff",
"usage": "workspai workspace diff --from <snapshot-or-model|git[:ref]> [--strict] [--json]",
"summary": "Compare the current model with a trusted model baseline.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--from",
"description": "Read the specified baseline, report, or graph artifact."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--include-evidence",
"description": "Read and include referenced evidence metadata."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-model-diff-last-run.json",
"examples": [
"workspai workspace diff --from .workspai/reports/workspace-model-snapshot.json --json",
"workspai workspace diff --from git --json"
]
},
{
"id": "impact",
"usage": "workspai workspace impact --from <diff> [--scope <scope>] [--strict] [--json]",
"summary": "Calculate the evidence-backed blast radius of the current model change.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--from",
"description": "Read the specified baseline, report, or graph artifact."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--include-evidence",
"description": "Read and include referenced evidence metadata."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-impact-last-run.json",
"examples": [
"workspai workspace impact --from .workspai/reports/workspace-model-diff-last-run.json --json",
"workspai workspace impact --from .workspai/reports/workspace-model-diff-last-run.json --strict --json"
]
},
{
"id": "verify",
"usage": "workspai workspace verify [--from-impact <impact-report>] [--scope <scope>] [--strict] [--json]",
"summary": "Verify the selected change against contracts, gates, and current evidence.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--from-impact",
"description": "Read the specified impact report for verification."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--include-evidence",
"description": "Read and include referenced evidence metadata."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-verify-last-run.json",
"examples": [
"workspai workspace verify --strict --json",
"workspai workspace verify --from-impact .workspai/reports/workspace-impact-last-run.json --json"
]
},
{
"id": "goal",
"usage": "workspai workspace goal <plan|status|verify> <kind|goal-id> [--scope <scope>] [--target <percent>] [--json]",
"summary": "Plan, resume, and evidence-verify a durable engineering goal for people and agents.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--target",
"description": "Set the required test coverage percentage (0–100)."
},
{
"flag": "--allow-breaking",
"description": "Allow a verified goal to use breaking dependency changes."
},
{
"flag": "--allow-force",
"description": "Allow a verified goal to use force-based repair commands."
},
{
"flag": "--no-build",
"description": "Do not require build validation for the selected verified goal."
},
{
"flag": "--no-tests",
"description": "Do not require test validation for the selected verified goal."
},
{
"flag": "--no-run",
"description": "Read current goal evidence without executing verification commands."
},
{
"flag": "--reuse-intelligence",
"description": "Reuse a just-completed canonical intelligence run while executing goal-specific checks."
}
],
"subactions": [
"plan",
"status",
"verify"
],
"artifact": ".workspai/reports/verified-goal-last-run.json",
"examples": [
"workspai workspace goal plan release-readiness --json",
"workspai workspace goal plan dependency-security --scope project:api --json",
"workspai workspace goal plan test-coverage --scope project:web --target 75 --json",
"workspai workspace goal verify <goal-id> --json"
]
},
{
"id": "graph",
"usage": "workspai workspace graph [mode] [query|from] [to] [--json]",
"summary": "Build, query, prove, compare, or export the workspace graph.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--output",
"description": "Write the requested export or report to this path."
},
{
"flag": "--from",
"description": "Read the specified baseline, report, or graph artifact."
},
{
"flag": "--limit",
"description": "Bound graph query results (1–100)."
},
{
"flag": "--kind",
"description": "Limit graph entity search to one canonical entity kind."
},
{
"flag": "--refresh-graph",
"description": "Bypass the compatible persisted graph and rebuild from live sources."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--include-evidence",
"description": "Read and include referenced evidence metadata."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
}
],
"subactions": [
"emit",
"explain",
"entities",
"search",
"evidence",
"path",
"overlay",
"benchmark",
"dot",
"mermaid",
"jsonld",
"graphml",
"gexf"
],
"artifact": null,
"examples": [
"workspai workspace graph search \"authentication endpoint\" --kind endpoint --limit 12 --json",
"workspai workspace graph evidence \"GET /users\" --json",
"workspai workspace graph mermaid"
]
},
{
"id": "watch",
"usage": "workspai workspace watch [--once] [--graph-stream] [--json]",
"summary": "Observe model changes and optionally stream graph deltas.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--once",
"description": "Build the initial observed state and exit."
},
{
"flag": "--graph-stream",
"description": "Emit graph snapshot/delta events as NDJSON."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace watch --once --json",
"workspai workspace watch --graph-stream"
]
},
{
"id": "context",
"usage": "workspai workspace context [--for-agent <agent>] [--scope <scope>] [--write] [--json]",
"summary": "Build a bounded, evidence-backed context pack for people and agents.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--for-agent",
"description": "Build output for an agent surface (for example codex, copilot, or cursor)."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--include-evidence",
"description": "Read and include referenced evidence metadata."
},
{
"flag": "--scan-depth",
"description": "Set the bounded observable-project discovery depth."
},
{
"flag": "--write",
"description": "Persist the command artifact under .workspai/reports."
},
{
"flag": "--agent-sync",
"description": "Synchronize agent grounding after writing the context artifact."
},
{
"flag": "--no-agent-sync",
"description": "Do not synchronize agent grounding after writing context."
},
{
"flag": "--preset",
"description": "Select the generated agent customization preset."
},
{
"flag": "--target",
"description": "Select one or more agent customization targets."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--project-grounding",
"description": "Select the project entrypoint policy: managed, local, or off."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-context-agent.json",
"examples": [
"workspai workspace context --for-agent codex --write --json",
"workspai workspace context --scope project:api --json"
]
},
{
"id": "agent-sync",
"usage": "workspai workspace agent-sync [--for-agent <agent>] [--target <targets>] [--project-grounding <mode>] [--write]",
"summary": "Synchronize bounded workspace grounding for supported agent surfaces.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--for-agent",
"description": "Build output for an agent surface (for example codex, copilot, or cursor)."
},
{
"flag": "--write",
"description": "Persist the command artifact under .workspai/reports."
},
{
"flag": "--dry-run",
"description": "Preview the operation without applying writes."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--preset",
"description": "Select the generated agent customization preset."
},
{
"flag": "--refresh-context",
"description": "Rebuild agent context before synchronization."
},
{
"flag": "--refresh",
"description": "Refresh the underlying registry or context before reading it."
},
{
"flag": "--target",
"description": "Select one or more agent customization targets."
},
{
"flag": "--experimental-hooks",
"description": "Generate advisory VS Code agent hook design files."
},
{
"flag": "--hydrate-prompts",
"description": "Add workspace-specific verification steps to supported prompts."
},
{
"flag": "--project-grounding",
"description": "Select the project entrypoint policy: managed, local, or off."
}
],
"subactions": [],
"artifact": ".workspai/reports/agent-customization-pack.json",
"examples": [
"workspai workspace agent-sync --target all --write --strict",
"workspai workspace agent-sync --for-agent copilot --dry-run --json"
]
},
{
"id": "remediation-plan",
"usage": "workspai workspace remediation-plan [--ci] [--write] [--json]",
"summary": "Build a governed repair plan from current workspace evidence.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--ci",
"description": "Produce a CI-oriented command plan."
},
{
"flag": "--write",
"description": "Persist the command artifact under .workspai/reports."
}
],
"subactions": [],
"artifact": ".workspai/reports/artifact-remediation-plan-last-run.json",
"examples": [
"workspai workspace remediation-plan --write --json",
"workspai workspace remediation-plan --ci --json"
]
},
{
"id": "repair",
"usage": "workspai workspace repair <capabilities|plan|propose|approve|decide|execute|resume|status|list|rollback|cancel> [--transaction <id>] [--json]",
"summary": "Run a durable, approval-bound repair transaction through checkpoint, validation, canonical verification, and rollback.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--card",
"description": "Select the dashboard card whose governed remediation actions should be repaired."
},
{
"flag": "--action-id",
"description": "Select one exact governed remediation action."
},
{
"flag": "--project",
"description": "Limit the repair transaction to one registered project name."
},
{
"flag": "--proposal",
"description": "Read a bounded model repair proposal from a JSON file inside the workspace."
},
{
"flag": "--transaction",
"description": "Select one durable repair transaction by id."
},
{
"flag": "--approved-by",
"description": "Record the local actor approving the immutable repair plan."
},
{
"flag": "--decision",
"description": "Submit one of the exact options exposed by a decision-required transaction."
},
{
"flag": "--max-risk",
"description": "Set the maximum approved repair risk: safe, guarded, or invasive."
},
{
"flag": "--allow-breaking",
"description": "Allow a verified goal to use breaking dependency changes."
},
{
"flag": "--allow-force",
"description": "Allow a verified goal to use force-based repair commands."
},
{
"flag": "--no-auto-rollback",
"description": "Require a decision instead of automatically restoring a failed transaction."
}
],
"subactions": [
"capabilities",
"plan",
"propose",
"approve",
"decide",
"execute",
"resume",
"status",
"list",
"rollback",
"cancel"
],
"artifact": ".workspai/reports/workspace-repair-last-run.json",
"examples": [
"workspai workspace repair capabilities --json",
"workspai workspace repair plan --card doctor --project api --json",
"workspai workspace repair propose --proposal .workspai/repair/inbox/proposal.json --json",
"workspai workspace repair approve --transaction repair_123 --approved-by local-user --json",
"workspai workspace repair decide --transaction repair_123 --decision approve-invasive --json",
"workspai workspace repair execute --transaction repair_123 --json",
"workspai workspace repair rollback --transaction repair_123 --json"
]
},
{
"id": "explain",
"usage": "workspai workspace explain [target] [--scope <scope>] [--write] [--json]",
"summary": "Explain current blockers or a selected workspace target from evidence.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--write",
"description": "Persist the command artifact under .workspai/reports."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-explain-last-run.json",
"examples": [
"workspai workspace explain --write --json"
]
},
{
"id": "why",
"usage": "workspai workspace why [target] [--scope <scope>] [--write] [--json]",
"summary": "Alias the evidence-backed workspace explanation flow.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--write",
"description": "Persist the command artifact under .workspai/reports."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-why-last-run.json",
"examples": [
"workspai workspace why readiness --json"
]
},
{
"id": "trace",
"usage": "workspai workspace trace --from <diff-artifact> [--write] [--json]",
"summary": "Trace a model change through blast radius and decision gates.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--from",
"description": "Read the specified baseline, report, or graph artifact."
},
{
"flag": "--write",
"description": "Persist the command artifact under .workspai/reports."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-trace-last-run.json",
"examples": [
"workspai workspace trace --from .workspai/reports/workspace-model-diff-last-run.json --write --json"
]
},
{
"id": "feedback",
"usage": "echo '<event-json>' | workspai workspace feedback record --json",
"summary": "Record a structured outcome event for the workspace intelligence history.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
}
],
"subactions": [
"record"
],
"artifact": null,
"examples": [
"echo '{\"actionId\":\"fix\",\"summary\":\"ok\",\"outcome\":\"ok\"}' | workspai workspace feedback record --json"
]
},
{
"id": "eval",
"usage": "workspai workspace eval [init|record|status|report|compare] [arguments] [--json]",
"summary": "Measure agent/model calls, tool use, tokens, latency, and verified outcome.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--from",
"description": "Read the specified baseline, report, or graph artifact."
},
{
"flag": "--output",
"description": "Write the requested export or report to this path."
}
],
"subactions": [
"init",
"record",
"status",
"report",
"compare"
],
"artifact": ".workspai/reports/workspace-intelligence-evaluation-last-run.json",
"examples": [
"workspai workspace eval init repair-readiness workspace-intelligence --json",
"workspai workspace eval report --output ./evaluation.json --json"
]
},
{
"id": "mcp",
"usage": "workspai workspace mcp serve",
"summary": "Serve bounded, read-mostly workspace evidence over stdio MCP.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
}
],
"subactions": [
"serve"
],
"artifact": null,
"examples": [
"workspai workspace mcp serve"
]
},
{
"id": "policy",
"usage": "workspai workspace policy [show|status|get|set] [key] [value] [--json]",
"summary": "Inspect or update workspace governance policy.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
}
],
"subactions": [
"show",
"status",
"get",
"set"
],
"artifact": null,
"examples": [
"workspai workspace policy get --json"
]
},
{
"id": "contract",
"usage": "workspai workspace contract [init|inspect|verify|graph] [--strict] [--json]",
"summary": "Create, inspect, verify, or project the workspace contract.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--output",
"description": "Write the requested export or report to this path."
},
{
"flag": "--force",
"description": "Replace an existing generated target where supported."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
}
],
"subactions": [
"init",
"inspect",
"verify",
"graph"
],
"artifact": ".workspai/workspace.contract.json",
"examples": [
"workspai workspace contract verify --strict --json",
"workspai workspace contract graph --json"
]
},
{
"id": "share",
"usage": "workspai workspace share [--output <file>] [--json]",
"summary": "Create a bounded, shareable workspace evidence bundle.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--output",
"description": "Write the requested export or report to this path."
},
{
"flag": "--include-paths",
"description": "Include absolute filesystem paths."
},
{
"flag": "--no-doctor",
"description": "Exclude Doctor evidence from a share bundle."
},
{
"flag": "--no-blueprint",
"description": "Exclude the reproducibility blueprint from a share bundle."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace share --output workspace-share.json --json"
]
},
{
"id": "export",
"usage": "workspai workspace export [--output <archive>] [--archive-compression <format>]",
"summary": "Export a portable workspace archive.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--output",
"description": "Write the requested export or report to this path."
},
{
"flag": "--include-env",
"description": "Include private environment files in an export archive."
},
{
"flag": "--archive-compression",
"description": "Select the archive compression format."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace export --output workspace.tar.gz"
]
},
{
"id": "archive",
"usage": "workspai workspace archive <inspect|verify|doctor> <source> [safety options] [--json]",
"summary": "Inspect, verify, or diagnose a portable workspace archive without materializing it.",
"options": [
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--max-download-size",
"description": "Bound a remote archive download."
},
{
"flag": "--max-expanded-size",
"description": "Bound the expanded archive size."
},
{
"flag": "--download-timeout-ms",
"description": "Bound remote archive download time."
},
{
"flag": "--allow-private-network",
"description": "Allow private-network archive sources explicitly."
}
],
"subactions": [
"inspect",
"verify",
"doctor"
],
"artifact": null,
"examples": [
"workspai workspace archive inspect ./workspace.tar.gz --json",
"workspai workspace archive verify ./workspace.tar.gz --strict --json",
"workspai workspace archive doctor ./workspace.tar.gz --json"
]
},
{
"id": "hydrate",
"usage": "workspai workspace hydrate <source> [--output <directory>] [--dry-run] [--json]",
"summary": "Hydrate a portable workspace into a controlled destination.",
"options": [
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--output",
"description": "Write the requested export or report to this path."
},
{
"flag": "--force",
"description": "Replace an existing generated target where supported."
},
{
"flag": "--dry-run",
"description": "Preview the operation without applying writes."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--max-download-size",
"description": "Bound a remote archive download."
},
{
"flag": "--max-expanded-size",
"description": "Bound the expanded archive size."
},
{
"flag": "--download-timeout-ms",
"description": "Bound remote archive download time."
},
{
"flag": "--allow-private-network",
"description": "Allow private-network archive sources explicitly."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace hydrate workspace.tar.gz --output ./restored --dry-run --json"
]
},
{
"id": "import",
"usage": "workspai workspace import <source> [--output <directory>] [--dry-run] [--json]",
"summary": "Verify, materialize, register, relink, and reconcile a portable workspace archive safely.",
"options": [
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--output",
"description": "Write the requested export or report to this path."
},
{
"flag": "--dry-run",
"description": "Preview the operation without applying writes."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--project-grounding",
"description": "Select the project entrypoint policy: managed, local, or off."
},
{
"flag": "--max-download-size",
"description": "Bound a remote archive download."
},
{
"flag": "--max-expanded-size",
"description": "Bound the expanded archive size."
},
{
"flag": "--download-timeout-ms",
"description": "Bound remote archive download time."
},
{
"flag": "--allow-private-network",
"description": "Allow private-network archive sources explicitly."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace import workspace.tar.gz --output ./imported --json"
]
},
{
"id": "connect",
"usage": "workspai workspace connect [directory] [--project-grounding <mode>] [--dry-run] [--json]",
"summary": "Register and reconcile an existing Workspai workspace in place without moving its source.",
"options": [
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--dry-run",
"description": "Preview the operation without applying writes."
},
{
"flag": "--project-grounding",
"description": "Select the project entrypoint policy: managed, local, or off."
}
],
"subactions": [],
"artifact": null,
"examples": [
"workspai workspace connect /path/to/existing-workspace --json"
]
},
{
"id": "run",
"usage": "workspai workspace run <stage> [selection and concurrency options] [--json]",
"summary": "Run a lifecycle stage across selected workspace projects.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--affected",
"description": "Run only projects affected by the selected Git change."
},
{
"flag": "--blast-radius",
"description": "Include transitive downstream dependents."
},
{
"flag": "--since",
"description": "Select the Git baseline used for affected-project discovery."
},
{
"flag": "--parallel",
"description": "Run selected projects concurrently."
},
{
"flag": "--max-workers",
"description": "Bound concurrent project workers."
},
{
"flag": "--continue-on-error",
"description": "Continue remaining projects after a project failure."
},
{
"flag": "--reuse-passed",
"description": "Reuse successful project-stage results where safe."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--no-gates",
"description": "Skip Doctor and Readiness pre-run gates."
}
],
"subactions": [
"init",
"test",
"build",
"start",
"<custom-from-context>"
],
"artifact": ".workspai/reports/workspace-run-last.json",
"examples": [
"workspai workspace run test --affected --blast-radius --strict",
"workspai workspace run build --parallel --max-workers 4 --json"
]
},
{
"id": "init",
"usage": "workspai workspace init [selection and concurrency options] [--json]",
"summary": "Initialize all selected projects through the workspace fleet runner.",
"options": [
{
"flag": "--workspace",
"description": "Use an explicit workspace root instead of the nearest workspace."
},
{
"flag": "--json",
"description": "Emit machine-readable JSON."
},
{
"flag": "--scope",
"description": "Limit the operation to a bounded scope such as project:<name>."
},
{
"flag": "--parallel",
"description": "Run selected projects concurrently."
},
{
"flag": "--max-workers",
"description": "Bound concurrent project workers."
},
{
"flag": "--continue-on-error",
"description": "Continue remaining projects after a project failure."
},
{
"flag": "--reuse-passed",
"description": "Reuse successful project-stage results where safe."
},
{
"flag": "--strict",
"description": "Return a non-zero exit when governed evidence blocks the result."
},
{
"flag": "--no-gates",
"description": "Skip Doctor and Readiness pre-run gates."
}
],
"subactions": [],
"artifact": ".workspai/reports/workspace-run-last.json",
"examples": [
"workspai workspace init --parallel --strict"
]
}
],
"workspaceIntelligenceSubcommands": [
"intelligence",
"model",
"snapshot",
"diff",
"impact",
"contract",
"verify",
"goal",
"graph",
"watch",
"context",
"agent-sync",
"remediation-plan",
"repair",
"explain",
"why",
"trace",
"feedback",
"eval",
"mcp"
],
"workspaceIntelligenceRootCommands": [
"analyze",
"readiness",
"doctor",
"workspace"
],
"workspaceIntelligenceExecution": [
{
"id": "model",
"argv": [
"workspace",
"model",
"--json",
"--write"
],
"produces": [
{
"path": ".workspai/reports/workspace-model.json",
"schemaVersion": "workspace-model.v1",
"contractPath": "contracts/workspace-intelligence/workspace-model.v1.json"
},
{
"path": ".workspai/reports/workspace-knowledge-graph.json",
"schemaVersion": "workspace-knowledge-graph.v1",
"contractPath": "contracts/workspace-intelligence/workspace-knowledge-graph.v1.json"
}
]
},
{
"id": "diff",
"argv": [
"workspace",
"diff",
"--from",
".workspai/reports/workspace-model-snapshot.json",
"--json"
],
"produces": [
{
"path": ".workspai/reports/workspace-model-diff-last-run.json",
"schemaVersion": "workspace-model-diff.v1",
"contractPath": "contracts/workspace-intelligence/workspace-model-diff.v1.json"
}
]
},
{
"id": "impact",
"argv": [
"workspace",
"impact",
"--from",
".workspai/reports/workspace-model-diff-last-run.json",
"--json"
],
"produces": [
{
"path": ".workspai/reports/workspace-impact-last-run.json",
"schemaVersion": "workspace-impact.v1",
"contractPath": "contracts/workspace-intelligence/workspace-impact.v1.json"
}
]
},
{
"id": "doctor-evidence",
"argv": [
"doctor",
"workspace",
"--json"
],
"produces": [
{
"path": ".workspai/reports/doctor-last-run.json",
"schemaVersion": "doctor-workspace-evidence-v1",
"contractPath": "contracts/doctor-workspace-evidence.v1.json"
}
]
},
{
"id": "contract-evidence",
"argv": [
"workspace",
"contract",
"verify",
"--strict",
"--json"
],
"produces": [
{
"path": ".workspai/reports/workspace-contract-verify-last-run.json",
"schemaVersion": "workspace-contract-verify.v1",
"contractPath": "contracts/workspace-intelligence/workspace-contract-verify.v1.json"
}
]
},
{
"id": "analyze-evidence",
"argv": [
"analyze",
"--json"
],
"produces": [
{
"path": ".workspai/reports/analyze-last-run.json",
"schemaVersion": "rapidkit-analyze-v1",
"contractPath": "contracts/analyze-last-run.v1.json"
}
]
},
{
"id": "readiness-evidence",
"argv": [
"readiness",
"--json",
"--skip-verify"
],
"produces": [
{
"path": ".workspai/reports/release-readiness-last-run.json",
"schemaVersion": "release-readiness-v1",
"contractPath": "contracts/release-readiness.v1.json"
}
]
},
{
"id": "verify",
"argv": [
"workspace",
"verify",
"--from-impact",
".workspai/reports/workspace-impact-last-run.json",
"--json"
],
"produces": [
{
"path": ".workspai/reports/workspace-verify-last-run.json",
"schemaVersion": "workspace-verify.v1",
"contractPath": "contracts/workspace-intelligence/workspace-verify.v1.json"
},
{
"path": ".workspai/reports/workspace-intelligence-history.json",
"schemaVersion": "workspace-intelligence-history.v1",
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-history.v1.json"
}
]
},
{
"id": "context",
"argv": [
"workspace",
"context",
"--for-agent",
"--json",
"--write",
"--no-agent-sync"
],
"produces": [
{
"path": ".workspai/reports/workspace-context-agent.json",
"schemaVersion": "workspace-context.v1",
"contractPath": "contracts/workspace-intelligence/workspace-context.v1.json"
}
]
},
{
"id": "agent-sync",
"argv": [
"workspace",
"agent-sync",
"--write",
"--json",
"--preset",
"enterprise"
],
"produces": [
{
"path": ".workspai/reports/INDEX.json",
"schemaVersion": "rapidkit-agent-reports-index.v1",
"contractPath": "contracts/workspace-intelligence/agent-reports-index.v1.json"
},
{
"path": ".workspai/reports/agent-customization-pack.json",
"schemaVersion": "rapidkit-agent-customization-pack.v1",
"contractPath": "contracts/workspace-intelligence/agent-customization-pack-report.v1.json"
},
{
"path": ".workspai/reports/workspace-skills-index.json",
"schemaVersion": "workspace-skills-index.v1",
"contractPath": "contracts/workspace-intelligence/workspace-skills-index.v1.json"
},
{
"path": "AGENTS.md",
"schemaVersion": null,
"contractPath": null
}
]
},
{
"id": "explain",
"argv": [
"workspace",
"explain",
"release-blocked",
"--json",
"--write"
],
"produces": [
{
"path": ".workspai/reports/workspace-explain-last-run.json",
"schemaVersion": "workspace-explain.v1",
"contractPath": "contracts/workspace-intelligence/workspace-explain.v1.json"
}
]
}
],
"jsonOperationResult": {
"schemaVersion": "workspai-cli-operation-result-v1",
"contractPath": "contracts/cli-operation-result.v1.json"
},
"workspaceArchive": {
"schemaVersion": "workspai-workspace-archive-capabilities-v1",
"contractPath": "contracts/workspace-archive-capabilities.v1.json",
"commands": [
"export",
"inspect",
"verify",
"doctor",
"hydrate"
],
"flags": [
"--archive-compression <mode>",
"--max-download-size <size>",
"--max-expanded-size <size>",
"--download-timeout-ms <ms>",
"--allow-private-network"
]
},
"moduleSuggestionFrameworks": [
"fastapi",
"nestjs"
],
"moduleUnsupportedFrameworks": [
"go",
"springboot",
"dotnet",
"nextjs",
"remix",
"vite-react",
"vite-vue",
"vite-svelte",
"vite-solid",
"vite-vanilla",
"nuxt",
"angular",
"astro",
"sveltekit"
],
"scaffoldKits": [
"fastapi.standard",
"fastapi.ddd",
"nestjs.standard",
"gofiber.standard",
"gogin.standard",
"springboot.standard",
"dotnet.webapi.clean",
"rust.axum",
"frontend.nextjs",
"frontend.remix",
"frontend.vite-react",
"frontend.vite-vue",
"frontend.vite-svelte",
"frontend.vite-solid",
"frontend.vite-vanilla",
"frontend.nuxt",
"frontend.angular",
"frontend.astro",
"frontend.sveltekit"
],
"createPlanner": {
"lanes": {
"native": {
"status": "available",
"meaning": "Workspai owns the scaffold contract, marker, registry, doctor, bootstrap, and workspace model path."
},
"official": {
"status": "available",
"meaning": "A stable ecosystem generator exists. Available entries run the official generator and then register the project; planned entries fall back to adopt/import."
},
"existing": {
"status": "available",
"meaning": "The project enters Workspace Intelligence through import/adopt, not native create."
}
},
"nativeCreateKits": [
"fastapi.standard",
"fastapi.ddd",
"nestjs.standard",
"springboot.standard",
"gofiber.standard",
"gogin.standard",
"dotnet.webapi.clean",
"rust.axum"
],
"officialCreate": [
"frontend.nextjs",
"frontend.remix",
"frontend.vite-react",
"frontend.vite-vue",
"frontend.vite-svelte",
"frontend.vite-solid",
"frontend.vite-vanilla",
"frontend.nuxt",
"frontend.angular",
"frontend.astro",
"frontend.sveltekit",
"desktop.tauri",
"desktop.electron",
"extension.vscode",
"php.laravel",
"wordpress-site",
"wordpress-block",
"symfony",
"rails"
],
"existingRuntimeSignals": [
"php",
"ruby",
"rust",
"elixir",
"clojure",
"scala",
"kotlin"
]
},
"runtimeMatrix": {
"python": {
"tier": "first-class",
"scaffold": true,
"import": true,
"moduleCommands": true,
"doctor": "full",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"node": {
"tier": "extended",
"scaffold": true,
"import": true,
"moduleCommands": true,
"doctor": "full",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"go": {
"tier": "extended",
"scaffold": true,
"import": true,
"moduleCommands": false,
"doctor": "readiness",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"java": {
"tier": "extended",
"scaffold": true,
"import": true,
"moduleCommands": false,
"doctor": "readiness",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"dotnet": {
"tier": "extended",
"scaffold": true,
"import": true,
"moduleCommands": false,
"doctor": "readiness",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"php": {
"tier": "extended",
"scaffold": true,
"import": true,
"moduleCommands": false,
"doctor": "readiness",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"ruby": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"rust": {
"tier": "extended",
"scaffold": true,
"import": true,
"moduleCommands": false,
"doctor": "readiness",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"elixir": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"clojure": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"scala": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"kotlin": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"deno": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"bun": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"init",
"dev",
"start",
"build",
"test",
"lint",
"format",
"help"
]
},
"c": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"cpp": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
},
"unknown": {
"tier": "observed",
"scaffold": false,
"import": true,
"moduleCommands": false,
"doctor": "observed",
"lifecycleCommands": [
"help"
]
}
}
}