Compatibility / Capability contract
Extension Cli Compatibility V1
Defines the versioned extension cli compatibility v1 boundary used by Workspai and its consumers.
- Schema version
rapidkit-extension-cli-compatibility.v1- Contract path
contracts/extension-cli-compatibility.v1.json- Publication
- synced-supporting-contract
- Defined fields
- 67
- Artifact bindings
- 0
Why this contract exists
Architecture role
Defines a versioned interoperability boundary used by Workspai and contract-aware 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.
This is a supporting, capability, cache, compatibility, or consumer contract. It has no single direct producer command in the canonical Workspace Intelligence execution registry.
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 |
|---|---|---|---|---|
| cli | string | Yes | Published cli capability data. | — |
| minimumVerifiedCliVersion | string | Yes | Published minimumverifiedcliversion capability data. | — |
| publishedContractSchemas | object | Yes | Published publishedcontractschemas capability data. | — |
| publishedContractSchemas.agentActionOutcome | string | Yes | Published agentactionoutcome capability data. | — |
| publishedContractSchemas.agentCustomizationPackCapabilities | string | Yes | Published agentcustomizationpackcapabilities capability data. | — |
| publishedContractSchemas.agentCustomizationPackReport | string | Yes | Published agentcustomizationpackreport capability data. | — |
| publishedContractSchemas.agentHooks | string | Yes | Published agenthooks capability data. | — |
| publishedContractSchemas.agentReportsIndex | string | Yes | Published agentreportsindex capability data. | — |
| publishedContractSchemas.artifactRemediationPlan | string | Yes | Published artifactremediationplan capability data. | — |
| publishedContractSchemas.autopilotRelease | string | Yes | Published autopilotrelease capability data. | — |
| publishedContractSchemas.blockerResolution | string | Yes | Published blockerresolution capability data. | — |
| publishedContractSchemas.cliLogEvent | string | Yes | Published clilogevent capability data. | — |
| publishedContractSchemas.cliOperationResult | string | Yes | Published clioperationresult capability data. | — |
| publishedContractSchemas.cliRuntimeCommandInventory | string | Yes | Published cliruntimecommandinventory capability data. | — |
| publishedContractSchemas.compatibilityMatrix | string | Yes | Published compatibilitymatrix capability data. | — |
| publishedContractSchemas.doctorFixResult | string | Yes | Published doctorfixresult capability data. | — |
| publishedContractSchemas.doctorProjectScan | string | Yes | Published doctorprojectscan capability data. | — |
| publishedContractSchemas.doctorRemediationPlan | string | Yes | Published doctorremediationplan capability data. | — |
| publishedContractSchemas.doctorWorkspaceCache | string | Yes | Published doctorworkspacecache capability data. | — |
| publishedContractSchemas.factFreshness | string | Yes | Published factfreshness capability data. | — |
| publishedContractSchemas.freshnessMetadata | string | Yes | Published freshnessmetadata capability data. | — |
| publishedContractSchemas.infraPlan | string | Yes | Published infraplan capability data. | — |
| publishedContractSchemas.mcpDesign | string | Yes | Published mcpdesign capability data. | — |
| publishedContractSchemas.privateProductManifest | string | Yes | Published privateproductmanifest capability data. | — |
| publishedContractSchemas.productFactoryPlan | string | Yes | Published productfactoryplan capability data. | — |
| publishedContractSchemas.projectArchive | string | Yes | Published projectarchive capability data. | — |
| publishedContractSchemas.projectEntryCapability | string | Yes | Published projectentrycapability capability data. | — |
| publishedContractSchemas.publishedContractCatalog | string | Yes | Published publishedcontractcatalog capability data. | — |
| publishedContractSchemas.runtimeCommandSurface | string | Yes | Published runtimecommandsurface capability data. | — |
| publishedContractSchemas.workspaceArchiveCapabilities | string | Yes | Published workspacearchivecapabilities capability data. | — |
| publishedContractSchemas.workspaceArchiveManifest | string | Yes | Published workspacearchivemanifest capability data. | — |
| publishedContractSchemas.workspaceArchiveOperationResult | string | Yes | Published workspacearchiveoperationresult capability data. | — |
| publishedContractSchemas.workspaceContext | string | Yes | Published workspacecontext capability data. | — |
| publishedContractSchemas.workspaceDependencyGraph | string | Yes | Published workspacedependencygraph capability data. | — |
| publishedContractSchemas.workspaceExplain | string | Yes | Published workspaceexplain capability data. | — |
| publishedContractSchemas.workspaceImpact | string | Yes | Published workspaceimpact capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArchitecture | string | Yes | Published workspaceintelligencearchitecture capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts | object | Yes | Published workspaceintelligenceartifacts capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.agentContext | string | Yes | Published agentcontext capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.agentCustomizationPack | string | Yes | Published agentcustomizationpack capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.agentIndex | string | Yes | Published agentindex capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.agents | null | Yes | Published agents capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.analyze | string | Yes | Published analyze capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.contractVerify | string | Yes | Published contractverify capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.diff | string | Yes | Published diff capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.doctor | string | Yes | Published doctor capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.explain | string | Yes | Published explain capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.history | string | Yes | Published history capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.impact | string | Yes | Published impact capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.model | string | Yes | Published model capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.readiness | string | Yes | Published readiness capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.skillsIndex | string | Yes | Published skillsindex capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.snapshot | string | Yes | Published snapshot capability data. | — |
| publishedContractSchemas.workspaceIntelligenceArtifacts.verify | string | Yes | Published verify capability data. | — |
| publishedContractSchemas.workspaceIntelligenceChain | string | Yes | Published workspaceintelligencechain capability data. | — |
| publishedContractSchemas.workspaceIntelligenceHistory | string | Yes | Published workspaceintelligencehistory capability data. | — |
| publishedContractSchemas.workspaceList | string | Yes | Published workspacelist capability data. | — |
| publishedContractSchemas.workspaceModel | string | Yes | Published workspacemodel capability data. | — |
| publishedContractSchemas.workspaceModelCache | string | Yes | Published workspacemodelcache capability data. | — |
| publishedContractSchemas.workspaceOperationalSkill | string | Yes | Published workspaceoperationalskill capability data. | — |
| publishedContractSchemas.workspaceSkillsIndex | string | Yes | Published workspaceskillsindex capability data. | — |
| publishedContractSchemas.workspaceSnapshot | string | Yes | Published workspacesnapshot capability data. | — |
| publishedContractSchemas.workspaceSnapshotV2 | string | Yes | Published workspacesnapshotv2 capability data. | — |
| publishedContractSchemas.workspaceSync | string | Yes | Published workspacesync capability data. | — |
| publishedContractSchemas.workspaceVerify | string | Yes | Published workspaceverify capability data. | — |
| publishedContractSchemas.workspaceWatchEvent | string | Yes | Published workspacewatchevent capability data. | — |
| schemaVersion | string | Yes | Published schemaversion 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-extension-cli-compatibility.v1",
"cli": "workspai",
"minimumVerifiedCliVersion": "0.45.0",
"publishedContractSchemas": {
"runtimeCommandSurface": "rapidkit-runtime-command-surface-v1",
"cliRuntimeCommandInventory": "workspai-cli-runtime-command-inventory-v1",
"cliOperationResult": "workspai-cli-operation-result-v1",
"publishedContractCatalog": "workspai-published-contract-catalog-v1",
"workspaceArchiveCapabilities": "workspai-workspace-archive-capabilities-v1",
"workspaceArchiveManifest": "workspai-workspace-archive-manifest-v1",
"workspaceArchiveOperationResult": "workspai-workspace-archive-operation-result-v1",
"projectEntryCapability": "workspai-project-entry-capability-v1",
"workspaceIntelligenceArchitecture": "workspai-workspace-intelligence-architecture-v1",
"workspaceIntelligenceChain": "workspai-workspace-intelligence-chain-v1",
"workspaceIntelligenceArtifacts": {
"model": "workspace-model.v1",
"snapshot": "workspace-model-snapshot.v1",
"diff": "workspace-model-diff.v1",
"impact": "workspace-impact.v1",
"analyze": "rapidkit-analyze-v1",
"doctor": "doctor-workspace-evidence-v1",
"contractVerify": "workspace-contract-verify.v1",
"readiness": "release-readiness-v1",
"verify": "workspace-verify.v1",
"history": "workspace-intelligence-history.v1",
"agentContext": "workspace-context.v1",
"agentIndex": "rapidkit-agent-reports-index.v1",
"agentCustomizationPack": "rapidkit-agent-customization-pack.v1",
"skillsIndex": "workspace-skills-index.v1",
"agents": null,
"explain": "workspace-explain.v1"
},
"cliLogEvent": "cli-log-event-v1",
"freshnessMetadata": "rapidkit-freshness-metadata-v1",
"factFreshness": "rapidkit-fact-freshness-v1",
"blockerResolution": "rapidkit-blocker-resolution-v1",
"workspaceModel": "workspace-model.v1",
"workspaceImpact": "workspace-impact.v1",
"workspaceVerify": "workspace-verify.v1",
"workspaceContext": "workspace-context.v1",
"workspaceDependencyGraph": "workspace-dependency-graph.v1",
"workspaceIntelligenceHistory": "workspace-intelligence-history.v1",
"agentCustomizationPackCapabilities": "workspai-agent-customization-pack-capabilities.v1",
"agentCustomizationPackReport": "rapidkit-agent-customization-pack.v1",
"agentReportsIndex": "rapidkit-agent-reports-index.v1",
"workspaceOperationalSkill": "workspace-operational-skill.v1",
"workspaceSkillsIndex": "workspace-skills-index.v1",
"workspaceExplain": "workspace-explain.v1",
"agentActionOutcome": "agent-action-outcome.v1",
"doctorRemediationPlan": "doctor-remediation-plan-v2",
"artifactRemediationPlan": "artifact-remediation-plan-v1",
"doctorFixResult": "rapidkit-doctor-fix-result-v1",
"autopilotRelease": "autopilot-release-v1",
"workspaceList": "rapidkit-workspace-list-v1",
"workspaceSync": "rapidkit-workspace-sync-v1",
"compatibilityMatrix": "rapidkit.compatibility-matrix.v1",
"mcpDesign": "workspai-mcp-design.v1",
"agentHooks": "workspai-agent-hooks.v1",
"projectArchive": "rapidkit-project-archive-v1",
"workspaceSnapshot": "rapidkit-workspace-snapshot-v1",
"workspaceSnapshotV2": "rapidkit-workspace-snapshot-v2",
"infraPlan": "rapidkit.infra-plan.v1",
"privateProductManifest": "rapidkit.private-product-manifest.v1",
"productFactoryPlan": "rapidkit.product-factory-plan.v1",
"workspaceModelCache": "workspace-model-cache.v1",
"workspaceWatchEvent": "workspace-watch-event.v1",
"doctorProjectScan": "doctor-project-scan-v2",
"doctorWorkspaceCache": "doctor-workspace-cache-v2"
}
}