project.json

{
  "$comment": "The one place the project says who it is. Everything that names the project, its home, its docs, or its contact reads this file or is checked against it (npm run check:project-facts). Change a value here and the check names every copy that has to follow.",
  "name": "switchboard",
  "displayName": "Switchboard",
  "npmPackage": "@coreplane/switchboard",
  "description": "Mention it in Slack and an agent reviews the PR, ships the fix, or answers the question \u2014 on the model you choose, with its tools running where you decide.",
  "organization": "coreplanelabs",
  "repository": "https://github.com/coreplanelabs/switchboard",
  "image": "ghcr.io/coreplanelabs/switchboard",
  "images": {
    "bot": "ghcr.io/coreplanelabs/switchboard",
    "resident": "ghcr.io/coreplanelabs/switchboard-resident",
    "sandbox": "ghcr.io/coreplanelabs/switchboard-sandbox"
  },
  "docs": "https://switchboard.space",
  "topics": [
    "ai-agents",
    "coding-agent",
    "code-review",
    "slack-bot",
    "github-app",
    "mcp-server",
    "cloudflare-workers",
    "llm",
    "typescript"
  ],
  "contact": "dev@coreplane.ai",
  "steward": {
    "name": "Coreplane Labs",
    "url": "https://coreplane.ai"
  },
  "commands": {
    "$comment": "What each root npm script does and when to run it \u2014 the source of the Commands table in AGENTS.md (npm run agents:gen). A script without an entry fails agents:check, so a new script cannot ship undocumented.",
    "verify": {
      "does": "Runs all repository and workspace CI checks.",
      "when": "Local human checks; CI selects affected checks."
    },
    "verify:root": {
      "does": "Runs the bot package's CI gates.",
      "when": "Bot changes; agents use affected checks."
    },
    "check:consistency": {
      "does": "The sub-second checks that generated and declared things equal the code, this table included.",
      "when": "After touching a generated or declared artifact; one CI leg."
    },
    "test": {
      "does": "The whole vitest suite from one entry, after `deploy:gen`.",
      "when": "Local sessions before pushing; CI runs it for relevant changes."
    },
    "typecheck": {
      "does": "TypeScript over the bot and its scripts, no emit.",
      "when": "After type-level changes; `verify:root` runs it. A pipeline agent scopes it to the touched tsconfig."
    },
    "lint": {
      "does": "ESLint over the whole tree.",
      "when": "`npm run fix` repairs what it can."
    },
    "lint:fix": {
      "does": "ESLint with autofix.",
      "when": "Part of `fix`."
    },
    "format": {
      "does": "Prettier over the whole tree (not Markdown).",
      "when": "Part of `fix`."
    },
    "format:check": {
      "does": "Prettier in check mode.",
      "when": "Part of `verify:root`."
    },
    "fix": {
      "does": "Regenerates every generated artifact and repairs lint and formatting.",
      "when": "Before committing; whenever `check:consistency` reports drift."
    },
    "build": {
      "does": "Compiles the bot to `dist/`.",
      "when": "`check:dist` and the Docker image run it; rarely by hand."
    },
    "start": {
      "does": "Runs the compiled bot from `dist/`.",
      "when": "Production entry (the container's CMD)."
    },
    "dev": {
      "does": "Runs the bot from source with tsx.",
      "when": "Local development against a real Slack app."
    },
    "cli": {
      "does": "Runs operator commands and sends asks through the dispatcher.",
      "when": "Smoke tests, deploys, config and run history."
    },
    "resident:archive": {
      "does": "Captures a retained resident and checks its offline restore.",
      "when": "Reviewed disposable rehearsal; verify the binding and builds."
    },
    "resident:retire": {
      "does": "Previews or retires one native scope.",
      "when": "When deploy is blocked."
    },
    "ci:gate": {
      "does": "Accepts successful CI legs or planned skips.",
      "when": "CI fan-out gates."
    },
    "ci:plan": {
      "does": "Selects checks and builds from the full diff; uncertainty runs all.",
      "when": "CI; locally with `-- --base <ref>`."
    },
    "check:lockfile": {
      "does": "Native packages carry Linux x64 and macOS arm64 variants; records mirror their `package.json`.",
      "when": "After a manifest edit or `npm install`; failures name the fix."
    },
    "check:sandbox-pair": {
      "does": "Each Worker on the `cloudflare/sandbox` image pins `@cloudflare/sandbox` to exactly its Dockerfile tag.",
      "when": "After bumping either half of a pair."
    },
    "check:pr-title": {
      "does": "Judges one PR title as the changelog line: grammar, type, scope, `!`.",
      "when": "`-- \"feat(scope): \u2026\"` before opening a PR; CI's `title` check."
    },
    "pr-title:gen": {
      "does": "Writes the title gate's types and scopes from the release config and the code map.",
      "when": "Part of `fix`."
    },
    "pr-title:check": {
      "does": "The committed title vocabulary equals its two sources.",
      "when": "Part of `check:consistency`."
    },
    "check:dist": {
      "does": "Builds the bot, rejects test files in dist/, and checks required runtime files.",
      "when": "Local checks and the CI image build."
    },
    "check:site": {
      "does": "Checks dashboard links against the built site.",
      "when": "Docs changes; part of verify."
    },
    "check:image": {
      "does": "Builds every Worker's image.",
      "when": "After touching a Dockerfile; needs Docker. One CI leg per image."
    },
    "check:project-facts": {
      "does": "Checks project names, URLs, contact and package metadata against `project.json`.",
      "when": "After project or community file changes; part of `check:consistency`."
    },
    "check:registry-drift": {
      "does": "Every example-config model ref still resolves against the pinned pi registry.",
      "when": "After a pi bump; part of `check:consistency`."
    },
    "skills:sync": {
      "does": "Vendors the skills listed in `skills/manifest.yaml`.",
      "when": "After changing the manifest; part of `fix`."
    },
    "skills:check": {
      "does": "The vendored skills match the manifest byte for byte.",
      "when": "Part of `check:consistency`."
    },
    "licenses:check": {
      "does": "Every production dependency's license is on the allowlist.",
      "when": "After adding a dependency."
    },
    "check:deps-drift": {
      "does": "Installed node_modules match the lockfile: drift fails by name.",
      "when": "Part of `check:consistency`."
    },
    "docs:gen": {
      "does": "Writes the generated regions of the reference docs from the command registry.",
      "when": "After changing a command, flag, route, or config key; part of `fix`."
    },
    "docs:check": {
      "does": "The generated doc regions equal what the code would generate.",
      "when": "Part of `check:consistency`."
    },
    "specs:check": {
      "does": "Checks spec proofs, headers and decision boundaries.",
      "when": "After test/spec edits; see [spec coverage](docs/reference/specs/specs-coverage.md)."
    },
    "specs:coverage": {
      "does": "Maps changed paths to specs and lists gaps.",
      "when": "Before review: `-- --changed origin/main...HEAD`; `-- --require` fails on gaps."
    },
    "decisions:check": {
      "does": "Checks decision and plan status, succession and amendment rules.",
      "when": "Part of `check:consistency`; supersede or amend failed records."
    },
    "hygiene:check": {
      "does": "The public tree's imprint (company, people, trackers, plan ids, ids, dates) equals the recorded list, which only shrinks.",
      "when": "Part of `check:consistency`. New hit: rewrite the line or allow it by name."
    },
    "hygiene:gen": {
      "does": "Records the tree's remaining imprint after a scrub; refuses growth unless `-- --force`.",
      "when": "Part of `fix`; new imprint fails it like `hygiene:check`."
    },
    "vocabulary:check": {
      "does": "No internal word prints on a user surface; the baseline only shrinks.",
      "when": "Part of `check:consistency`; a hit is rewritten in the user's nouns."
    },
    "vocabulary:gen": {
      "does": "Records the remaining internal words; refuses growth unless `-- --force`.",
      "when": "Part of `fix`."
    },
    "user-message:check": {
      "does": "No user-facing statement delegates recovery.",
      "when": "Part of `check:consistency`; the baseline only shrinks."
    },
    "agents:gen": {
      "does": "Writes the Commands table in AGENTS.md from `package.json` and this file.",
      "when": "After adding or changing a script; part of `fix`."
    },
    "agents:check": {
      "does": "AGENTS.md is under its size budget, its Commands table is current, and every root script is described here.",
      "when": "Part of `check:consistency`."
    },
    "clock:gen": {
      "does": "Regenerates both clock allowlists: wall-clock reads (empty) and duration literals outside `src/core/budgets.ts`.",
      "when": "Part of `fix`."
    },
    "clock:check": {
      "does": "No production file reads the wall clock directly or gained a duration literal outside `src/core/budgets.ts`; both allowlists match the tree.",
      "when": "Part of `check:consistency`."
    },
    "docs:changed": {
      "does": "Reports changed docs inputs.",
      "when": "One-commit diagnostics; CI uses ci:plan."
    },
    "deploy:gen": {
      "does": "Renders each Worker's gitignored `wrangler.jsonc` from its template and the profile in force.",
      "when": "`test`, each Worker's `verify` and `deploy all` run it; by hand before `wrangler dev`."
    },
    "deploy:check": {
      "does": "The rendered `wrangler.jsonc` files match `deploy:gen`.",
      "when": "When one looks hand-edited; change the template."
    },
    "deploy:targets": {
      "does": "Reports Workers selected by the diff.",
      "when": "CI summary and release PR comment."
    },
    "docs:dev": {
      "does": "Serves the docs site locally with live reload.",
      "when": "Writing docs; `-- --port <n>` picks the port."
    },
    "docs:build": {
      "does": "Builds the docs site to `docs/.vitepress/dist`.",
      "when": "Rarely by hand; `verify -w docs` and the docs Worker's deploy run it."
    },
    "web:preview": {
      "does": "Serves the dashboard bundle over fixtures for a visual check.",
      "when": "After a `web/` change."
    },
    "screenshots:gen": {
      "does": "Renders changed dashboard captures in both themes and records input hashes.",
      "when": "Paused; enable websiteMaintenance in project.json."
    },
    "screenshots:check": {
      "does": "Each surface's inputs still hash to what its screenshots were rendered from \u2014 no browser.",
      "when": "Skips while website maintenance is paused."
    },
    "load": {
      "does": "Load harness for infrastructure and route checks.",
      "when": "Model capacity receipts."
    },
    "smoke:ingress": {
      "does": "Checks three deployment capability families; --check makes no network request.",
      "when": "Configured disposable scope; release acceptance."
    },
    "staging:deploy": {
      "does": "Deploys isolated staging; --recreate plans explicit recreation.",
      "when": "Staging CI and explicit operator setup."
    },
    "installation:reset": {
      "does": "Resets data; keeps settings.",
      "when": "Preview, then approved apply."
    },
    "staging:reset": {
      "does": "Tests two staging resets.",
      "when": "Manual staging CI."
    },
    "staging:validate": {
      "does": "Checks PR eligibility before staging.",
      "when": "Staging CI and queued-head recheck."
    },
    "check:native-scope": {
      "does": "Tests the native gate and kill.",
      "when": "Docker; see the containment plan."
    },
    "staging:bootstrap-held": {
      "does": "Installs Resident support and keeps maintenance held.",
      "when": "Manual staging CI; separate readiness artifact."
    },
    "emoji:sync": {
      "does": "Downloads custom Slack emoji.",
      "when": "Manual; emoji:read."
    },
    "staging:recover": {
      "does": "Recovers a held reset.",
      "when": "CI preview; approved continuation."
    }
  },
  "websiteMaintenance": false
}