{"_id":"@deerwork-ai/deer-workflow","_rev":"3-f3242b70601e91d829b723a2aacde02f","name":"@deerwork-ai/deer-workflow","dist-tags":{"latest":"0.2.0"},"versions":{"0.0.1":{"name":"@deerwork-ai/deer-workflow","version":"0.0.1","keywords":["agent","codex","dynamic-workflow","workflow"],"license":"MIT","_id":"@deerwork-ai/deer-workflow@0.0.1","maintainers":[{"name":"magiccube","email":"henry1943@163.com"}],"homepage":"https://github.com/deerwork-ai/deer-workflow#readme","bugs":{"url":"https://github.com/deerwork-ai/deer-workflow/issues"},"bin":{"deer-workflow":"src/cli.ts"},"dist":{"shasum":"f18143af666fdcbe3a9787e3cbeea0436f27f40d","tarball":"https://registry.npmjs.org/@deerwork-ai/deer-workflow/-/deer-workflow-0.0.1.tgz","fileCount":40,"integrity":"sha512-pfAsygjukdSTUxvIgrwzy2b3ZfPY25UlGZh9yr2wjOzeFJj+upwTNLMgMXi+Gc6MEY/cDBcXJpWQuR+7zeZToQ==","signatures":[{"sig":"MEYCIQCKNlcJ8Cge6YC6p+VTRdqUbKfnlPkIwDlQv3TnsUowIAIhAKSbhgi7ryiAVLcQVrQIrISC7NlCu8s5AQLng8BOzxrp","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":94786},"type":"module","exports":{".":"./src/index.ts","./flow":"./src/flow/index.ts","./agents":"./src/agents/index.ts","./events":"./src/events/index.ts","./runner":"./src/runner/index.ts","./logging":"./src/logging/index.ts"},"gitHead":"0919c4781dc9e4700ded1dfbf4529d3f8555088f","scripts":{"dev":"bun run src/cli.ts","lint":"eslint . --max-warnings=0","test":"bun test","check":"bun run typecheck && bun run lint && bun run format:check && bun test","format":"prettier . --write","prepare":"husky","lint:fix":"eslint . --fix --max-warnings=0","typecheck":"bunx tsc --noEmit","lint:staged":"lint-staged","format:check":"prettier . --check"},"_npmUser":{"name":"magiccube","email":"henry1943@163.com"},"repository":{"url":"git+https://github.com/deerwork-ai/deer-workflow.git","type":"git"},"_npmVersion":"11.12.1","description":"An open-source Dynamic Workflow runtime for AI agents.","directories":{},"_nodeVersion":"24.1.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^10.8.0","globals":"^17.7.0","prettier":"^3.9.6","@eslint/js":"^10.0.1","@types/bun":"latest","typescript":"^5.9.3","lint-staged":"^17.2.0","typescript-eslint":"^8.65.0","eslint-config-prettier":"^10.1.8"},"_npmOperationalInternal":{"tmp":"tmp/deer-workflow_0.0.1_1785049234449_0.5454401447673873","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@deerwork-ai/deer-workflow","version":"0.1.0","keywords":["agent","codex","dynamic-workflow","workflow"],"license":"MIT","_id":"@deerwork-ai/deer-workflow@0.1.0","maintainers":[{"name":"magiccube","email":"henry1943@163.com"}],"bin":{"deer-workflow":"src/cli.ts"},"dist":{"shasum":"80832759c9074b6f218d096e5415d8ab32f46df5","tarball":"https://registry.npmjs.org/@deerwork-ai/deer-workflow/-/deer-workflow-0.1.0.tgz","fileCount":49,"integrity":"sha512-WUjLLFY5f2IqYoTM0uBBAD1Zg6mZ80GuKe7iZN+/CfzSy9oz2FkQonJs9edv8r7KuStgoncvi8oa4hsCIyPizw==","signatures":[{"sig":"MEQCIDIOxsC8khfbiBjgPtklWQ4CwsRsK2y//SGFuZY07vm7AiA42EBBY3Q3fpopbhIxU/8R9CgrZR+dJJRMKg9hOdiXLg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":159519},"type":"module","shasum":"80832759c9074b6f218d096e5415d8ab32f46df5","exports":{".":"./src/index.ts","./flow":"./src/flow/index.ts","./agents":"./src/agents/index.ts","./events":"./src/events/index.ts","./runner":"./src/runner/index.ts","./logging":"./src/logging/index.ts"},"scripts":{"dev":"bun run src/cli.ts","lint":"eslint . --max-warnings=0","test":"bun test","check":"bun run typecheck && bun run lint && bun run format:check && bun test","format":"prettier . --write","prepare":"husky","lint:fix":"eslint . --fix --max-warnings=0","typecheck":"bunx tsc --noEmit","lint:staged":"lint-staged","format:check":"prettier . --check"},"_npmUser":{"name":"magiccube","email":"henry1943@163.com"},"_integrity":"sha512-WUjLLFY5f2IqYoTM0uBBAD1Zg6mZ80GuKe7iZN+/CfzSy9oz2FkQonJs9edv8r7KuStgoncvi8oa4hsCIyPizw==","repository":{"url":"git+https://github.com/deerwork-ai/deer-workflow.git","type":"git"},"_npmVersion":"10.8.3","description":"An open-source Dynamic Workflow runtime for AI agents.","directories":{},"_nodeVersion":"24.3.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"husky":"^9.1.7","eslint":"^10.8.0","globals":"^17.7.0","prettier":"^3.9.6","@eslint/js":"^10.0.1","@types/bun":"latest","typescript":"^5.9.3","lint-staged":"^17.2.0","typescript-eslint":"^8.65.0","eslint-config-prettier":"^10.1.8"},"_npmOperationalInternal":{"tmp":"tmp/deer-workflow_0.1.0_1785056497526_0.7112590335568669","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@deerwork-ai/deer-workflow","version":"0.2.0","description":"An open-source Dynamic Workflow runtime for AI agents.","type":"module","bin":{"deer-workflow":"src/cli.ts"},"exports":{".":"./src/index.ts","./agents":"./src/agents/index.ts","./events":"./src/events/index.ts","./flow":"./src/flow/index.ts","./logging":"./src/logging/index.ts","./runner":"./src/runner/index.ts"},"scripts":{"dev":"bun run src/cli.ts","lint":"eslint . --max-warnings=0","lint:fix":"eslint . --fix --max-warnings=0","format":"prettier . --write","format:check":"prettier . --check","lint:staged":"lint-staged","test":"bun test","typecheck":"bunx tsc --noEmit","check":"bun run typecheck && bun run lint && bun run format:check && bun test","prepare":"husky"},"repository":{"type":"git","url":"git+https://github.com/deerwork-ai/deer-workflow.git"},"publishConfig":{"access":"public"},"keywords":["agent","codex","dynamic-workflow","workflow"],"license":"MIT","devDependencies":{"@eslint/js":"^10.0.1","@types/bun":"latest","eslint":"^10.8.0","eslint-config-prettier":"^10.1.8","globals":"^17.7.0","husky":"^9.1.7","lint-staged":"^17.2.0","prettier":"^3.9.6","typescript":"^5.9.3","typescript-eslint":"^8.65.0"},"_id":"@deerwork-ai/deer-workflow@0.2.0","_integrity":"sha512-sJgf79AHIwx67b570lMOuQjpouXepXSlfTeLXNobEubYzcViQZslnqRw2XEvYjF9+N3VUlpy6ID5qziSS1ICBw==","_nodeVersion":"24.3.0","_npmVersion":"10.8.3","shasum":"d55eff839a69faaeedec6f99165bb0ce6b63a97e","dist":{"integrity":"sha512-sJgf79AHIwx67b570lMOuQjpouXepXSlfTeLXNobEubYzcViQZslnqRw2XEvYjF9+N3VUlpy6ID5qziSS1ICBw==","shasum":"d55eff839a69faaeedec6f99165bb0ce6b63a97e","tarball":"https://registry.npmjs.org/@deerwork-ai/deer-workflow/-/deer-workflow-0.2.0.tgz","fileCount":51,"unpackedSize":174934,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIH9+PiBv56x04byIt2+YstSRxqAurahUnFx5Fuhc27cOAiASR+MtpPkXg8sJOij/WT9A4TRdAwE5IthsKuIUHnVycw=="}]},"_npmUser":{"name":"magiccube","email":"henry1943@163.com"},"directories":{},"maintainers":[{"name":"magiccube","email":"henry1943@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/deer-workflow_0.2.0_1785150618351_0.15430078470440267"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-26T07:00:34.351Z","modified":"2026-07-27T11:10:19.037Z","0.0.1":"2026-07-26T07:00:34.598Z","0.1.0":"2026-07-26T09:01:37.704Z","0.2.0":"2026-07-27T11:10:18.505Z"},"license":"MIT","keywords":["agent","codex","dynamic-workflow","workflow"],"repository":{"type":"git","url":"git+https://github.com/deerwork-ai/deer-workflow.git"},"description":"An open-source Dynamic Workflow runtime for AI agents.","maintainers":[{"name":"magiccube","email":"henry1943@163.com"}],"readme":"# deer-workflow\n\n[English: README](./README.md) ·\n[Guide](./docs/index.md) ·\n[API](./docs/api.md) |\n[简体中文：README](./README.zh-CN.md) ·\n[快速入门](./docs/index.zh-CN.md) ·\n[API](./docs/api.zh-CN.md)\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)\n[![npm](https://img.shields.io/npm/v/@deerwork-ai/deer-workflow)](https://www.npmjs.com/package/@deerwork-ai/deer-workflow)\n[![Bun](https://img.shields.io/badge/runtime-Bun-f9f1e1?logo=bun&logoColor=000000)](https://bun.sh)\n[![TypeScript](https://img.shields.io/badge/language-TypeScript-3178c6?logo=typescript&logoColor=ffffff)](https://www.typescriptlang.org)\n[![Codex CLI](https://img.shields.io/badge/default_agent-Codex_CLI-000000?logo=openai&logoColor=ffffff)](https://github.com/openai/codex)\n[![DeerFlow Stars](https://img.shields.io/github/stars/bytedance/deer-flow?label=DeerFlow%20Stars&logo=github)](https://github.com/bytedance/deer-flow)\n[![GitHub Stars](https://img.shields.io/github/stars/deerwork-ai/deer-workflow?style=flat&logo=github)](https://github.com/deerwork-ai/deer-workflow)\n\nAn open-source Dynamic Workflow runtime that combines deterministic TypeScript\norchestration with replaceable Agent runtimes.\n\n`deer-workflow` is a pilot project for\n[**DeerFlow 3.0**](https://github.com/bytedance/deer-flow), also known as\n**DeerWork**. The package name is `@deerwork-ai/deer-workflow`; the executable is\nnamed `deer-workflow`.\n\n## Index\n\n- [How to use](#how-to-use)\n  - [Prerequisites](#prerequisites)\n  - [Install the CLI](#install-the-cli)\n  - [Run an Agent](#run-an-agent)\n    - [Other Agents / Harnesses](#other-agents--harnesses)\n  - [Create a Workflow](#create-a-workflow)\n  - [Run a Workflow](#run-a-workflow)\n  - [Examples](#examples)\n- [How to develop](#how-to-develop)\n  - [Development documentation](#development-documentation)\n  - [Set up](#set-up)\n  - [Validate changes](#validate-changes)\n  - [Contribute an Agent / Harness integration](#contribute-an-agent--harness-integration)\n  - [License](#license)\n\n# How to use\n\n## Prerequisites\n\nInstall [Bun](https://bun.sh) and\n[Codex CLI](https://github.com/openai/codex), then sign in:\n\n[Bun](https://bun.sh) is a fast, Node.js-compatible JavaScript runtime and\ntoolkit; see its [installation guide](https://bun.sh/docs/installation).\n\n```bash\nnpm install -g @openai/codex\ncodex login\ncodex --version\n```\n\nCodex CLI and Codex Desktop are separate installations. Installing the Desktop\napp does not install the `codex` terminal command.\n\n## Install the CLI\n\nInstall the released CLI from npm:\n\n```bash\nbun install --global @deerwork-ai/deer-workflow\ndeer-workflow --help\n```\n\nRunning `bun install` without `--global` only installs dependencies for the\ncurrent project. It does not install the `deer-workflow` command globally.\n\n## Run an Agent\n\n```bash\ndeer-workflow agent \"Inspect this repository\"\ndeer-workflow agent --agent claude \"Inspect this repository\"\n```\n\n### Other Agents / Harnesses\n\nThe `agent()` helper and Agent-backed CLI commands use the Codex harness by\ndefault. Claude Code is also included as a built-in harness. Select it with\n`--agent claude` on `agent` or `create`. First install\n[Claude Code CLI](https://docs.claude.com/en/docs/claude-code) and sign in:\n\n```bash\nnpm install -g @anthropic-ai/claude-code\nclaude auth login\nclaude --version\n```\n\nFrom TypeScript, instantiate `ClaudeAgent` directly:\n\n```typescript\nimport { ClaudeAgent } from \"@deerwork-ai/deer-workflow/agents\";\n\nconst runtime = new ClaudeAgent({ model: \"sonnet\" });\nconst result = await runtime.run(\"Inspect this repository.\");\n```\n\nSee [`ClaudeAgent` in the API Reference](./docs/api.md#claudeagent) for\nsandbox, model, and structured-output options.\n\n## Create a Workflow\n\nDescribe the orchestration you need. The command runs the bundled\n`workflow-creator` Skill through Codex by default and writes generated source\nto stdout. Pass `--agent claude` to select the Claude Code harness:\n\n```bash\ndeer-workflow create --agent claude \\\n  \"Research several independent angles, verify the findings, and synthesize a report\" \\\n  > workflow.ts\n```\n\nAlternatively, install the bundled Skill for your Agents, then ask any Agent\nthat supports Agent Skills to create a Workflow:\n\n```bash\ndeer-workflow skill install\n```\n\nThe command copies the Skill into existing `~/.agents/skills` and\n`~/.claude/skills` directories and reports which destinations it changed or\nskipped.\n\n## Run a Workflow\n\n```bash\ndeer-workflow run ./workflow.ts --input '{\"question\":\"Why has Neo Labs recently emerged as a new force in AI?\"}'\n```\n\nInteractive runs show `meta.phases` and rendered Markdown logs in a live\ntwo-pane TUI, together with the Workflow name, module path, working directory,\nand an animated highlight on the active phase. In the default mode, redirected\nstderr remains JSONL for automation.\n\nUse `--print` / `-p` when running on servers or in automation such as CI/CD,\ntask queues, process pipelines, and event collectors. It exposes a stable\nstdout Event Stream with one JSON event per line:\n\n```bash\ndeer-workflow run ./workflow.ts --print \\\n  --input '{\"question\":\"Why has Neo Labs recently emerged as a new force in AI?\"}'\n```\n\n## Examples\n\nRun [Deep Research](./examples/deep-research/README.md):\n\n```bash\ndeer-workflow run ./examples/deep-research/workflow.ts \\\n  --input '{\"question\":\"How are Agent Skills and Dynamic Workflows evolving?\",\"outputPath\":\"./report.html\"}'\n```\n\nRun [Blog Writer](./examples/blog-writer/README.md):\n\n```bash\ndeer-workflow run ./examples/blog-writer/workflow.ts \\\n  --input '{\"topic\":\"The Emerging Trends of Neo Labs\",\"audience\":\"Agent builders\"}'\n```\n\nThese paths refer to files in this repository. Clone or download the repository\nbefore running them.\n\n# How to develop\n\n## Development documentation\n\n- [Getting Started](./docs/index.md)\n- [API Reference](./docs/api.md)\n- [Workflow Creator Skill](./skills/workflow-creator/SKILL.md)\n- [中文开发文档](./docs/index.zh-CN.md)\n\nThe API Reference covers Agents, Flow Controls, Workflow Events, Logging,\nRunner behavior, JSON Schema output, and programmatic usage.\n\n## Set up\n\nClone the repository, then install its local dependencies and Git hooks:\n\n```bash\ngit clone https://github.com/deerwork-ai/deer-workflow.git\ncd deer-workflow\nbun install\n```\n\nRun the CLI directly from source while developing:\n\n```bash\nbun run dev -- --help\n```\n\n## Validate changes\n\nRun the complete quality gate before submitting changes:\n\n```bash\nbun run check\n```\n\n## Contribute an Agent / Harness integration\n\nCodex CLI is the default Agent runtime, not an architectural dependency.\n`ClaudeAgent` (Claude Code CLI) ships as another built-in harness;\ncontributions for other Agent and Harness integrations are welcome.\n\n## License\n\nThis project is licensed under the [MIT License](./LICENSE).\n","readmeFilename":"README.md"}