deer-workflow

English: README · Guide · API | 简体中文：README · 快速入门 · API

一个开源的 Dynamic Workflow Runtime：用确定性的 TypeScript 编排组织可替换的 Agent Runtime。

deer-workflow 是 DeerFlow 3.0（即 DeerWork）的试点项目。包名为 @deer-work-ai/workflow，命令行名称为 deer-workflow。

目录

• 如何使用
  • 前置条件
  • 安装命令行
  • 运行 Agent
  • 创建 Workflow
  • 运行 Workflow
  • 示例
• 如何开发
  • 开发文档
  • 初始化开发环境
  • 验证修改
  • 贡献 Agent 集成
  • 许可证

如何使用

前置条件

安装 Bun 和 Codex CLI，然后登录：

Bun 是快速、兼容 Node.js 的 JavaScript Runtime 和工具链； 安装方式参见官方指南。

npm install -g @openai/codex
codex login
codex --version

Codex CLI 与 Codex Desktop 是两个独立安装。安装 Desktop 应用不会同时安装 终端中的 codex 命令。

安装命令行

在首个 npm 版本发布前，直接从 GitHub 全局安装当前版本：

bun install --global git+https://github.com/deerwork-ai/deer-workflow.git
deer-workflow --help

@deer-work-ai/workflow 发布到 npm 后，可用下面的命令安装正式版本：

bun install --global @deer-work-ai/workflow

不带 --global 的 bun install 只会安装当前项目的本地依赖，不会在全局安装 deer-workflow 命令。

运行 Agent

deer-workflow agent "Inspect this repository"

创建 Workflow

描述需要的编排逻辑。该命令会让 Codex 执行内置的 workflow-creator Skill，并 将生成的源码写入 stdout：

deer-workflow create \
  "并行研究多个独立角度，验证研究结果，最后汇编成报告" \
  > workflow.ts

运行 Workflow

deer-workflow run ./workflow.ts --input '{"question":"你的问题"}'

示例

运行 Deep Research：

deer-workflow run ./examples/deep-research/workflow.ts \
  --input '{"question":"Agent Skills 与 Dynamic Workflows 正在如何演进？"}'

运行 Blog Writer：

deer-workflow run ./examples/blog-writer/workflow.ts \
  --input '{"topic":"Dynamic Workflow","audience":"Agent Builder"}'

这些路径指向本仓库内的文件，请先克隆或下载仓库再运行。

如何开发

开发文档

• 快速入门
• API 参考
• Workflow Creator Skill
• English Documentation

Agents、Flow Controls、Workflow Events、Logging、Runner 行为、JSON Schema 输出和编程调用方式请详见 API 文档。

初始化开发环境

克隆仓库，然后安装本地依赖和仓库管理的 Git Hooks：

git clone https://github.com/deerwork-ai/deer-workflow.git
cd deer-workflow
bun install

开发时直接从源码运行 CLI：

bun run dev -- --help

验证修改

提交修改前运行完整门禁：

bun run check

贡献 Agent 集成

Codex CLI 是默认 Agent Runtime，但不是架构上的硬依赖。欢迎贡献其他 Coding Agent 集成。

许可证

本项目采用 MIT 许可证。