Skip to content

Project Index

Jump to bottom
Nick edited this page Jun 20, 2026 · 6 revisions

Cool Workflow Project Index

Generated from the current repository code on 2026-06-11 by npm run sync:project-index.

Snapshot

Architecture

workflow app -> runner -> dispatch -> isolated workers
    -> results -> feedback/candidates -> verifier gate
    -> commit/checkpoint -> report/trust audit

multi-agent host -> topology -> blackboard/coordinator
    -> fanout/fanin -> candidate score/select

Source Map

Core runtime

Module Responsibility
orchestrator.ts Plans runs, loads workflows, records results, writes reports, and exposes runner commands.
state.ts Persists run checkpoints, JSON state, run paths, and state migration entrypoints.
state-node.ts Defines explicit state nodes, pipeline transitions, evidence checks, and node persistence.
pipeline-contract.ts Builds the default pipeline contract used by run state.
pipeline-runner.ts Finds runnable stages and advances/fails pipeline nodes with retry-aware errors.
types.ts Owns the shared workflow, run, app, evidence, worker, candidate, audit, and topology types.

Verification and state gates

Module Responsibility
verifier.ts Validates result envelopes, findings, evidence, and run gate completion.
commit.ts Creates verifier-gated commits and explicit manual checkpoints.
candidate-scoring.ts Registers, scores, ranks, selects, rejects, and summarizes candidate outputs.
error-feedback.ts Turns failures into persisted feedback records and correction tasks.
trust-audit.ts Records provenance, sandbox decisions, host attestations, and acceptance rationale.

Workers and policy

Module Responsibility
dispatch.ts Selects runnable tasks and writes dispatch manifests.
worker-isolation.ts Allocates worker scopes, writes manifests, records worker outputs, and validates boundaries.
sandbox-profile.ts Resolves named sandbox policy contracts and validates read/write/command/network boundaries.
harness.ts Renders task files for dispatched work.

Multi-agent layer

Module Responsibility
multi-agent.ts Persists multi-agent runs, roles, groups, memberships, fanouts, and fanins.
coordinator.ts Owns blackboard topics, messages, context, artifacts, snapshots, and coordinator decisions.
topology.ts Defines and applies official map-reduce, debate, and judge-panel topologies.
multi-agent-host.ts Provides the preferred host loop for run, status, step, blackboard, score, and select.

User and host surfaces

Module Responsibility
cli.ts Routes human CLI commands to runtime, app, topology, multi-agent, and operator flows.
mcp-server.ts Exposes JSON-RPC/MCP tool parity for agent hosts.
operator-ux.ts Formats status, reports, graph, worker, candidate, feedback, commit, and trust summaries.
workflow-app-framework.ts Validates app manifests and loads app entrypoints.
workflow-api.ts Provides the fluent workflow, phase, task, artifact, and input API.
daemon.ts Runs scheduled tasks through the desktop scheduler daemon.
scheduler.ts Creates, stores, computes, and runs schedules.
triggers.ts Bridges routine triggers to explicit workflow events.
version.ts Defines current package and state schema versions.

Other Source Modules

Workflow Apps

App Type Inputs Sandbox Source
architecture-review - Map a repository architecture, assess risks, verify important findings, and synthesize an evidence-backed verdict. canonical repo, question, invariant, focus readonly manifest / workflow
end-to-end-golden-path - Deterministic one-worker workflow app for proving the CW integration chain. userland question readonly manifest / workflow
pr-review-fix-ci - Review a pull request or branch, inspect CI failures, diagnose actionable issues, optionally patch, verify, and summarize with evidence. canonical repo, pr, branch, base, ci, mode readonly, workspace-write manifest / workflow
release-cut - Prepare a release with checklist discipline: version checks, changelog, tests, packaging, release notes, and final verification. canonical repo, version, previousVersion, releaseBranch, dryRun readonly, workspace-write manifest / workflow
research-synthesis - Split a research question into claims, investigate sources, cross-check evidence, verify claims, and synthesize a concise answer. canonical question, source, scope, freshness readonly, locked-down manifest / workflow
workflow-app-framework-demo - Small framework app showing inputs, phases, evidence gates, and sandbox profile hints. example question readonly, workspace-write manifest / workflow

Documentation Map

Test Surface

Smoke tests mirror the public contracts. The high-signal suites are:

Sync Targets

  • Repository docs: docs/project-index.md
  • Obsidian vault (optional): set CW_OBSIDIAN_VAULT to your local vault path.
  • GitHub Wiki: the cool-workflow.wiki working tree (override with CW_GITHUB_WIKI_DIR).

Maintenance

Run this after changing source modules, workflow app manifests, public docs, or smoke test coverage:

cd plugins/cool-workflow
npm run sync:project-index

Then review the Obsidian page and GitHub Wiki working tree before publishing wiki changes.

Organized from local Obsidian notes and reconciled with the current coo1white/cool-workflow repository state.

Cool Workflow

Start here

Go deeper

Source docs

Clone this wiki locally