All contracts

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
capability-contract
Defined fields
128
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 pathTypeRequiredMeaningConstraints
clistringYesPublished cli capability data.
minimumVerifiedCliVersionstringYesPublished minimumverifiedcliversion capability data.
publishedContractSchemasobjectYesPublished publishedcontractschemas capability data.
publishedContractSchemas.adoptEffectsstringYesPublished adopteffects capability data.
publishedContractSchemas.agentActionOutcomestringYesPublished agentactionoutcome capability data.
publishedContractSchemas.agentBootstrapReceiptstringYesPublished agentbootstrapreceipt capability data.
publishedContractSchemas.agentCustomizationPackCapabilitiesstringYesPublished agentcustomizationpackcapabilities capability data.
publishedContractSchemas.agentCustomizationPackReportstringYesPublished agentcustomizationpackreport capability data.
publishedContractSchemas.agentHooksstringYesPublished agenthooks capability data.
publishedContractSchemas.agentReportsIndexstringYesPublished agentreportsindex capability data.
publishedContractSchemas.artifactRemediationPlanstringYesPublished artifactremediationplan capability data.
publishedContractSchemas.autopilotReleasestringYesPublished autopilotrelease capability data.
publishedContractSchemas.backendImportStackParitySnapshotstringYesPublished backendimportstackparitysnapshot capability data.
publishedContractSchemas.blockerResolutionstringYesPublished blockerresolution capability data.
publishedContractSchemas.bootstrapCompliancestringYesPublished bootstrapcompliance capability data.
publishedContractSchemas.cliLogEventstringYesPublished clilogevent capability data.
publishedContractSchemas.cliOperationResultstringYesPublished clioperationresult capability data.
publishedContractSchemas.cliRuntimeCommandInventorystringYesPublished cliruntimecommandinventory capability data.
publishedContractSchemas.commandCapabilitiesstringYesPublished commandcapabilities capability data.
publishedContractSchemas.compatibilityMatrixstringYesPublished compatibilitymatrix capability data.
publishedContractSchemas.createPlannerCapabilitiesstringYesPublished createplannercapabilities capability data.
publishedContractSchemas.doctorCapabilitiesstringYesPublished doctorcapabilities capability data.
publishedContractSchemas.doctorDependencyRepairTransactionstringYesPublished doctordependencyrepairtransaction capability data.
publishedContractSchemas.doctorDiagnosisstringYesPublished doctordiagnosis capability data.
publishedContractSchemas.doctorFixResultstringYesPublished doctorfixresult capability data.
publishedContractSchemas.doctorGraphDiagnosisstringYesPublished doctorgraphdiagnosis capability data.
publishedContractSchemas.doctorProjectEvidencestringYesPublished doctorprojectevidence capability data.
publishedContractSchemas.doctorProjectScanstringYesPublished doctorprojectscan capability data.
publishedContractSchemas.doctorReceiptstringYesPublished doctorreceipt capability data.
publishedContractSchemas.doctorRemediationPlanstringYesPublished doctorremediationplan capability data.
publishedContractSchemas.doctorRemediationPlanLegacystringYesPublished doctorremediationplanlegacy capability data.
publishedContractSchemas.doctorSummarystringYesPublished doctorsummary capability data.
publishedContractSchemas.doctorValidationstringYesPublished doctorvalidation capability data.
publishedContractSchemas.doctorWorkspaceCachestringYesPublished doctorworkspacecache capability data.
publishedContractSchemas.doctorWorkspaceEvidencestringYesPublished doctorworkspaceevidence capability data.
publishedContractSchemas.extensionCliCompatibilitystringYesPublished extensionclicompatibility capability data.
publishedContractSchemas.factFreshnessstringYesPublished factfreshness capability data.
publishedContractSchemas.freshnessMetadatastringYesPublished freshnessmetadata capability data.
publishedContractSchemas.goalAgentHandoffstringYesPublished goalagenthandoff capability data.
publishedContractSchemas.goalIndexstringYesPublished goalindex capability data.
publishedContractSchemas.goalLifecycleResultstringYesPublished goallifecycleresult capability data.
publishedContractSchemas.goalPackstringYesPublished goalpack capability data.
publishedContractSchemas.goalPlanResultstringYesPublished goalplanresult capability data.
publishedContractSchemas.infraPlanstringYesPublished infraplan capability data.
publishedContractSchemas.infraStackstringYesPublished infrastack capability data.
publishedContractSchemas.ingestionPlanstringYesPublished ingestionplan capability data.
publishedContractSchemas.ingestionResultstringYesPublished ingestionresult capability data.
publishedContractSchemas.mcpDesignstringYesPublished mcpdesign capability data.
publishedContractSchemas.mirrorOpsstringYesPublished mirrorops capability data.
publishedContractSchemas.modelUsageEventstringYesPublished modelusageevent capability data.
publishedContractSchemas.moduleLayoutstringYesPublished modulelayout capability data.
publishedContractSchemas.moduleSupportstringYesPublished modulesupport capability data.
publishedContractSchemas.pipelineLastRunstringYesPublished pipelinelastrun capability data.
publishedContractSchemas.privateProductManifeststringYesPublished privateproductmanifest capability data.
publishedContractSchemas.productFactoryPlanstringYesPublished productfactoryplan capability data.
publishedContractSchemas.projectAgentEntrystringYesPublished projectagententry capability data.
publishedContractSchemas.projectArchivestringYesPublished projectarchive capability data.
publishedContractSchemas.projectContextAgentstringYesPublished projectcontextagent capability data.
publishedContractSchemas.projectEntryCapabilitystringYesPublished projectentrycapability capability data.
publishedContractSchemas.projectTestCoveragestringYesPublished projecttestcoverage capability data.
publishedContractSchemas.projectWorkspaceLinkstringYesPublished projectworkspacelink capability data.
publishedContractSchemas.projectWorkspaceResolutionstringYesPublished projectworkspaceresolution capability data.
publishedContractSchemas.publishedContractCatalogstringYesPublished publishedcontractcatalog capability data.
publishedContractSchemas.runtimeCommandSurfacestringYesPublished runtimecommandsurface capability data.
publishedContractSchemas.studioBlockerHandoffstringYesPublished studioblockerhandoff capability data.
publishedContractSchemas.studioCardRepairCapabilitiesstringYesPublished studiocardrepaircapabilities capability data.
publishedContractSchemas.transparencyEvidencestringYesPublished transparencyevidence capability data.
publishedContractSchemas.verifiedGoalstringYesPublished verifiedgoal capability data.
publishedContractSchemas.verifiedGoalStatusstringYesPublished verifiedgoalstatus capability data.
publishedContractSchemas.versionstringYesPublished version capability data.
publishedContractSchemas.workspaceArchiveCapabilitiesstringYesPublished workspacearchivecapabilities capability data.
publishedContractSchemas.workspaceArchiveManifeststringYesPublished workspacearchivemanifest capability data.
publishedContractSchemas.workspaceArchiveOperationResultstringYesPublished workspacearchiveoperationresult capability data.
publishedContractSchemas.workspaceContextstringYesPublished workspacecontext capability data.
publishedContractSchemas.workspaceContractnumberYesPublished workspacecontract capability data.
publishedContractSchemas.workspaceDependencyGraphstringYesPublished workspacedependencygraph capability data.
publishedContractSchemas.workspaceExplainstringYesPublished workspaceexplain capability data.
publishedContractSchemas.workspaceGraphStreamstringYesPublished workspacegraphstream capability data.
publishedContractSchemas.workspaceGraphTokenEfficiencystringYesPublished workspacegraphtokenefficiency capability data.
publishedContractSchemas.workspaceImpactstringYesPublished workspaceimpact capability data.
publishedContractSchemas.workspaceIntelligenceArchitecturestringYesPublished workspaceintelligencearchitecture capability data.
publishedContractSchemas.workspaceIntelligenceArtifactsobjectYesPublished workspaceintelligenceartifacts capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.agentContextstringYesPublished agentcontext capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.agentCustomizationPackstringYesPublished agentcustomizationpack capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.agentIndexstringYesPublished agentindex capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.agentsnullYesPublished agents capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.analyzestringYesPublished analyze capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.contractVerifystringYesPublished contractverify capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.diffstringYesPublished diff capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.doctorstringYesPublished doctor capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.evaluationLastRunstringYesPublished evaluationlastrun capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.evaluationLivestringYesPublished evaluationlive capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.explainstringYesPublished explain capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.historystringYesPublished history capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.impactstringYesPublished impact capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.intelligenceRunstringYesPublished intelligencerun capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.knowledgeGraphstringYesPublished knowledgegraph capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.modelstringYesPublished model capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.readinessstringYesPublished readiness capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.repairTransactionstringYesPublished repairtransaction capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.skillsIndexstringYesPublished skillsindex capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.snapshotstringYesPublished snapshot capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.verifiedGoalStatusstringYesPublished verifiedgoalstatus capability data.
publishedContractSchemas.workspaceIntelligenceArtifacts.verifystringYesPublished verify capability data.
publishedContractSchemas.workspaceIntelligenceChainstringYesPublished workspaceintelligencechain capability data.
publishedContractSchemas.workspaceIntelligenceEvaluationstringYesPublished workspaceintelligenceevaluation capability data.
publishedContractSchemas.workspaceIntelligenceEvaluationComparisonstringYesPublished workspaceintelligenceevaluationcomparison capability data.
publishedContractSchemas.workspaceIntelligenceHistorystringYesPublished workspaceintelligencehistory capability data.
publishedContractSchemas.workspaceKnowledgeGraphstringYesPublished workspaceknowledgegraph capability data.
publishedContractSchemas.workspaceKnowledgeGraphChangeOverlaystringYesPublished workspaceknowledgegraphchangeoverlay capability data.
publishedContractSchemas.workspaceKnowledgeSearchstringYesPublished workspaceknowledgesearch capability data.
publishedContractSchemas.workspaceListstringYesPublished workspacelist capability data.
publishedContractSchemas.workspaceModelstringYesPublished workspacemodel capability data.
publishedContractSchemas.workspaceModelCachestringYesPublished workspacemodelcache capability data.
publishedContractSchemas.workspaceOperationalSkillstringYesPublished workspaceoperationalskill capability data.
publishedContractSchemas.workspaceRegistrystringYesPublished workspaceregistry capability data.
publishedContractSchemas.workspaceRepairCapabilitiesstringYesPublished workspacerepaircapabilities capability data.
publishedContractSchemas.workspaceRepairProposalstringYesPublished workspacerepairproposal capability data.
publishedContractSchemas.workspaceRepairTransactionstringYesPublished workspacerepairtransaction capability data.
publishedContractSchemas.workspaceRunLaststringYesPublished workspacerunlast capability data.
publishedContractSchemas.workspaceShareBundlestringYesPublished workspacesharebundle capability data.
publishedContractSchemas.workspaceSkillsIndexstringYesPublished workspaceskillsindex capability data.
publishedContractSchemas.workspaceSnapshotstringYesPublished workspacesnapshot capability data.
publishedContractSchemas.workspaceSnapshotV2stringYesPublished workspacesnapshotv2 capability data.
publishedContractSchemas.workspaceSyncstringYesPublished workspacesync capability data.
publishedContractSchemas.workspaceVerifystringYesPublished workspaceverify capability data.
publishedContractSchemas.workspaceWatchEventstringYesPublished workspacewatchevent capability data.
schemaVersionstringYesPublished 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.61.0",
  "publishedContractSchemas": {
    "workspaceContract": 1,
    "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",
    "ingestionPlan": "workspai.ingestion-plan.v1",
    "ingestionResult": "workspai.ingestion-result.v1",
    "adoptEffects": "workspai.adopt-effects.v1",
    "projectEntryCapability": "workspai-project-entry-capability-v1",
    "projectWorkspaceLink": "project-workspace-link.v1",
    "projectWorkspaceResolution": "project-workspace-resolution.v1",
    "projectContextAgent": "project-context-agent.v1",
    "projectAgentEntry": "workspai.agent-entry.v1",
    "agentBootstrapReceipt": "workspai.agent-bootstrap-receipt.v1",
    "doctorProjectEvidence": "doctor-project-evidence-v1",
    "doctorWorkspaceEvidence": "doctor-workspace-evidence-v1",
    "doctorGraphDiagnosis": "doctor-graph-diagnosis.v1",
    "doctorDiagnosis": "workspai.doctor-diagnosis.v1",
    "doctorCapabilities": "workspai.doctor-capabilities.v1",
    "doctorValidation": "workspai.doctor-validation.v1",
    "doctorReceipt": "workspai.doctor-receipt.v1",
    "doctorSummary": "workspai.doctor-summary.v1",
    "projectTestCoverage": "workspai.project-test-coverage.v1",
    "verifiedGoal": "workspai.verified-goal.v1",
    "verifiedGoalStatus": "workspai.verified-goal-status.v1",
    "goalPack": "workspai.goal-pack.v1",
    "goalAgentHandoff": "workspai.goal-agent-handoff.v1",
    "goalPlanResult": "workspai.goal-plan-result.v1",
    "goalIndex": "workspai.goal-index.v1",
    "goalLifecycleResult": "workspai.goal-lifecycle-result.v1",
    "workspaceIntelligenceArchitecture": "workspai-workspace-intelligence-architecture-v1",
    "workspaceIntelligenceChain": "workspai-workspace-intelligence-chain-v1",
    "workspaceIntelligenceArtifacts": {
      "model": "workspace-model.v1",
      "knowledgeGraph": "workspace-knowledge-graph.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",
      "intelligenceRun": "workspace-intelligence-run.v1",
      "evaluationLive": "workspace-intelligence-evaluation.v1",
      "evaluationLastRun": "workspace-intelligence-evaluation.v1",
      "verifiedGoalStatus": "workspai.verified-goal-status.v1",
      "repairTransaction": "workspai.workspace-repair-transaction.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",
    "workspaceKnowledgeGraph": "workspace-knowledge-graph.v1",
    "workspaceGraphStream": "workspace-graph-stream.v1",
    "workspaceKnowledgeGraphChangeOverlay": "workspace-knowledge-graph-change-overlay.v1",
    "workspaceKnowledgeSearch": "workspace-knowledge-search.v1",
    "workspaceGraphTokenEfficiency": "workspace-graph-token-efficiency.v1",
    "modelUsageEvent": "model-usage-event.v1",
    "workspaceIntelligenceEvaluation": "workspace-intelligence-evaluation.v1",
    "workspaceIntelligenceEvaluationComparison": "workspace-intelligence-evaluation-comparison.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",
    "doctorDependencyRepairTransaction": "workspai.doctor-dependency-repair-transaction.v1",
    "artifactRemediationPlan": "artifact-remediation-plan-v1",
    "studioCardRepairCapabilities": "workspai.studio-card-repair-capabilities.v1",
    "workspaceRepairProposal": "workspai.workspace-repair-proposal.v1",
    "workspaceRepairCapabilities": "workspai.workspace-repair-capabilities.v1",
    "workspaceRepairTransaction": "workspai.workspace-repair-transaction.v1",
    "doctorFixResult": "rapidkit-doctor-fix-result-v1",
    "backendImportStackParitySnapshot": "backend-import-stack-parity-v1",
    "bootstrapCompliance": "bootstrap-compliance.v1",
    "commandCapabilities": "rapidkit-command-capabilities-v1",
    "createPlannerCapabilities": "rapidkit-create-planner-capabilities-v1",
    "doctorRemediationPlanLegacy": "doctor-remediation-plan-v2",
    "extensionCliCompatibility": "rapidkit-extension-cli-compatibility.v1",
    "infraStack": "rapidkit.infra-stack.v1",
    "mirrorOps": "mirror-ops.v1",
    "moduleLayout": "rapidkit.module-layout.v1",
    "moduleSupport": "rapidkit-module-support-v1",
    "pipelineLastRun": "rapidkit-pipeline-v1",
    "transparencyEvidence": "transparency-evidence.v1",
    "version": "rapidkit-version-v1",
    "studioBlockerHandoff": "rapidkit-studio-blocker-handoff-v1",
    "workspaceRegistry": "workspace-registry.v1",
    "workspaceRunLast": "workspace-run-v1",
    "workspaceShareBundle": "1.1",
    "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"
  }
}