@sublang/playbook 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,181 @@
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+<!-- SPDX-FileCopyrightText: 2026 SubLang International <https://sublang.ai> -->
+
+# playbook
+
+[![npm version](https://img.shields.io/npm/v/@sublang/playbook)](https://www.npmjs.com/package/@sublang/playbook)
+[![Node.js](https://img.shields.io/node/v/@sublang/playbook)](https://nodejs.org/)
+[![CI](https://github.com/sublang-ai/playbook/actions/workflows/ci.yml/badge.svg)](https://github.com/sublang-ai/playbook/actions/workflows/ci.yml)
+
+*Skills made reliable through state machines and visualization.*
+
+playbook is a compiler stack and reference implementation for turning a
+natural-language procedure into a runnable, inspectable state-machine
+agent — a *playbook* — that orchestrates other AI agents (players) per a
+spec written in plain prose. Three phases take prose to runtime:
+
+1. **text → GEARS** ([slc/text2gears.md](slc/text2gears.md)) — normative
+   spec items, one per state behavior, partitioned by trigger and prompt
+   content.
+2. **GEARS → FSM** ([slc/gears2fsm.md](slc/gears2fsm.md)) — an XState v5
+   finite state machine; each gear maps to one captain-invoking state
+   with a typed Captain actor contract.
+3. **FSM → runtime** ([slc/link.md](slc/link.md)) — a host-agnostic
+   module that drives Boss turns through ports the host wires up
+   (cligent's `tmux-play` is one such host).
+
+The repository is itself an end-to-end worked example: this
+package — `@sublang/playbook` — is the SDLC coding workflow,
+generated from [`reference/sdlc/code.md`](reference/sdlc/code.md)
+as its prose source. The runtime drives a coder / reviewer /
+committer loop end to end.
+
+## Getting started — the reference CODE playbook
+
+The reference is the canonical worked example —
+[CODE source](reference/sdlc/code.md) →
+[gears](code.gears.md) →
+[FSM](code.fsm.ts) → runtime — with the
+runtime ported to cligent's `tmux-play` host out of the box.
+
+### Install (users)
+
+Install the package globally alongside its `@sublang/cligent` peer:
+
+```sh
+npm install -g @sublang/playbook @sublang/cligent
+```
+
+Then launch the reference playbook in a `tmux-play` session:
+
+```sh
+playbook-code
+```
+
+The `playbook-code` bin resolves the bundled
+`tmux-play.production.config.yaml` and execs `tmux-play` against it; any
+extra flags pass through (`playbook-code --help` lists `tmux-play`'s).
+
+### Install (contributors / from source)
+
+Clone, install, and run the suite locally:
+
+```sh
+git clone https://github.com/sublang-ai/playbook.git
+cd playbook
+pnpm install
+pnpm build
+pnpm test
+```
+
+`pnpm install` resolves `@sublang/cligent` (≥ 0.3.0) from the registry;
+no local link required. To point pnpm at a local `cligent` checkout
+instead, copy
+[`pnpm-workspace.yaml.example`](pnpm-workspace.yaml.example)
+into place; the override is gitignored so it never leaks into a
+production install.
+
+Drive a Boss turn against the source tree (uses the developer
+[`tmux-play.config.yaml`](tmux-play.config.yaml)
+that imports the compiled adapter via relative path):
+
+```sh
+pnpm exec tmux-play --config tmux-play.config.yaml
+```
+
+`pnpm exec` resolves `tmux-play` from the package's local
+`node_modules/.bin/`, so this works whether or not `@sublang/cligent` is
+installed globally.
+
+### Running a Boss turn
+
+The Boss pane accepts four slash commands per
+[PBRT-1](specs/user/playbook-runtime.md#pbrt-1):
+
+- `/start <intent>` — begin a single coding turn
+- `/continue <#>` — pick up an IR task
+- `/summarize <#>` — turn an IR's commits into spec items
+- `/interrupt <stateId> [intent]` — preempt the FSM into a named state
+
+Anything else falls through to an LLM classifier. The Captain pane
+streams the state machine progression with a four-glyph vocabulary —
+`◆ ▸ ⮕ ⤷` per [PBRT-3](specs/user/playbook-runtime.md#pbrt-3) — while
+player prompts ride their own panes.
+
+### Embedding the runtime in your own host
+
+The runtime is host-agnostic; the `tmux-play` adapter is one host.
+Construct the runtime against your own ports:
+
+```ts
+import createPlaybookRuntime, {
+  type PlaybookPorts,
+} from '@sublang/playbook/code/playbook';
+
+const ports: PlaybookPorts = {
+  callPlayer: async (playerId, prompt, signal) => { /* … */ },
+  callJudge: async (prompt, signal) => { /* … */ },
+  emitStatus: async (message, data) => { /* … */ },
+  emitTelemetry: async ({ topic, payload }) => { /* … */ },
+};
+
+const runtime = createPlaybookRuntime({
+  coderPlayer: 'claude',
+  reviewerPlayer: 'codex',
+});
+
+await runtime.init(ports);
+await runtime.handleBossInput({
+  text: '/start fix the bug',
+  signal: new AbortController().signal,
+});
+await runtime.dispose();
+```
+
+See
+[`code.playbook.test.ts`](code.playbook.test.ts)
+for the full range of port shapes (classifier, judge, abort, interrupt,
+status/telemetry) the runtime is contract-tested against.
+
+## Workflow
+
+playbook is itself spec-driven: the compiler phases are specs in `slc/`,
+and the reference playbook is regenerated from its prose source. The
+loop:
+
+1. **Edit source.** For the reference, that's
+   [`reference/sdlc/code.md`](reference/sdlc/code.md).
+2. **Recompile gears** per [`slc/text2gears.md`](slc/text2gears.md) into
+   the package's `code.gears.md`.
+3. **Recompile FSM** per [`slc/gears2fsm.md`](slc/gears2fsm.md) into
+   the package's `code.fsm.ts`.
+4. **Sync runtime, tests, and downstream specs** so `pnpm test` stays
+   green and the introspect contract holds 1:1 between gear items and
+   FSM captain-invoking states.
+5. **Commit** with co-author trailers per
+   [`specs/dev/git.md`](specs/dev/git.md).
+
+The behavioral contract between gears and FSM
+([PLAYBOOK-1..6](specs/dev/playbook.md)) and the runtime contract that
+ports satisfy ([PBRT-5..16](specs/dev/playbook-runtime.md)) are pinned
+in [`specs/dev/`](specs/dev/) and verified by tests under the reference
+package.
+
+## Requirements
+
+- Node.js ≥ 20
+- pnpm 9 (for the reference package)
+- A configured `tmux-play` host (for live Boss turns)
+
+## Contributing
+
+We welcome contributions of all kinds.
+
+- 🌟 Star our repo if you find playbook useful.
+- [Open an issue](https://github.com/sublang-ai/playbook/issues) for bugs or feature requests.
+- [Open a PR](https://github.com/sublang-ai/playbook/pulls) for fixes or improvements.
+- Discuss on [Discord](https://discord.gg/XxTPjNqy9g) for support or new ideas.
+
+## License
+
+[Apache-2.0](LICENSE)

package/bin/playbook-code.js

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2026 SubLang International <https://sublang.ai>
+
+// Thin shim that resolves the bundled tmux-play.production.config.yaml
+// relative to this script's own location and execs `tmux-play` against
+// it. Extra argv is forwarded verbatim, so callers can pass flags like
+// --window or override the config with a later --config of their own
+// (tmux-play uses the last --config wins).
+//
+// `tmux-play` is provided by the @sublang/cligent peer; this shim
+// expects it to be discoverable on PATH (npm install -g or a project's
+// node_modules/.bin).
+
+import { spawn } from 'node:child_process';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const here = dirname(fileURLToPath(import.meta.url));
+const configPath = resolve(here, '..', 'tmux-play.production.config.yaml');
+
+const child = spawn(
+  'tmux-play',
+  ['--config', configPath, ...process.argv.slice(2)],
+  { stdio: 'inherit' },
+);
+
+child.on('error', (err) => {
+  const reason = err && err.code === 'ENOENT' ? 'not found on PATH' : err.message;
+  process.stderr.write(
+    `playbook-code: failed to launch tmux-play: ${reason}\n` +
+      "Install @sublang/cligent (which provides 'tmux-play') alongside @sublang/playbook.\n",
+  );
+  process.exit(127);
+});
+
+child.on('exit', (code, signal) => {
+  if (signal) process.kill(process.pid, signal);
+  else process.exit(code ?? 0);
+});

package/code.fsm.d.ts

@@ -0,0 +1,86 @@
+type Player = 'Coder' | 'Reviewer' | 'Committer';
+type JumpableStateId = 'ready' | 'planAndImplement' | 'respondToReview' | 'continueIr' | 'summarizeSpecs' | 'reviewBossCommitSpecs' | 'reviewBossCommitCode' | 'reviewBossCommitMixed' | 'reviewIrTaskCommitSpecs' | 'reviewIrTaskCommitCode' | 'reviewIrTaskCommitMixed' | 'reviewChangesSpecs' | 'reviewChangesCode' | 'reviewChangesMixed' | 'reviewChangesAndChallengesSpecs' | 'reviewChangesAndChallengesCode' | 'reviewChangesAndChallengesMixed' | 'adjudicateChallenges' | 'commitCoderInitial' | 'commitJoint' | 'failed';
+type WorkflowKind = 'singleCommit' | 'iteration' | 'specSummary';
+type ChangeOrigin = 'bossIntent' | 'irTask';
+type ReviewSubject = 'commit' | 'changes';
+type AfterReview = 'continueIr' | 'summarizeSpecs' | 'done';
+export type CaptainInput = {
+    player: Player;
+    sourceItem: string;
+    prompt: string;
+    result: Record<string, string>;
+    intent?: string;
+    irNumber?: string;
+    taskDescription?: string;
+    reviews?: string;
+    challenges?: string;
+    coderPlayer?: string;
+    reviewerPlayer?: string;
+};
+export type CaptainOutput = {
+    guard: string;
+    irNumber?: string;
+    taskDescription?: string;
+    reviews?: string;
+    challenges?: string;
+    summary?: string;
+    [k: string]: unknown;
+};
+export type CodingInput = {
+    intent?: string;
+    irNumber?: string;
+    coderPlayer?: string;
+    reviewerPlayer?: string;
+    committerPlayer?: string;
+};
+export type CodingContext = CodingInput & {
+    workflow?: WorkflowKind;
+    changeOrigin?: ChangeOrigin;
+    reviewSubject?: ReviewSubject;
+    afterReview?: AfterReview;
+    taskDescription?: string;
+    reviews?: string;
+    challenges?: string;
+    lastResult?: CaptainOutput;
+    lastError?: unknown;
+};
+export type CodingEvent = {
+    type: 'START_CODING';
+    intent: string;
+} | {
+    type: 'CONTINUE_IR';
+    irNumber: string;
+} | {
+    type: 'SUMMARIZE_IR';
+    irNumber: string;
+} | {
+    type: 'BOSS_INTERRUPT';
+    targetId: JumpableStateId;
+    intent?: string;
+    irNumber?: string;
+};
+export declare const codingMachine: import("xstate").StateMachine<CodingContext, {
+    type: "START_CODING";
+    intent: string;
+} | {
+    type: "CONTINUE_IR";
+    irNumber: string;
+} | {
+    type: "SUMMARIZE_IR";
+    irNumber: string;
+} | {
+    type: "BOSS_INTERRUPT";
+    targetId: JumpableStateId;
+    intent?: string;
+    irNumber?: string;
+}, {
+    [x: string]: import("xstate").ActorRefFromLogic<import("xstate").PromiseActorLogic<CaptainOutput, CaptainInput, import("xstate").EventObject>> | undefined;
+}, {
+    src: "captain";
+    logic: import("xstate").PromiseActorLogic<CaptainOutput, CaptainInput, import("xstate").EventObject>;
+    id: string | undefined;
+}, never, never, never, {}, string, CodingInput, import("xstate").NonReducibleUnknown, import("xstate").EventObject, import("xstate").MetaObject, {
+    states?: {} | undefined;
+    id?: string | undefined | undefined;
+}>;
+export {};

package/code.fsm.introspect.d.ts

@@ -0,0 +1,30 @@
+import type { CaptainInput, CodingContext, codingMachine } from './code.fsm.js';
+export interface CaptainStateInfo {
+    readonly stateId: string;
+    readonly sourceItem: string;
+    readonly getInput: (context: Partial<CodingContext>) => CaptainInput;
+    readonly transitions: ReadonlyArray<CaptainTransition>;
+}
+export interface CaptainTransition {
+    readonly index: number;
+    readonly target: string;
+    readonly guard: TransitionGuard;
+}
+export type TransitionGuard = (args: {
+    context: CodingContext;
+    event: unknown;
+}) => boolean;
+export interface RootEventTable {
+    readonly startCoding: {
+        readonly target: string;
+    };
+    readonly continueIr: {
+        readonly target: string;
+    };
+    readonly summarizeIr: {
+        readonly target: string;
+    };
+    readonly bossInterruptTargets: ReadonlyArray<string>;
+}
+export declare function enumerateCaptainStates(machine: typeof codingMachine): readonly CaptainStateInfo[];
+export declare function enumerateRootEvents(machine: typeof codingMachine): RootEventTable;

package/code.fsm.introspect.js

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2026 SubLang International <https://sublang.ai>
+export function enumerateCaptainStates(machine) {
+    const states = getRawConfig(machine).states ?? {};
+    const out = [];
+    for (const [stateId, def] of Object.entries(states)) {
+        const invoke = def.invoke;
+        if (!invoke || invoke.src !== 'captain' || typeof invoke.input !== 'function') {
+            continue;
+        }
+        const inputFn = invoke.input;
+        const getInput = (context) => inputFn({ context });
+        const probe = getInput({});
+        const transitions = toArmArray(invoke.onDone).map((arm, index) => ({
+            index,
+            target: stripIdPrefix(String(arm.target ?? '')),
+            guard: arm.guard ?? alwaysTrue,
+        }));
+        out.push({
+            stateId,
+            sourceItem: probe.sourceItem,
+            getInput,
+            transitions,
+        });
+    }
+    return out;
+}
+export function enumerateRootEvents(machine) {
+    const cfg = getRawConfig(machine);
+    const readyOn = (cfg.states?.ready?.on ?? {});
+    const rootOn = (cfg.on ?? {});
+    return {
+        startCoding: { target: stripIdPrefix(String(readyOn.START_CODING?.target ?? '')) },
+        continueIr: { target: stripIdPrefix(String(readyOn.CONTINUE_IR?.target ?? '')) },
+        summarizeIr: { target: stripIdPrefix(String(readyOn.SUMMARIZE_IR?.target ?? '')) },
+        bossInterruptTargets: toArmArray(rootOn.BOSS_INTERRUPT).map((arm) => stripIdPrefix(String(arm.target ?? ''))),
+    };
+}
+function getRawConfig(machine) {
+    return machine.config;
+}
+function toArmArray(value) {
+    if (value === undefined || value === null)
+        return [];
+    return (Array.isArray(value) ? value : [value]);
+}
+function stripIdPrefix(target) {
+    return target.startsWith('#') ? target.slice(1) : target;
+}
+const alwaysTrue = () => true;