项目说明
waymark 是什么
waymark 是一个本地优先、对 Git 友好的工作追踪工具。它最核心的设计是:工作项就是仓库里的 Markdown 文件。没有数据库、没有常驻守护进程——git clone 下来就是完整安装。
这让工单和代码活在同一个版本库里:分支切换工单跟着走,历史记录就是 git 历史,迁移和备份都变成 git 操作。
| 项 | 说明 |
|---|---|
| 存储 | Markdown 文件,在仓库里 |
| 依赖 | 无数据库、无常驻进程 |
| 安装 | 复制二进制或 cargo install 即可 |
| 能力 | 层级结构、依赖关系、分类与归属人 |
| 界面 | 命令行 + 可选的 Web 视图 |
| MCP | 提供 waymark-mcp,可接 Agent |
waymark 怎么安装
用 Rust 工具链:
cargo install waymark-cli # 得到 waymark 命令
cargo install waymark-mcp # MCP 服务端
也可以下载各平台预编译包(Linux x86_64、macOS Apple silicon、macOS Intel、Windows x86_64)。macOS 上因为二进制未签名,首次运行需要处理 Gatekeeper 提示,仓库有对应说明。
waymark 怎么使用
- 在仓库里初始化:
waymark init。 - 建工作项:
waymark create --title "Ship the first screen" --category task --owner "You"。 - 用层级和依赖把任务关系表达出来,别都堆成平铺列表。
- 工作项就在仓库里,跟代码一起提交——评审改动时也能看到。
- 想看板视图就装 Web 包并起本地服务。
- 要让 Agent 读写工单,接
waymark-mcp。
waymark 适合谁用
- 小团队或个人开发,不想为了工单再养一个 SaaS 和数据库的人。
- 要求工单和代码同仓、评审时能一起看的技术团队。
- 需要工单数据可迁移、不想被工具锁定的项目。
- 想让 Agent 直接读写任务清单的自动化场景。
- 需要复杂权限、审批流、跨部门报表的大型组织,这套太轻。
waymark 项目地址
- GitHub 仓库:https://github.com/QiYueran-source/waymark
- 常用命令:https://github.com/QiYueran-source/waymark#first-commands
- Web 视图:https://github.com/QiYueran-source/waymark#the-web-view