Skip to content

Repository files navigation

Workrun

仍处于早期开发阶段:当前 README 用于说明项目愿景与开发方向,功能状态会随着迭代持续更新。

Workrun 是一个本地优先的自动化工作流平台。它希望让开发者能够在同一个桌面应用中,组合脚本、服务、AI Agent 与人工输入,构建可理解、可运行、可扩展的自动化任务。

项目的核心不是再提供一个孤立的聊天界面,而是把 AI 能力纳入可编排的工作流:明确每个步骤的输入、输出、分支和执行结果,让复杂任务能够被复用、调试与演进。

项目目标

  • 本地优先:工作流定义、运行过程和敏感配置尽可能保留在用户设备上,降低数据流转成本并增强可控性。
  • 可视化编排:通过节点与连线描述任务,而不是把所有逻辑藏在一段提示词或脚本里。
  • 统一自动化入口:将脚本、本地服务、远程服务和 AI Agent 组合到同一条工作流中。
  • 面向开发者扩展:以清晰的节点、配置和运行时边界,支持后续接入更多模型、工具和执行器。
  • 可观察、可调试:运行时应当能看到输入、输出、日志、错误与执行链路,帮助定位问题并持续优化。

计划中的核心能力

工作流设计与编排

  • 拖拽式画布,创建、连接和组织工作流节点。
  • 工作流基础配置:名称、说明、运行模式与输入参数。
  • 开始、结束、Agent、远程 Agent、条件分支、Switch 分支与分组等节点。
  • 通过条件和状态字段控制执行路径,支持更复杂的业务流程。
  • 工作流的保存、加载、导入、导出与版本演进。

AI Agent 与模型接入

  • 为 Agent 节点配置角色说明、指令和模型配置。
  • 管理不同模型提供商及其 API 密钥、模型参数和默认配置。
  • 支持将多个 Agent 串联或分支协作,完成拆解、处理、校验和汇总等任务。
  • 接入远程 Agent 或兼容服务,使本地工作流可调用外部能力。

自动化执行

  • 以表单或对话方式向工作流传入参数。
  • 执行工作流并展示每一步的状态、输出与错误信息。
  • 支持调用本地脚本、命令和服务;后续逐步扩展更多工具连接器。
  • 为长时间任务提供取消、重试和恢复等运行控制能力。

调试与可观测性

  • 为单次运行保留输入、节点输出、日志和错误上下文。
  • 提供工作流运行面板,便于查看结果与定位失败节点。
  • 支持配置日志级别、保留周期和本地日志清理策略。
  • 逐步建立可复现的运行记录与调试体验。

桌面应用体验

  • 基于 Tauri 的跨平台桌面应用。
  • 深色、浅色与跟随系统的主题设置。
  • 中英文界面与本地化支持。
  • 自动更新、开机启动、最小化启动等桌面端能力。

预期使用场景

  • 将重复的开发、数据处理或运维步骤固化为一键运行的流程。
  • 组合多个 AI Agent,完成内容生成、信息整理、代码辅助或质量检查。
  • 在本地脚本、内部服务和云端 AI 模型之间建立清晰的协作链路。
  • 为团队或个人沉淀可复用、可分享的自动化工作流模板。

技术方向

目前项目采用 pnpm monorepo 组织代码:桌面端位于 apps/desktop,共享 UI 与表单能力位于 packages。前端使用 React、TypeScript 和 React Flow 构建交互式工作流编辑体验,桌面运行时基于 Tauri。

随着项目推进,运行时、节点协议、插件扩展机制和工作流存储格式会逐步稳定;在此之前,相关接口仍可能调整。

开发状态

Workrun 正处于从原型走向可用产品的阶段。部分界面和节点能力已经开始实现,但尚不代表完整、稳定或生产可用的功能集。欢迎关注、试用早期版本,并通过 Issue 或 Pull Request 参与讨论和共建。

本地开发

环境要求

  • Node.js 24 或更高版本
  • pnpm 11
  • Rust 工具链(用于运行 Tauri 桌面应用)

常用命令

# 安装依赖
pnpm install

# 启动桌面应用开发环境
pnpm dev:app

# 仅启动前端界面
pnpm ui:dev

# 类型检查
pnpm typecheck

# 代码检查与格式检查
pnpm oxlint
pnpm format

参与贡献

项目刚刚起步,尤其欢迎以下方向的贡献:工作流节点设计与实现、运行时与插件机制、模型与工具集成、桌面端体验、文档和示例工作流。提交较大改动前,建议先通过 Issue 讨论设计方向。

License

本项目采用 LICENSE 中的许可证。

About

An open-source local automation runtime that allows developers to build, compose and run workflows using scripts, services and AI agents. 一个本地优先的自动化运行平台,通过插件化 Worker 和 Workflow 编排,将脚本、服务和 AI Agent 组合成自动化任务。

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages