mdp

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

mdp — Markdown Project Management

mdp — Markdown项目管理

A file-based project management CLI. Projects live in
.mdp/
directories containing markdown files with YAML frontmatter.
一款基于文件的项目管理CLI工具。项目存储在
.mdp/
目录中,包含带YAML前置元数据的Markdown文件。

IMPORTANT: On first use

重要提示:首次使用须知

When you start working with an existing project, immediately read
.mdp/settings.json
to learn the project's valid statuses, types, labels, and priorities, and read
.mdp/project.md
for project identity, health, and instructions. Do not guess or assume defaults — the config is the source of truth. Statuses are grouped by category (e.g.,
completed
,
started
), and only the
name
field within each status is used in commands.
当你开始处理现有项目时,请**立即阅读
.mdp/settings.json
以了解项目的有效状态、类型、标签和优先级,并阅读
.mdp/project.md
**获取项目标识、健康状态和操作说明。请勿猜测或假设默认配置——配置文件是唯一的事实来源。状态按类别分组(如
completed
started
),命令中仅使用每个状态内的
name
字段。

Installation

安装

bash
bun install -g github:varunpandey0502/markdown-projects
See INSTALL.md for details.
bash
bun install -g github:varunpandey0502/markdown-projects
详情请参阅INSTALL.md

Quick start

快速入门

bash
mdp project create -p . --preset software
mdp issue create -p . -t "Fix login bug" --type bug --priority High
mdp issue list -p .
mdp issue update -p . --id ISS-1 -s "In Progress"
bash
mdp project create -p . --preset software
mdp issue create -p . -t "修复登录bug" --type bug --priority High
mdp issue list -p .
mdp issue update -p . --id ISS-1 -s "In Progress"

Project structure

项目结构

.mdp/
├── settings.json          # Schema config: statuses, priorities, labels, types (committed)
├── project.md             # Project identity: title, description, instructions, health, log (committed)
├── issues/                # Flat directory of issue folders
│   └── ISS-1-add-auth/
│       └── ISS-1-add-auth.md
├── milestones/            # Flat directory of milestone folders
│   └── M-1-v1-release/
│       └── M-1-v1-release.md
├── docs/                  # Documentation
└── templates/             # Issue/milestone templates
.mdp/
├── settings.json          # 架构配置:状态、优先级、标签、类型(已提交)
├── project.md             # 项目标识:标题、描述、操作说明、健康状态、日志(已提交)
├── issues/                # 议题文件夹的扁平目录
│   └── ISS-1-add-auth/
│       └── ISS-1-add-auth.md
├── milestones/            # 里程碑文件夹的扁平目录
│   └── M-1-v1-release/
│       └── M-1-v1-release.md
├── docs/                  # 文档
└── templates/             # 议题/里程碑模板

Configuration

配置

Schema config is stored in
.mdp/settings.json
with entity-scoped objects:
json
{
  "issues": {
    "prefix": "ISS",
    "statuses": {
      "triage": [], "backlog": [...], "unstarted": [...],
      "started": [...], "completed": [...], "canceled": []
    },
    "priorities": [...], "labels": [...], "types": [...]
  },
  "milestones": {
    "prefix": "M",
    "statuses": {
      "backlog": [], "planned": [...], "in_progress": [...],
      "completed": [...], "canceled": []
    },
    "priorities": [...], "labels": [...]
  }
}
Project identity is stored in
.mdp/project.md
with YAML frontmatter:
yaml
---
title: My Project
description: Optional one-line project description
instructions: Optional free-text guidance for LLMs and collaborators
health: on-track
log: []
createdAt: 2025-01-01T00:00:00.000Z
updatedAt: 2025-01-01T00:00:00.000Z
---
Statuses are grouped by status category (lifecycle stage). Each category maps to an array of
{ name, description }
status objects. The system uses categories (not status names) to determine completion, overdue detection, etc.
Issues and milestones have independent statuses, priorities, and labels.
At runtime,
.mdp/settings.json
is the sole source of truth for schema config — no merge layers.
At project creation: preset (built-in or custom from
~/.mdp/settings.json
) → CLI flag overrides → written to
settings.json
.
Custom presets and default preferences (default preset, output format) are stored in
~/.mdp/settings.json
.
架构配置存储在
.mdp/settings.json
中,包含按实体划分的对象:
json
{
  "issues": {
    "prefix": "ISS",
    "statuses": {
      "triage": [], "backlog": [...], "unstarted": [...],
      "started": [...], "completed": [...], "canceled": []
    },
    "priorities": [...], "labels": [...], "types": [...]
  },
  "milestones": {
    "prefix": "M",
    "statuses": {
      "backlog": [], "planned": [...], "in_progress": [...],
      "completed": [...], "canceled": []
    },
    "priorities": [...], "labels": [...]
  }
}
项目标识存储在
.mdp/project.md
中,带有YAML前置元数据:
yaml
---
title: 我的项目
description: 可选的单行项目描述
instructions: 为LLM和协作者提供的可选自由文本指导
health: on-track
log: []
createdAt: 2025-01-01T00:00:00.000Z
updatedAt: 2025-01-01T00:00:00.000Z
---
状态按状态类别(生命周期阶段)分组。每个类别映射到一组
{ name, description }
状态对象。系统使用类别(而非状态名称)来判断完成度、逾期检测等。
议题和里程碑拥有独立的状态、优先级和标签。
在运行时,
.mdp/settings.json
是架构配置的唯一事实来源——无合并层级。
创建项目时:预设(内置或来自
~/.mdp/settings.json
的自定义预设)→ CLI标志覆盖 → 写入
settings.json
自定义预设和默认偏好(默认预设、输出格式)存储在
~/.mdp/settings.json
中。

Global options

全局选项

Every command accepts:
-p <path>
(project path),
-f json|table
(output format),
-q
(quiet),
-V
(verbose).
All output is JSON:
{ "ok": true, "data": {...} }
or
{ "ok": false, "error": {...} }
.
每个命令都接受:
-p <path>
(项目路径)、
-f json|table
(输出格式)、
-q
(静默模式)、
-V
(详细模式)。
所有输出均为JSON格式:
{ "ok": true, "data": {...} }
{ "ok": false, "error": {...} }

Commands

命令

Project management

项目管理

  • mdp project create -p <path> [--preset <name>] [-F|--force] [--with-templates] [--no-with-templates] [--issue-prefix <prefix>] [--milestone-prefix <prefix>] [--tags <tags>] [--title <title>] [--description <desc>] [--instructions <text>]
    — Create a new project (presets: software, marketing, design, product, social-media, generic)
  • mdp project get -p <path> [--no-include-content]
    — Get project identity, health, log, and body
  • mdp project settings -p <path>
    — Show project schema settings
  • mdp project stats -p <path>
    — Project statistics
  • mdp project fix -p <path> [--dry-run]
    — Fix folder structure to match frontmatter
  • mdp project create -p <path> [--preset <name>] [-F|--force] [--with-templates] [--no-with-templates] [--issue-prefix <prefix>] [--milestone-prefix <prefix>] [--tags <tags>] [--title <title>] [--description <desc>] [--instructions <text>]
    — 创建新项目(预设选项:software、marketing、design、product、social-media、generic)
  • mdp project get -p <path> [--no-include-content]
    — 获取项目标识、健康状态、日志和内容
  • mdp project settings -p <path>
    — 查看项目架构配置
  • mdp project stats -p <path>
    — 项目统计数据
  • mdp project fix -p <path> [--dry-run]
    — 修复文件夹结构以匹配前置元数据

Project log

项目日志

Manage log entries on the project (stored in
.mdp/project.md
):
  • mdp project log add -p <path> -b "message" [--author <name>] [--health on-track|at-risk|off-track] [--dry-run]
  • mdp project log list -p <path>
  • mdp project log get -p <path> --index <n>
  • mdp project log update -p <path> --index <n> [-b <body>] [--author <name>] [--health <health>] [--dry-run]
  • mdp project log delete -p <path> --index <n> [--dry-run]
管理项目的日志条目(存储在
.mdp/project.md
中):
  • mdp project log add -p <path> -b "消息" [--author <名称>] [--health on-track|at-risk|off-track] [--dry-run]
  • mdp project log list -p <path>
    — 列出项目日志
  • mdp project log get -p <path> --index <n>
    — 获取指定索引的日志条目
  • mdp project log update -p <path> --index <n> [-b <内容>] [--author <名称>] [--health <健康状态>] [--dry-run]
    — 更新指定索引的日志条目
  • mdp project log delete -p <path> --index <n> [--dry-run]
    — 删除指定索引的日志条目

Project registry

项目注册表

Manage projects in
~/.mdp/settings.json
:
  • mdp project list [--tag <tag>]
    — List registered projects (includes
    tagDescriptions
    in output)
  • mdp project add <path> [--tags <tags>]
  • mdp project remove <path>
  • mdp project tag <path> --add <tags> | --remove <tags>
    — Tags added via
    --add
    are auto-created globally
管理
~/.mdp/settings.json
中的项目:
  • mdp project list [--tag <标签>]
    — 列出已注册的项目(输出包含
    tagDescriptions
  • mdp project add <path> [--tags <标签>]
    — 将项目添加到注册表
  • mdp project remove <path>
    — 从注册表中移除项目
  • mdp project tag <path> --add <标签> | --remove <标签>
    — 通过
    --add
    添加的标签会自动全局创建

Tags

标签管理

Manage tags globally via
mdp tag
:
  • mdp tag list
    — List all tags with descriptions and project counts
  • mdp tag add <tag> [-d "description"]
    — Create a tag (description defaults to
    ""
    )
  • mdp tag update <tag> -d "description"
    — Update a tag's description
  • mdp tag remove <tag> [--force]
    — Remove a tag;
    --force
    to also strip from projects
通过
mdp tag
全局管理标签:
  • mdp tag list
    — 列出所有标签及其描述和关联项目数量
  • mdp tag add <标签> [-d "描述"]
    — 创建标签(描述默认为
    ""
  • mdp tag update <标签> -d "描述"
    — 更新标签的描述
  • mdp tag remove <标签> [--force]
    — 删除标签;使用
    --force
    可同时从所有项目中移除该标签

Issues

议题管理

Create

创建议题

mdp issue create -p <path> -t "Title" [options]
OptionDescription
-t, --title <title>
Issue title (required)
--type <type>
Issue type (config-driven)
-s, --status <status>
Initial status (default: first status in config)
--priority <priority>
Priority level (default: null)
-l, --labels <labels>
Comma-separated labels
-a, --assignee <assignee>
Assignee identifier
-m, --milestone <milestone>
Milestone ID
-e, --estimate <estimate>
Effort points (positive integer)
--spent <spent>
Actual effort spent
--due-date <date>
Due date (YYYY-MM-DD)
--blocked-by <ids>
Comma-separated issue IDs
--parent <id>
Parent issue ID
--related-to <ids>
Comma-separated issue IDs
--checklist <items>
Comma-separated checklist items
-d, --description <desc>
Short description
-c, --content <content>
Full markdown body (or
-
for stdin)
--template <name>
Template name from .mdp/templates/
--dry-run
Preview without creating
mdp issue create -p <path> -t "标题" [选项]
选项描述
-t, --title <title>
议题标题(必填)
--type <type>
议题类型(由配置驱动)
-s, --status <status>
初始状态(默认:配置中的第一个状态)
--priority <priority>
优先级(默认:空)
-l, --labels <labels>
逗号分隔的标签列表
-a, --assignee <assignee>
经办人标识
-m, --milestone <milestone>
里程碑ID
-e, --estimate <estimate>
工作量预估(正整数)
--spent <spent>
实际花费的工作量
--due-date <date>
截止日期(格式:YYYY-MM-DD)
--blocked-by <ids>
逗号分隔的依赖议题ID列表
--parent <id>
父议题ID
--related-to <ids>
逗号分隔的关联议题ID列表
--checklist <items>
逗号分隔的检查项列表
-d, --description <desc>
简短描述
-c, --content <content>
完整Markdown内容(或使用
-
从标准输入读取)
--template <name>
来自
.mdp/templates/
的模板名称
--dry-run
预览创建结果而不实际创建

List

列出议题

mdp issue list -p <path> [options]
OptionDescription
-s, --status <statuses>
Comma-separated status filter
--type <types>
Comma-separated type filter
--priority <priority>
Priority filter
-l, --labels <labels>
Comma-separated labels filter
-a, --assignee <assignee>
Filter by assignee (
none
for unassigned)
-m, --milestone <milestone>
Filter by milestone ID (
none
for unassigned)
--blocked <bool>
true
for blocked only,
false
for unblocked
--parent <id>
Filter by parent issue ID (
none
for top-level)
--created-after <date>
Created after date (YYYY-MM-DD)
--created-before <date>
Created before date (YYYY-MM-DD)
--due-before <date>
Due before date (YYYY-MM-DD)
--due-after <date>
Due after date (YYYY-MM-DD)
--sort <field>
Sort: id, title, status, priority, type, created, updated, estimate, spent, dueDate (default: id)
--order <order>
Sort order: asc, desc (default: asc)
mdp issue list -p <path> [选项]
选项描述
-s, --status <statuses>
逗号分隔的状态筛选条件
--type <types>
逗号分隔的类型筛选条件
--priority <priority>
优先级筛选条件
-l, --labels <labels>
逗号分隔的标签筛选条件
-a, --assignee <assignee>
按经办人筛选(
none
表示未分配)
-m, --milestone <milestone>
按里程碑ID筛选(
none
表示未关联)
--blocked <bool>
true
仅显示被阻塞的议题,
false
仅显示未被阻塞的议题
--parent <id>
按父议题ID筛选(
none
表示顶级议题)
--created-after <date>
筛选指定日期之后创建的议题(格式:YYYY-MM-DD)
--created-before <date>
筛选指定日期之前创建的议题(格式:YYYY-MM-DD)
--due-before <date>
筛选指定日期之前截止的议题(格式:YYYY-MM-DD)
--due-after <date>
筛选指定日期之后截止的议题(格式:YYYY-MM-DD)
--sort <field>
排序字段:id、title、status、priority、type、created、updated、estimate、spent、dueDate(默认:id)
--order <order>
排序顺序:asc(升序)、desc(降序)(默认:asc)

Get

获取议题详情

mdp issue get -p <path> --id <id> [--no-include-content]
mdp issue get -p <path> --id <id> [--no-include-content]

Update

更新议题

mdp issue update -p <path> --id <id> [options]
OptionDescription
-t, --title <title>
New title
--type <type>
New type
-s, --status <status>
New status
--priority <priority>
New priority
-a, --assignee <assignee>
Set assignee (
none
to clear)
-m, --milestone <milestone>
Set milestone (
none
to clear)
-e, --estimate <estimate>
Set estimate (
none
to clear)
--spent <spent>
Set spent (
none
to clear)
--due-date <date>
Set due date (
none
to clear)
--parent <id>
Set parent issue (
none
to clear)
-l, --labels <labels>
Set labels (replaces all)
--add-labels <labels>
Add labels
--remove-labels <labels>
Remove labels
--blocked-by <ids>
Set blockedBy (replaces all)
--add-blocked-by <ids>
Add to blockedBy (with cycle detection)
--remove-blocked-by <ids>
Remove from blockedBy
--related-to <ids>
Set relatedTo (replaces all)
--add-related-to <ids>
Add to relatedTo
--remove-related-to <ids>
Remove from relatedTo
--add-checklist <items>
Add checklist items
--remove-checklist <items>
Remove checklist items by text
--check <items>
Check items by text
--uncheck <items>
Uncheck items by text
-c, --content <content>
Replace markdown body
--dry-run
Preview without writing
mdp issue update -p <path> --id <id> [选项]
选项描述
-t, --title <title>
新标题
--type <type>
新类型
-s, --status <status>
新状态
--priority <priority>
新优先级
-a, --assignee <assignee>
设置经办人(
none
表示清除)
-m, --milestone <milestone>
设置关联里程碑(
none
表示清除)
-e, --estimate <estimate>
设置工作量预估(
none
表示清除)
--spent <spent>
设置实际花费工作量(
none
表示清除)
--due-date <date>
设置截止日期(
none
表示清除)
--parent <id>
设置父议题(
none
表示清除)
-l, --labels <labels>
设置标签(替换所有现有标签)
--add-labels <labels>
添加标签
--remove-labels <labels>
移除标签
--blocked-by <ids>
设置依赖议题(替换所有现有依赖)
--add-blocked-by <ids>
添加依赖议题(包含循环检测)
--remove-blocked-by <ids>
移除依赖议题
--related-to <ids>
设置关联议题(替换所有现有关联)
--add-related-to <ids>
添加关联议题
--remove-related-to <ids>
移除关联议题
--add-checklist <items>
添加检查项
--remove-checklist <items>
按文本移除检查项
--check <items>
按文本标记检查项为已完成
--uncheck <items>
按文本标记检查项为未完成
-c, --content <content>
替换Markdown内容
--dry-run
预览更新结果而不实际写入

Delete

删除议题

mdp issue delete -p <path> --id <id> [--dry-run]
Cleans up blockedBy, relatedTo, and parent references in other issues.
mdp issue delete -p <path> --id <id> [--dry-run]
清理其他议题中对该议题的依赖、关联和父议题引用。

Log

议题日志

Manage log entries on an issue.
mdp issue log add -p <path> --id <id> -b "message" [--author <name>] [--dry-run]
mdp issue log list -p <path> --id <id>
mdp issue log get -p <path> --id <id> --index <n>
mdp issue log update -p <path> --id <id> --index <n> [--author <a>] [-b <body>] [--dry-run]
mdp issue log delete -p <path> --id <id> --index <n> [--dry-run]
管理单个议题的日志条目:
mdp issue log add -p <path> --id <id> -b "消息" [--author <名称>] [--dry-run]
mdp issue log list -p <path> --id <id>
mdp issue log get -p <path> --id <id> --index <n>
mdp issue log update -p <path> --id <id> --index <n> [--author <a>] [-b <内容>] [--dry-run]
mdp issue log delete -p <path> --id <id> --index <n> [--dry-run]

Batch create

批量创建议题

Create multiple issues at once by piping a JSON array via stdin. Processes items sequentially; continues on error and reports per-item success/failure.
echo '<json-array>' | mdp issue batch-create -p <path> [--dry-run]
Input: JSON array of issue objects. Required field:
title
. All other fields match
issue create
options (
type
,
status
,
priority
,
labels
,
assignee
,
milestone
,
estimate
,
spent
,
dueDate
,
blockedBy
,
parent
,
relatedTo
,
checklist
,
description
,
content
,
template
). Array fields (
labels
,
blockedBy
, etc.) accept
string[]
.
Output:
json
{
  "ok": true,
  "data": {
    "total": 3, "succeeded": 2, "failed": 1,
    "results": [
      { "ok": true, "data": { "id": "ISS-4", "title": "...", "filePath": "..." } },
      { "ok": false, "error": { "code": "INVALID_STATUS", "message": "...", "index": 2 } }
    ]
  }
}
Exits with code 1 if any item failed.
通过标准输入传入JSON数组,批量创建多个议题。按顺序处理条目;遇到错误时继续执行,并报告每个条目的成功/失败状态。
echo '<json-array>' | mdp issue batch-create -p <path> [--dry-run]
输入:议题对象的JSON数组。必填字段:
title
。其他所有字段与
issue create
选项一致(
type
status
priority
labels
assignee
milestone
estimate
spent
dueDate
blockedBy
parent
relatedTo
checklist
description
content
template
)。数组类型字段(如
labels
blockedBy
等)接受
string[]
格式。
输出:
json
{
  "ok": true,
  "data": {
    "total": 3, "succeeded": 2, "failed": 1,
    "results": [
      { "ok": true, "data": { "id": "ISS-4", "title": "...", "filePath": "..." } },
      { "ok": false, "error": { "code": "INVALID_STATUS", "message": "...", "index": 2 } }
    ]
  }
}
如果有任何条目创建失败,命令将以退出码1结束。

Batch update

批量更新议题

Update multiple issues at once by piping a JSON array via stdin. Processes items sequentially; continues on error and reports per-item success/failure. In-memory state is refreshed after each successful update for accurate cycle detection.
echo '<json-array>' | mdp issue batch-update -p <path> [--dry-run]
Input: JSON array of update objects. Required field:
id
. All other fields match
issue update
options (
title
,
type
,
status
,
priority
,
labels
,
addLabels
,
removeLabels
,
assignee
,
milestone
,
estimate
,
spent
,
dueDate
,
blockedBy
,
addBlockedBy
,
removeBlockedBy
,
parent
,
relatedTo
,
addRelatedTo
,
removeRelatedTo
,
addChecklist
,
removeChecklist
,
check
,
uncheck
,
content
). Array fields accept
string[]
.
Output: Same envelope format as batch-create, with
changes
and
filePath
per item.
Exits with code 1 if any item failed.
通过标准输入传入JSON数组,批量更新多个议题。按顺序处理条目;遇到错误时继续执行,并报告每个条目的成功/失败状态。每次成功更新后会刷新内存状态,以确保循环检测的准确性。
echo '<json-array>' | mdp issue batch-update -p <path> [--dry-run]
输入:更新对象的JSON数组。必填字段:
id
。其他所有字段与
issue update
选项一致(
title
type
status
priority
labels
addLabels
removeLabels
assignee
milestone
estimate
spent
dueDate
blockedBy
addBlockedBy
removeBlockedBy
parent
relatedTo
addRelatedTo
removeRelatedTo
addChecklist
removeChecklist
check
uncheck
content
)。数组类型字段接受
string[]
格式。
输出:与批量创建的信封格式相同,每个条目包含
changes
filePath
字段。
如果有任何条目更新失败,命令将以退出码1结束。

Milestones

里程碑管理

Create

创建里程碑

mdp milestone create -p <path> -t "Title" [options]
OptionDescription
-t, --title <title>
Milestone title (required)
-s, --status <status>
Initial status (default: first status in config)
--priority <priority>
Priority level (default: null)
-l, --labels <labels>
Comma-separated labels
--start-date <date>
Start date (YYYY-MM-DD)
--due-date <date>
Due date (YYYY-MM-DD)
--checklist <items>
Comma-separated checklist items
-d, --description <desc>
Short description
-c, --content <content>
Full markdown body
--template <name>
Template name from .mdp/templates/
--dry-run
Preview without creating
mdp milestone create -p <path> -t "标题" [选项]
选项描述
-t, --title <title>
里程碑标题(必填)
-s, --status <status>
初始状态(默认:配置中的第一个状态)
--priority <priority>
优先级(默认:空)
-l, --labels <labels>
逗号分隔的标签列表
--start-date <date>
开始日期(格式:YYYY-MM-DD)
--due-date <date>
截止日期(格式:YYYY-MM-DD)
--checklist <items>
逗号分隔的检查项列表
-d, --description <desc>
简短描述
-c, --content <content>
完整Markdown内容
--template <name>
来自
.mdp/templates/
的模板名称
--dry-run
预览创建结果而不实际创建

List

列出里程碑

mdp milestone list -p <path> [options]
OptionDescription
-s, --status <statuses>
Comma-separated status filter
--priority <priority>
Priority filter
-l, --labels <labels>
Comma-separated labels filter
--overdue <bool>
true
for overdue only,
false
for not overdue
--sort <field>
Sort: id, title, status, priority, created, updated, dueDate, completion (default: id)
--order <order>
Sort order: asc, desc (default: asc)
mdp milestone list -p <path> [选项]
选项描述
-s, --status <statuses>
逗号分隔的状态筛选条件
--priority <priority>
优先级筛选条件
-l, --labels <labels>
逗号分隔的标签筛选条件
--overdue <bool>
true
仅显示逾期的里程碑,
false
仅显示未逾期的里程碑
--sort <field>
排序字段:id、title、status、priority、created、updated、dueDate、completion(默认:id)
--order <order>
排序顺序:asc(升序)、desc(降序)(默认:asc)

Get

获取里程碑详情

mdp milestone get -p <path> --id <id> [--no-include-content]
mdp milestone get -p <path> --id <id> [--no-include-content]

Update

更新里程碑

mdp milestone update -p <path> --id <id> [options]
OptionDescription
-t, --title <title>
New title
-s, --status <status>
New status
--priority <priority>
New priority
--start-date <date>
Set start date (
none
to clear)
--due-date <date>
Set due date (
none
to clear)
-l, --labels <labels>
Set labels (replaces all)
--add-labels <labels>
Add labels
--remove-labels <labels>
Remove labels
--add-checklist <items>
Add checklist items
--remove-checklist <items>
Remove checklist items by text
--check <items>
Check items by text
--uncheck <items>
Uncheck items by text
-c, --content <content>
Replace markdown body
--dry-run
Preview without writing
mdp milestone update -p <path> --id <id> [选项]
选项描述
-t, --title <title>
新标题
-s, --status <status>
新状态
--priority <priority>
新优先级
--start-date <date>
设置开始日期(
none
表示清除)
--due-date <date>
设置截止日期(
none
表示清除)
-l, --labels <labels>
设置标签(替换所有现有标签)
--add-labels <labels>
添加标签
--remove-labels <labels>
移除标签
--add-checklist <items>
添加检查项
--remove-checklist <items>
按文本移除检查项
--check <items>
按文本标记检查项为已完成
--uncheck <items>
按文本标记检查项为未完成
-c, --content <content>
替换Markdown内容
--dry-run
预览更新结果而不实际写入

Delete

删除里程碑

mdp milestone delete -p <path> --id <id> [--dry-run]
Clears milestone reference from all assigned issues.
mdp milestone delete -p <path> --id <id> [--dry-run]
清除所有关联议题中的里程碑引用。

Progress

里程碑进度

mdp milestone progress -p <path> --id <id>
Returns completion percentage, issue counts by status, and list of assigned issues.
mdp milestone progress -p <path> --id <id>
返回完成百分比、按状态分组的议题数量,以及关联议题列表。

Log

里程碑日志

Manage log entries on a milestone.
mdp milestone log add -p <path> --id <id> -b "message" [--author <name>] [--dry-run]
mdp milestone log list -p <path> --id <id>
mdp milestone log get -p <path> --id <id> --index <n>
mdp milestone log update -p <path> --id <id> --index <n> [--author <a>] [-b <body>] [--dry-run]
mdp milestone log delete -p <path> --id <id> --index <n> [--dry-run]
管理单个里程碑的日志条目:
mdp milestone log add -p <path> --id <id> -b "消息" [--author <名称>] [--dry-run]
mdp milestone log list -p <path> --id <id>
mdp milestone log get -p <path> --id <id> --index <n>
mdp milestone log update -p <path> --id <id> --index <n> [--author <a>] [-b <内容>] [--dry-run]
mdp milestone log delete -p <path> --id <id> --index <n> [--dry-run]

Search

搜索

mdp search -p <path> -q "query text" [--limit <n>]
Searches project, issues, and milestones by text content using BM25 ranking. Returns matched fields with snippets. Use
--entity project
to search only the project file.
mdp search -p <path> -q "查询文本" [--limit <n>]
使用BM25排名算法,按文本内容搜索项目、议题和里程碑。返回匹配字段及片段。使用
--entity project
可仅搜索项目文件。

Workflow recommendations

工作流建议

  1. Start with
    mdp project create -p . --preset software
    to set up a project
  2. Create issues with
    mdp issue create
    — use
    --type
    and
    --labels
    for organization
  3. For bulk operations, use
    mdp issue batch-create
    and
    mdp issue batch-update
    with JSON arrays piped via stdin
  4. Move issues through statuses with
    mdp issue update --id ISS-1 -s "In Progress"
  5. Group work into milestones, then track with
    mdp milestone progress
  6. Use
    mdp issue list
    with filters to find relevant issues
See WORKFLOWS.md for detailed workflow patterns.
  1. 使用
    mdp project create -p . --preset software
    初始化项目
  2. 使用
    mdp issue create
    创建议题——通过
    --type
    --labels
    进行分类管理
  3. 对于批量操作,使用
    mdp issue batch-create
    mdp issue batch-update
    ,通过标准输入传入JSON数组
  4. 使用
    mdp issue update --id ISS-1 -s "In Progress"
    将议题推进到下一状态
  5. 将工作分组到里程碑中,然后使用
    mdp milestone progress
    跟踪进度
  6. 使用带筛选条件的
    mdp issue list
    查找相关议题
详细工作流模式请参阅WORKFLOWS.md

References

参考文档

  • INSTALL.md — Installation guide
  • WORKFLOWS.md — Detailed workflow patterns
  • PROJECTS.md — Project commands reference
  • ISSUES.md — Issue commands reference
  • MILESTONES.md — Milestone commands reference
  • PROJECT-CONFIG.md — Project configuration reference
  • GLOBAL-CONFIG.md — Global configuration reference
  • INSTALL.md — 安装指南
  • WORKFLOWS.md — 详细工作流模式
  • PROJECTS.md — 项目命令参考
  • ISSUES.md — 议题命令参考
  • MILESTONES.md — 里程碑命令参考
  • PROJECT-CONFIG.md — 项目配置参考
  • GLOBAL-CONFIG.md — 全局配置参考