Runbook: Control Plane

Auto-generated from ./src/control-plane/index.ts. Do not edit by hand — run node scripts/gen-runbooks.mjs.

Import path: personaforge/control-plane · Public symbols: 5 · Guide: /guide/control-plane

What it is

personaforge/control-plane is a public entry point of personaforge. Import it directly; you only pull in this feature's code (subpath exports are tree-shakeable and optional native deps load lazily).

Install

npm i personaforge
# or: bun add personaforge · pnpm add personaforge · yarn add personaforge

Import

import { createControlPlane } from 'personaforge/control-plane';

Public API surface

• Factories / functions — createControlPlane
• Interfaces — SystemSnapshot, ControlPlaneAgent, ControlPlaneConfig, ControlPlaneServer

Minimal use

Real example from the control-plane guide:

const cp = createControlPlane({
  agents: [
    { name: 'support', run: (prompt) => supportAgent.run(prompt) },
  ],
  sessionStore,
  evalStore,
  traceStore,
  approvalStore,
  knowledgeStore,
});

await cp.start(4100);
console.log('Control plane on http://localhost:4100');

Verify it works

• Type-check: npx tsc --noEmit resolves personaforge/control-plane with no missing-module error.
• Runtime: node -e "import('personaforge/control-plane').then(m => console.log(Object.keys(m)))" lists the exports above.
• Behavior: follow the runnable example in /guide/control-plane.

Common failures

• Cannot find module 'personaforge/control-plane' — package not installed or stale build; run npm i personaforge and rebuild.
• Cannot find module '<peer>' at call time — this feature lazy-loads an optional native/SDK dep; install the one named in the error.
• Type errors after upgrade — check CHANGELOG.md for the symbol you import; names above are the current contract.

Rollback

• Remove the import and the feature is gone from your bundle (subpaths are isolated; nothing else depends on importing it).
• Pin a known-good version: npm i personaforge@<version>.

Related

• Full index: /runbooks/ · llms.txt
• Concept guide: /guide/control-plane