All contracts

Platform contracts / Capability contract

Create Planner Capabilities V1

Defines the versioned create planner capabilities v1 boundary used by Workspai and its consumers.

Schema version
rapidkit-create-planner-capabilities-v1
Contract path
contracts/create-planner-capabilities.v1.json
Publication
synced-supporting-contract
Defined fields
34
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
  • Contract-aware integrations

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
existingRuntimeSignalsarrayYesPublished existingruntimesignals capability data.
existingRuntimeSignals[]stringYesPublished existingruntimesignals[] capability data.
lanesobjectYesPublished lanes capability data.
lanes.existingobjectYesPublished existing capability data.
lanes.existing.meaningstringYesPublished meaning capability data.
lanes.existing.statusstringYesPublished status capability data.
lanes.nativeobjectYesPublished native capability data.
lanes.native.meaningstringYesPublished meaning capability data.
lanes.native.statusstringYesPublished status capability data.
lanes.officialobjectYesPublished official capability data.
lanes.official.meaningstringYesPublished meaning capability data.
lanes.official.statusstringYesPublished status capability data.
nativeCreatearrayYesPublished nativecreate capability data.
nativeCreate[]objectYesPublished nativecreate[] capability data.
nativeCreate[].frameworkstringYesPublished framework capability data.
nativeCreate[].idstringYesPublished id capability data.
nativeCreate[].moduleSupportbooleanYesPublished modulesupport capability data.
nativeCreate[].ownerstringYesPublished owner capability data.
nativeCreate[].runtimestringYesPublished runtime capability data.
nativeCreate[].stabilitystringYesPublished stability capability data.
officialCreatearrayYesPublished officialcreate capability data.
officialCreate[]objectYesPublished officialcreate[] capability data.
officialCreate[].adoptAfterCreatebooleanYesPublished adoptaftercreate capability data.
officialCreate[].aliasesarrayYesPublished aliases capability data.
officialCreate[].aliases[]stringYesPublished aliases[] capability data.
officialCreate[].canExecuteCreatebooleanYesPublished canexecutecreate capability data.
officialCreate[].ecosystemstringYesPublished ecosystem capability data.
officialCreate[].idstringYesPublished id capability data.
officialCreate[].officialCommandsarrayYesPublished officialcommands capability data.
officialCreate[].officialCommands[]stringYesPublished officialcommands[] capability data.
officialCreate[].statusstringYesPublished status capability data.
productRulesarrayYesPublished productrules capability data.
productRules[]stringYesPublished productrules[] 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-create-planner-capabilities-v1",
  "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."
    }
  },
  "nativeCreate": [
    {
      "id": "fastapi.standard",
      "runtime": "python",
      "framework": "fastapi",
      "owner": "core",
      "stability": "stable",
      "moduleSupport": true
    },
    {
      "id": "fastapi.ddd",
      "runtime": "python",
      "framework": "fastapi",
      "owner": "core",
      "stability": "stable",
      "moduleSupport": true
    },
    {
      "id": "nestjs.standard",
      "runtime": "node",
      "framework": "nestjs",
      "owner": "core",
      "stability": "stable",
      "moduleSupport": true
    },
    {
      "id": "springboot.standard",
      "runtime": "java",
      "framework": "springboot",
      "owner": "npm",
      "stability": "stable",
      "moduleSupport": false
    },
    {
      "id": "gofiber.standard",
      "runtime": "go",
      "framework": "gofiber",
      "owner": "npm",
      "stability": "stable",
      "moduleSupport": false
    },
    {
      "id": "gogin.standard",
      "runtime": "go",
      "framework": "gogin",
      "owner": "npm",
      "stability": "stable",
      "moduleSupport": false
    },
    {
      "id": "dotnet.webapi.clean",
      "runtime": "dotnet",
      "framework": "dotnet",
      "owner": "npm",
      "stability": "preview",
      "moduleSupport": false
    }
  ],
  "officialCreate": [
    {
      "id": "frontend.nextjs",
      "aliases": [
        "frontend.nextjs",
        "next",
        "nextjs",
        "next.js"
      ],
      "ecosystem": "nextjs",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npx create-next-app@latest <name>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.remix",
      "aliases": [
        "frontend.remix",
        "remix",
        "remix-run",
        "react-router"
      ],
      "ecosystem": "remix",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npx create-react-router@latest <name>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.vite-react",
      "aliases": [
        "frontend.vite-react",
        "vite-react",
        "react",
        "vite.react"
      ],
      "ecosystem": "react",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npm create vite@latest <name> -- --template react-ts"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.vite-vue",
      "aliases": [
        "frontend.vite-vue",
        "vite-vue",
        "vue",
        "vite.vue"
      ],
      "ecosystem": "vue",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npm create vite@latest <name> -- --template vue-ts"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.vite-svelte",
      "aliases": [
        "frontend.vite-svelte",
        "vite-svelte",
        "svelte",
        "vite.svelte"
      ],
      "ecosystem": "svelte",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npm create vite@latest <name> -- --template svelte-ts"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.vite-solid",
      "aliases": [
        "frontend.vite-solid",
        "vite-solid",
        "solid",
        "solidjs",
        "vite.solid"
      ],
      "ecosystem": "solid",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npm create vite@latest <name> -- --template solid-ts"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.vite-vanilla",
      "aliases": [
        "frontend.vite-vanilla",
        "vite",
        "vanilla",
        "vite-vanilla"
      ],
      "ecosystem": "vite",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npm create vite@latest <name> -- --template vanilla-ts"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.nuxt",
      "aliases": [
        "frontend.nuxt",
        "nuxt",
        "nuxtjs",
        "nuxt.js"
      ],
      "ecosystem": "nuxt",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npx create-nuxt@latest <name> --template minimal --packageManager npm --gitInit true"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.angular",
      "aliases": [
        "frontend.angular",
        "angular",
        "ng"
      ],
      "ecosystem": "angular",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npx @angular/cli@19 new <name>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.astro",
      "aliases": [
        "frontend.astro",
        "astro"
      ],
      "ecosystem": "astro",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npm create astro@4 <name>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "frontend.sveltekit",
      "aliases": [
        "frontend.sveltekit",
        "sveltekit",
        "svelte-kit"
      ],
      "ecosystem": "sveltekit",
      "status": "available",
      "canExecuteCreate": true,
      "officialCommands": [
        "npx sv@latest create <name>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "wordpress-site",
      "aliases": [
        "wordpress",
        "wordpress-site",
        "wp",
        "wp-site"
      ],
      "ecosystem": "wordpress",
      "status": "planned",
      "canExecuteCreate": false,
      "officialCommands": [
        "wp core download",
        "wp config create",
        "wp db create",
        "wp core install"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "wordpress-block",
      "aliases": [
        "wordpress-block",
        "wp-block",
        "gutenberg-block"
      ],
      "ecosystem": "wordpress",
      "status": "planned",
      "canExecuteCreate": false,
      "officialCommands": [
        "npx @wordpress/create-block@latest <slug>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "laravel",
      "aliases": [
        "laravel",
        "php-laravel"
      ],
      "ecosystem": "php",
      "status": "planned",
      "canExecuteCreate": false,
      "officialCommands": [
        "composer create-project laravel/laravel <name>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "symfony",
      "aliases": [
        "symfony",
        "php-symfony"
      ],
      "ecosystem": "php",
      "status": "planned",
      "canExecuteCreate": false,
      "officialCommands": [
        "composer create-project symfony/skeleton <name>"
      ],
      "adoptAfterCreate": true
    },
    {
      "id": "rails",
      "aliases": [
        "rails",
        "ruby-on-rails",
        "ruby-rails"
      ],
      "ecosystem": "ruby",
      "status": "planned",
      "canExecuteCreate": false,
      "officialCommands": [
        "rails new <name>"
      ],
      "adoptAfterCreate": true
    }
  ],
  "existingRuntimeSignals": [
    "php",
    "ruby",
    "rust",
    "elixir",
    "clojure",
    "scala",
    "kotlin"
  ],
  "productRules": [
    "Do not translate unsupported stack requests into unrelated native kits.",
    "If native create is unavailable, explain the lane and guide to adopt/import.",
    "The existing lane is open-ended for readable projects; existingRuntimeSignals are examples for planner detection, not an allowlist.",
    "Use the same capability contract in CLI, CI, VS Code, and AI planning surfaces."
  ]
}