Backlog.md

用 Git 里的 Markdown 任务文件,让人和 AI 一起管项目

Backlog.md 是一个面向人类与 AI Agent 协作的项目管理工具,把任务、需求、决策记录全部以 Markdown 文件形式存放在 Git 仓库中。它解决的核心问题是:当 AI 编程助手参与开发时,任务状态和上下文散落在聊天记录、issue 和文档里,难以追踪和版本化。Backlog.md 用纯文本任务文件作为唯一事实来源,让人类和 Agent 都能直接读写同一份任务列表,并借助 Git 的提交、分支、合并能力记录每次变更。核心能力包括:创建和更新任务、按状态和优先级组织 backlog、在命令行中快速检索和操作任务、让 AI Agent 通过读写 Markdown 文件参与任务流转。由于不依赖数据库和专有服务,团队可以沿用现有 Git 工作流,把项目管理变成可审查、可回滚的代码化流程。

开源 unknown 自动化工作流
访问官网 ↗ GitHub ↗ 文档 ↗
GitHub 星标 ★ 6804
维护状态 活跃
是否开源
定价模式 unknown

项目数据

分类自动化工作流
开发团队MrLesk
所属国家
官网地址https://backlog.md
定价模式unknown
价格说明定价信息待确认
访问状态
是否开源
开源协议MIT
主要语言TypeScript
技术栈/模型agent,agentic-ai,management,markdown,project,task-manager,tasks
GitHub 星标★ 6804
30天Star增速
HF 下载量
上线时间2025-06-04 00:00:00
最近更新2026-09-21 00:00:00
维护状态活跃
中文支持
访问方式
移动端支持
综合评分
收录时间2026-09-22
浏览次数0

使用教程

难度:入门 约 10 分钟 部署方式:命令行工具 6 步

环境要求

  • Node.js 环境(使用 npm 全局安装时需要)
  • 建议准备一个 Git 仓库(Git 是可选的,可用 --no-git 跳过)
  • macOS 用户可选 Homebrew,使用 Nix 的用户需已启用 flakes

安装与启动步骤

  1. 1全局安装 CLI

    通过 npm 全局安装 backlog.md 命令行工具,安装完成后即可在任意目录使用 backlog 命令。

    npm i -g backlog.md
  2. 2初始化项目

    在目标 Git 仓库目录下运行初始化向导,会询问如何连接 AI 工具(CLI 指令 / MCP / 跳过),并创建项目内的 backlog 目录。

    backlog init
  3. 3自定义任务前缀

    默认生成 TASK-1 这类 ID,可在初始化时通过 --task-prefix 指定前缀,本仓库示例使用 back,生成 BACK-1。

    backlog init --task-prefix back
  4. 4无 Git 项目初始化

    不想依赖 Git 时使用 --no-git,创建纯文件系统项目,配置会强制关闭 checkActiveBranches、remoteOperations 和 autoCommit。

    backlog init --no-git
  5. 5调整配置项

    运行不带参数的配置向导,逐步设置分支准确性、Git 工作流、ID 格式、编辑器、Web UI 端口等;跳过则使用内置安全默认值。

    backlog config
  6. 6让 Agent 读取指令

    初始化向导推荐选择 CLI instructions,它会生成一个简短说明文件,指示 AI Agent 运行该命令获取项目任务上下文。

    backlog instructions overview

关键配置

配置项必填说明示例
backlog_directory指定任务 Markdown 文件的存放目录,相对于项目根路径my-backlog
autoCommit控制任务变更是否自动提交到 Git;无 Git 项目下强制为 falsefalse
checkActiveBranches跨分支任务读取的准确性开关;无 Git 项目下强制为 falsetrue
defaultPortWeb UI 默认监听端口3000
defaultEditor打开任务文件时使用的编辑器集成code
zeroPaddedIds任务 ID 是否补零格式化false

如何确认成功

运行 backlog --version 能输出版本号,且项目内已生成 backlog 目录与配置文件,说明安装和初始化成功。

常见问题

Q:必须安装 Git 才能用吗?

A:不必。Git 是可选的,运行 backlog init --no-git 即可创建纯文件系统项目,相关 Git 相关配置会自动关闭。

Q:有哪些安装方式?

A:README 提供三种:npm i -g backlog.md、brew install backlog-md、nix run github:MrLesk/Backlog.md。Nix 支持 x86_64-linux、aarch64-linux 和 aarch64-darwin。

Q:怎样让 AI 工具接管任务?

A:初始化向导中可选 CLI instructions(推荐)或 MCP connector,后者可自动配置 Claude Code、Codex、Gemini CLI、Kiro 或 Cursor。

Q:Cursor 应该怎么选?

A:选择 AGENTS.md,或运行 backlog init --agent-instructions cursor,两者目标文件相同;已有的 AGENTS.md 内容会被保留。

注意事项

  • 配置文件优先读取 backlog.config.yml,其次是 backlog/config.yml 或 .backlog/config.yml,最后使用内置默认值。
  • 配置优先级为:CLI 参数 > 项目配置文件 > 内置默认值。
  • 任务文件是纯 Markdown,随 Git 提交、分支、合并自然版本化,属于项目本地内容。
  • Intel macOS 用户无法使用 Nix 方案,请改用 npm、Bun 或 Homebrew 安装。

核心亮点

  • 任务以 Markdown 文件存于 Git 仓库,天然支持版本历史、分支和代码评审
  • 人类和 AI Agent 读写同一份任务文件,减少上下文在聊天记录中丢失的问题
  • TypeScript 实现并提供 CLI,可脚本化接入现有开发流程,无需额外数据库或服务

不足之处

  • 依赖 Git 和命令行习惯,非技术成员上手成本较高
  • 任务视图和协作界面偏轻量,复杂项目组合管理能力有限

适用场景

  • 个人开发者用 AI 助手写代码时,把待办和进度记录在仓库里统一管理
  • 小团队在 Git 工作流中让 AI Agent 领取和更新任务,保持上下文同步
  • 需要审计任务变更历史的项目,用提交记录追踪每个任务的修改过程

替代项目

Taskwarrior、todo.txt、GitHub Issues

项目介绍

Backlog.md 是自动化工作流领域的开源项目,由 MrLesk 开发,2025 年首次发布。

在全站 12,909 个收录项目中,它的 GitHub 星标数(6,804)位列前 7%,在自动化工作流分类的 499 个项目里位列前 14%。

项目目前处于活跃维护状态,最近一次代码更新于 2026-09-21。

它主要面向的使用场景是:个人开发者用AI助手写代码时,把待办和进度记录在仓库里统一管理。同类可对比的替代方案包括 Taskwarrior、todo.txt、GitHub Issues。

上一篇:cli

下一篇:wmux

同类项目推荐

n8n 开源

拖拽搭建自动化流程,轻松接入 AI 与 400+ 应用,搞定重复工作。

Fair-code workflow automation platform with native AI capabilities. Combine visual b···

★ 205363 2026-08-10
feishu-docx 开源

让 AI 代理轻松读写飞书文档,双向转换 Markdown

Feishu/Lark Docs、Sheet、Bitable <-> Markdown | AI Agent-friendly knowledge base exp···

★ 261 2026-08-09
robotcode 开源

让 Robot Framework 拥有现代 IDE 体验,调试、补全、运行一气呵成。

Open Source Toolkit for Robot Framework, providing Language Server Protocol support,···

★ 300 2026-08-10
puppeteer 开源

用 JavaScript 轻松操控无头浏览器,搞定自动化测试与网页抓取。

JavaScript API for Chrome and Firefox

★ 95591 2026-08-10