Backlog.md 用户手册

Markdown 原生的任务管理与看板可视化工具

Backlog.md 将任意 Git 仓库目录转变为自包含的项目看板。每个任务都是独立的 Markdown 文件，100% 离线私有，无需联网即可使用。

核心特性

  • Markdown-native：所有数据以 .md 文件存储，Git 原生友好
  • AI-Ready：支持 Claude Code、Gemini CLI、Codex、Kiro、Cursor 等 AI 助手
  • 双模式界面：终端 TUI 看板 + 现代 Web 浏览器界面
  • 富文本粘贴：从 Word、Google Docs 一键粘贴为 Markdown，支持 .docx 文件上传
  • 日期与计划：任务与里程碑支持 dueDate、plannedStart、plannedEnd，看板卡片实时显示计划窗口与逾期高亮
  • 项目健康度：临期、逾期、停滞、阻塞四维指标，Web 统计页与 CLI overview 命令统一呈现
  • Wiki 知识库：LLM 维护的增量式项目知识库，人类可读可编辑；浏览器中支持文件树导航、在线编辑、labels 标签与实时同步；内置 skill 可安装到 Claude/Codex
  • 任务图谱：任务关系知识图谱，支持 Cypher 查询（CLI backlog graph 与 MCP 图谱工具）与 Web 可视化，默认使用 RyuGraph WASM 后端，零原生依赖
  • Office 文档预览：应用内直接预览 .docx / .pdf / .pptx / .xlsx 文档，Word 与 Excel 支持编辑并写回源文件；不支持的格式给出转格式提示
  • 实况 SQL 查询块：文档内嵌入 sqlite-query / duckdb-query / mdb-query 围栏块，Web 阅读视图渲染只读实况查询结果（SQLite / DuckDB / Access，500 行上限），支持阅读视图内就地编辑
  • 图表块：正文用 mermaid / echarts 围栏块画流程图与数据图，ECharts 覆盖全部内置系列并跟随明暗主题；查询结果可直接出图，也可用 fromQuery 引用命名的查询块
  • 快速笔记 Memos：backlog/memos/ 轻量捕获收件箱，终端 / Web / MCP / 搜索四入口共享同一存储，正文实体 ID 与 wikilink 自动接入知识网
  • 跨平台：macOS、Linux、Windows

两种使用路径

  1. MCP 规范驱动（推荐）：AI 代理通过 MCP 协议直接管理任务，无需手动输入命令
  2. 手动 CLI 模式：用户通过终端命令直接操作任务、看板与文档

安装

npm i -g @kuwork/backlog.md

其他安装方式：

  • bun add -g @kuwork/backlog.md
  • brew install backlog-md（上游 formula）
  • nix run github:MrLesk/Backlog.md（上游 flake）

快速开始

# 初始化项目
backlog init my-project

# 创建任务
backlog task create "实现用户登录功能"

# 查看 TUI 看板
backlog board

# 启动 Web 界面
backlog browser

本手册涵盖从基础安装到高级 AI 集成的完整使用指南。

results matching ""

    No results matching ""