Contract-backed CLI reference
Workspai command catalog
100 command surfaces are derived from the synced runtime capability contract. Workspace Intelligence commands include their canonical execution, artifacts, and schema relationships.
Workspace Intelligence
20 commands across the canonical model, evidence, impact, verification, context, and explanation loop
npx workspai analyzeEvaluate workspace evidence and produce governance findings for downstream readiness and release decisions.
npx workspai doctorDiagnose the active project or workspace and produce actionable findings with evidence-backed remediation guidance.
npx workspai doctor workspaceDiagnose cross-project workspace health, contracts, policies, toolchains, and operational evidence.
npx workspai readinessEvaluate whether current workspace evidence satisfies release-readiness requirements and blockers.
npx workspai workspace agent-syncProject current workspace context into governed agent instructions, reports, skills, and integration files.
npx workspai workspace contextBuild a scoped workspace context projection from the current model and evidence for human or agent consumption.
npx workspai workspace contractInspect and verify explicit workspace contracts.
npx workspai workspace diffCompare the current canonical workspace model with a snapshot or source-control baseline.
npx workspai workspace explainExplain a workspace relationship, project, or blocker from traceable model and evidence references.
npx workspai workspace feedbackRecord structured feedback about Workspace Intelligence output.
npx workspai workspace graphRender the current workspace dependency graph in a supported representation.
npx workspai workspace impactCalculate the blast radius of a workspace diff across projects, dependencies, tests, policies, and gates.
npx workspai workspace mcpExpose Workspace Intelligence through the MCP integration boundary.
npx workspai workspace modelDiscover and normalize workspace entities, relationships, ownership, runtime, contract, and evidence state.
npx workspai workspace remediation-planGenerate a structured remediation plan from current workspace evidence.
npx workspai workspace snapshotCapture a versioned workspace or model baseline for comparison and recovery.
npx workspai workspace traceTrace a change or finding through its evidence and dependency relationships.
npx workspai workspace verifyCombine impact, diagnostics, contracts, analysis, and readiness evidence into a governed verification verdict.
npx workspai workspace watchObserve relevant workspace changes and publish versioned watch events.
npx workspai workspace whyExplain why a relationship, verdict, or workspace fact exists.
Global
5 commands
npx workspai createCreate a supported workspace, project, or module through the canonical planner and generator boundary.
npx workspai frameworksList scaffold frameworks and kits currently supported by the installed CLI.
npx workspai infoReport detected project, runtime, workspace, and toolchain information for the current scope.
npx workspai licenseInspect or validate the effective Workspai license and feature entitlement state.
npx workspai listList detected or registered resources for the current command scope.
Lifecycle
8 commands
npx workspai buildRun the detected project build lifecycle through the owning runtime adapter.
npx workspai devRun the detected project development lifecycle with its runtime-specific development command.
npx workspai formatRun the detected project formatter while respecting workspace policy and runtime ownership.
npx workspai helpDisplay contextual CLI usage, arguments, options, and command discovery guidance.
npx workspai initInitialize dependencies and required setup for the active project or complete workspace scope.
npx workspai lintRun the detected project lint lifecycle under workspace compatibility and policy gates.
npx workspai startRun the detected project production or service-start lifecycle command.
npx workspai testRun the detected project test lifecycle under workspace compatibility and policy gates.
Module mutation
11 commands
npx workspai addAdd a supported module or capability to the active project through its runtime adapter.
npx workspai checkpointCapture a named project or workspace checkpoint that can anchor later comparison or recovery.
npx workspai diffCompare governed project state against a selected baseline and report the observed changes.
npx workspai mergeCombine supported governed configuration or project state through the owning runtime operation.
npx workspai modulesList supported project modules and their runtime-specific capability state.
npx workspai optimizeApply supported project optimization operations through the detected runtime adapter.
npx workspai reconcileReconcile detected project or workspace state with its governed metadata and registered configuration.
npx workspai rollbackRestore supported generated or governed state to the previous recorded operation boundary.
npx workspai snapshotManage governed workspace recovery snapshots independently from Workspace Intelligence model baselines.
npx workspai uninstallRemove a supported module, tool, or generated integration through its owning operation.
npx workspai upgradeUpgrade supported Workspai-managed dependencies or generated project capabilities.
NPM wrapper
16 commands
npx workspai adoptRegister an existing local repository as a governed Workspai project without recreating its source.
npx workspai aiManage AI configuration, recommendations, and embedding operations for the active workspace.
npx workspai autopilotCoordinate supported automated governance actions while preserving explicit evidence and release gates.
npx workspai autopilot releaseBuild a governed release proposal from current analysis, readiness, and verification evidence.
npx workspai bootstrapEstablish the selected workspace profile, toolchain, and dependency baseline before project execution.
npx workspai cacheInspect or clear Workspai cache entries used by workspace and project operations.
npx workspai configManage persisted Workspai CLI and provider configuration for the current user environment.
npx workspai doctor projectDiagnose the current project and emit structured project evidence.
npx workspai importCopy or clone an existing project into the workspace and register its detected runtime capabilities.
npx workspai infraManage governed infrastructure planning and lifecycle operations for the active workspace.
npx workspai mirrorManage local package or dependency mirrors used by offline and controlled development workflows.
npx workspai pipelineRun the governance pipeline from sync and diagnostics through analysis, readiness, verification, and optional release automation.
npx workspai productManage governed product manifests and factory planning operations.
npx workspai setupInstall or validate runtime-specific prerequisites required by the selected workspace profile.
npx workspai shellOpen a workspace-aware shell with resolved project, runtime, and toolchain context.
npx workspai workspaceDispatch workspace discovery, intelligence, governance, portability, and fleet lifecycle operations.
Project operations
25 commands
npx workspai ai generate-embeddingsGenerate the initial semantic embedding index from the current project or workspace sources.
npx workspai ai infoReport the active AI provider, model, and embedding configuration.
npx workspai ai recommendRecommend relevant modules or actions from the detected project context and configured AI provider.
npx workspai ai update-embeddingsRefresh the semantic embedding index after source or workspace context changes.
npx workspai config aiInspect or update the active AI provider, model, and embedding configuration.
npx workspai config remove-api-keyRemove a persisted provider API key from Workspai configuration.
npx workspai config set-api-keyStore a provider API key for authenticated AI operations.
npx workspai config showDisplay the effective Workspai configuration with secret values protected.
npx workspai docsGenerate or validate documentation through the detected project documentation lifecycle.
npx workspai infra downStop the workspace infrastructure stack and optionally remove governed volumes.
npx workspai infra planGenerate a versioned infrastructure plan without applying infrastructure changes.
npx workspai infra statusInspect infrastructure service state and expose a strict machine-checkable status verdict.
npx workspai infra upStart the workspace infrastructure stack from its governed configuration.
npx workspai product manifestInspect or create the product manifest that defines product factory inputs.
npx workspai product manifest createCreate a governed product manifest for product planning operations.
npx workspai product planGenerate a product factory plan from the current product definition.
npx workspai project archiveMove a project into governed archive storage while preserving registry metadata and recovery evidence.
npx workspai project archivesList governed project archives and their available restoration metadata.
npx workspai project commandsDiscover commands supported by the selected project runtime and its current capability tier.
npx workspai project deleteDelete a registered project through guarded workspace safety and recovery checks.
npx workspai project restoreRestore an archived project to its workspace path and reconcile registry ownership.
npx workspai snapshot createCreate a governed workspace snapshot for comparison or recovery.
npx workspai snapshot inspectInspect snapshot metadata, contents, and recovery compatibility without restoring it.
npx workspai snapshot listList governed workspace snapshots available for inspection or recovery.
npx workspai snapshot restoreRestore a governed snapshot through the workspace recovery boundary.
Universal
3 commands
npx workspai commandsPublish the installed CLI command inventory, ownership boundaries, aliases, options, and integrity verdict.
npx workspai projectExpose project-scoped command discovery, archive, restore, and deletion operations.
npx workspai versionReport the installed CLI version and published contract compatibility metadata.
Workspace operations
12 commands
npx workspai workspace archiveCreate or inspect a governed workspace archive.
npx workspai workspace exportExport workspace intelligence into a portable consumer representation.
npx workspai workspace foundationInspect or establish the foundational metadata required by workspace operations.
npx workspai workspace hydrateRestore or materialize workspace state from a portable representation.
npx workspai workspace importAttach an existing project or repository to the workspace inventory.
npx workspai workspace initInitialize workspace and project dependencies through the shared init flow.
npx workspai workspace listList registered workspaces through the canonical workspace discovery boundary.
npx workspai workspace policyInspect or update workspace governance policy.
npx workspai workspace registryInspect and maintain the canonical workspace registry boundary.
npx workspai workspace runRun a supported lifecycle command across registered workspace projects.
npx workspai workspace sharePrepare a governed workspace sharing surface.
npx workspai workspace syncReconcile registered projects and workspace identity with the current filesystem state.