API 参考 · 总览

所有对外 API 都从 flowcast 导出（在 index.js 登记）。本页是分类索引，点进各分页看完整签名。

import {
  // 断点续跑
  Checkpoint,

  // Agent 执行
  runAgent, runAgentChain, setWorkdir, setAgentEventSink,
  claude, cursor, gemini, codex, aider, recursive, agy,
  spawnCapture, spawnCli, resolveRecursiveBin,
  recursiveProviderEnv, claudeProviderEnv, claudeApplyProvider,
  isProviderRetryable,
  emitAgentEvent,
  parallel, pipeline,

  // 超时常量
  CLAUDE_DEFAULT_TIMEOUT, GEMINI_DEFAULT_TIMEOUT, CODEX_DEFAULT_TIMEOUT,
  AGY_DEFAULT_TIMEOUT, CURSOR_DEFAULT_TIMEOUT, AIDER_DEFAULT_TIMEOUT,
  RECURSIVE_DEFAULT_TIMEOUT,

  // HITL
  waitForInput, notify, setHitlBackend, getHitlBackend,

  // 质量门 / 自改沙箱
  runGate, runGates, loadGates, mergeGates,
  withSelfModGuard, captureBaseline,

  // Schema / 结构化输出
  validateSchema, runStructured,

  // 对抗式验证
  verifyAdversarial,

  // 失败上下文
  writeFailureContext, readAndConsumeFailureContext,

  // 记忆
  recordLearning, recall, buildMemorySection, promoteFailureContext,

  // Goal-driven 循环
  loop,

  // Provider / Executor
  interpolateEnv, loadProviders, resolveProvider, loadMergedConfig, basenamesFor,
  EXECUTORS, getExecutor, loadAgents, resolveAgent, registerExecutor,

  // 路径校验 / 事件工具
  assertSafeIdent, makeEvent,

  // dry-run
  isDryRun,

  // 数据目录
  flowcastDir,

  // Git
  gitStatus, gitDiff, gitCommitAll, gitHead, gitCurrentBranch,
  gitCommitsAhead, gitCreateBranch, gitWorktreeAdd, gitWorktreeRemove,

  // 子 flow
  runFlow, fanOut, archiveChildRun,

  // Dashboard
  collectRuns, renderHtml, generateDashboard,

  // 错误类型
  FlowcastError, TimeoutError, SpawnError, GateError, SchemaError,
  ConfigError, PathError, LockError, GitError, ParallelError,
  VerifyError, GuardError, PauseSignal, isRetryable,
} from 'flowcast'

分类

分页	内容
Checkpoint	断点续跑的步骤记录（含 loop 协作窄接口）
Agent 执行	runAgent / adapter / 链式回退 / 并发 / HITL
质量门 / 自改沙箱	runGate / runGates / loadGates / mergeGates / withSelfModGuard / captureBaseline
Provider / Executor	配置加载、解析、执行器能力分层
Git / Subflow	受控 git 原语 + 子 flow 调度
Dashboard	可观测看板采集与渲染（含 EVENT_TYPES）
实用工具	assertSafeIdent / makeEvent / loop / verifyAdversarial / validateSchema / memory / flowcast/internal
错误类型	FlowcastError 错误层次体系 / isRetryable

L3 编排（orchestrator）

L3 的 API 从 flowcast/orchestrator（orchestrator/index.js）导出：

导出	作用
orchestrate(request, opts)	单 flow 端到端编排（生成→校验→执行，续跑锁定）
orchestrateMulti(goal, opts)	接单分拆 → 每任务生成 flow → fanOut 并发
generateFlow / validateFlow	受控生成 / 跑前校验
decompose	LLM 受控分拆大目标为子任务清单
checkFlowcastResolvable(repo)	预检：目标仓能否解析 flowcast

用法见 L3 编排指南。

dry-run

几乎所有原语都尊重 isDryRun()：runAgent / resolveAgent 返回假执行器，runGate 直接判过，runFlow / fanOut 不真正隔离。FLOWCAST_DRY_RUN=1 即可跑通骨架。