关键词

Markdown任务管理Git项目看板AI助手集成任务上下文服务项目协作

项目简介

Backlog.md是一个以Markdown文件为核心的任务管理器和看板可视化工具，适用于任何Git仓库。它将您的项目文件夹转换为一个自包含的任务面板，利用纯文本Markdown文件和零配置的命令行界面（CLI）驱动。Backlog.md支持AI集成，通过Model Context Protocol (MCP) 或传统CLI命令，让AI助手能够理解和操作您的任务。

主要功能点

  • Markdown原生任务管理: 将每个任务作为独立的'.md'文件进行管理。
  • AI就绪: 通过MCP或CLI协议，与Claude Code、Gemini CLI、Codex等AI助手无缝协作，让AI能够创建、编辑和查看任务。
  • 即时终端看板: 'backlog board' 命令可在终端中实时显示项目看板。
  • 现代化Web界面: 'backlog browser' 命令启动一个简洁的Web用户界面，提供可视化任务管理（支持拖放、富文本编辑、实时更新等）。
  • 强大的搜索和查询: 支持对任务、文档和决策进行模糊搜索，并提供丰富的查询命令进行筛选和列表显示。
  • 数据私有与离线工作: 所有数据都存储在本地Git仓库中，确保100%的隐私和离线可用性。
  • 跨平台支持: 兼容macOS、Linux和Windows操作系统。

安装步骤

您可以通过多种方式全局安装Backlog.md。请选择其中一种方式：

  • 使用npm: 
    npm i -g backlog.md
  • 使用Bun: 
    bun add -g backlog.md
  • 使用Homebrew (macOS/Linux): 
    brew install backlog-md
  • 使用Nix: 
    nix run github:MrLesk/Backlog.md

安装完成后，在您的项目目录中运行 'backlog init "My Awesome Project"' 初始化项目，并根据提示选择AI代理集成模式（推荐选择MCP）。

服务器配置 (MCP客户端使用)

Backlog.md内置的MCP服务器通过标准输入/输出（Stdio）与MCP客户端通信。要将Backlog.md作为MCP服务器与您的AI客户端（如Claude Code, Codex, Gemini CLI）连接，通常需要配置AI客户端，告知其如何启动Backlog.md的MCP服务器。以下是常见AI客户端的配置信息示例，您只需根据客户端的说明进行配置，无需编写代码：

  • Claude Code 客户端配置示例： 在Claude Code客户端中，通过命令行添加Backlog.md作为MCP服务器：

    claude mcp add backlog --scope user -- backlog mcp start
    • 'backlog': MCP服务器的名称，用于客户端识别。
    • 'backlog mcp start': 启动Backlog.md MCP服务器的命令行指令。

  • Codex 客户端配置示例： 在Codex客户端中，通过命令行添加Backlog.md作为MCP服务器：

    codex mcp add backlog backlog mcp start
    • 'backlog': MCP服务器的名称。
    • 'backlog mcp start': 启动Backlog.md MCP服务器的命令行指令。

  • Gemini CLI 客户端配置示例： 在Gemini CLI客户端中，通过命令行添加Backlog.md作为MCP服务器：

    gemini mcp add backlog -s user backlog mcp start
    • 'backlog': MCP服务器的名称。
    • 'backlog mcp start': 启动Backlog.md MCP服务器的命令行指令。

配置完成后，AI助手可以通过资源URI 'backlog://workflow/overview' 获取Backlog.md的工作流说明，并通过调用Backlog.md提供的工具来管理任务、文档和决策。

基本使用方法

  1. 创建任务: 使用CLI创建新任务： 
    backlog task create "开发新功能"
  2. 查看任务板: 在终端中查看交互式看板： 
    backlog board
    或启动Web界面： 
    backlog browser
  3. 让AI创建任务: 与您的AI助手对话，指示其根据需求创建相关任务。例如，使用Claude Code： 
    Claude I would like to build a search functionality in the web view that searches for:
* tasks
* docs
* decisions
Please create relevant tasks to tackle this request.
  4. 让AI处理任务: 指示AI助手处理特定任务。例如，让Claude Code根据任务ID实现Web搜索功能： 
    Claude please implement all tasks related to the web search functionality (task-10, task-11, task-12)
* before starting to write code use 'ultrathink mode' to prepare and add an implementation plan to the task
* use multiple sub-agents when possible and dependencies allow

信息

分类

开发者工具

访问项目