zPlanner MCP

zPlanner v1.4.0 版本

zPlanner是一个命令行工具，旨在协助项目规划和管理，特别关注软件开发项目。该项目诞生于需要一个简单而强大的工具，该工具允许直接从终端进行项目管理，而不需要复杂的图形界面。

zPlanner的主要区别之一是它能够作为具有快速功能的IDE中AI辅助开发的存储系统。通过维护结构化和层次化的项目记录，ZPlanner有助于保护开发环境，使人工智能助手更好地了解项目的结构、历史和当前状态，从而提供更准确和情境化的建议和帮助。

目的

zPlanner的创建有以下目标：

1. 简洁：直接从终端启用项目管理
2. 效率：尽量减少在行政任务上花费的时间
3. 灵活性适应不同的项目类型和方法
4. 可视化：生成清晰且响应迅速的HTML报告
5. 可追溯性：维护进度历史记录和更新
6. AI背景：作为人工智能辅助开发的存储系统，维护结构化的项目上下文

AI优先设计

zPlanner的设计考虑了现代人工智能辅助开发：

• 上下文保护：维护结构化的历史记录，作为人工智能助手的记忆
• 层次结构：通过人工智能系统促进项目理解的组织
• 更改跟踪：允许AI助手了解项目进展
• 清晰的文档：改进人工智能系统解释的标准化格式

特性

项目管理

• 项目创建和配置
• 层次结构（阶段、任务和子任务）
• 自动进度计算
• 响应式HTML导出
• 更新日期跟踪

阶段组织

• 项目阶段创建
• 阶段重新排序
• 阶段重命名
• 相位移除
• 每个阶段的进度计算

任务管理

• 主要任务添加
• 子任务创建
• 竣工标记
• 描述更新
• 任务删除

HTML报告

• 现代且响应迅速的设计
• 清晰的层次可视化
• 进度指标
• 更新历史
• BEM CSS专业造型

安装

npm install -g zplanner

使用指南

基本命令

项目管理

# Initialize new project
zplanner init "Project Name"

# List project structure
zplanner list

# Export HTML report
zplanner export ./path/report.html

阶段管理

# Add phase
zplanner add-phase "Phase Name"

# Rename phase
zplanner rename-phase "Current Name" "New Name"

# Move phase
zplanner move-phase "Phase Name" 2

# Remove phase
zplanner remove-phase "Phase Name"

任务管理

# Add task
zplanner add-task "Phase" "1.1" "Task Description"

# Add subtask
zplanner add-subtask "Phase" "1.1" "1.1.1" "Subtask Description"

# Mark as complete
zplanner complete "Phase" "1.1"

# Update description
zplanner update-task "Phase" "1.1" "New Description"

# Remove task
zplanner remove-task "Phase" "1.1"

项目结构

该项目组织如下：

zPlanner/
├── src/
│   ├── cli.ts                 # Command-line interface
│   ├── index.ts              # Main entry point
│   ├── ProjectPlanner.ts     # Core project management
│   ├── config/              # Project configurations
│   ├── services/            # Business services
│   │   ├── PhaseService.ts  # Phase management
│   │   ├── TaskService.ts   # Task management
│   │   └── progress/        # Progress calculation
│   └── templates/           # HTML and CSS templates
├── dist/                    # Compiled code
└── docs/                    # Documentation

发展

先决条件

• Node.js>=14.0.0
• npm>=6.0.0

环境设置

# Clone repository
git clone https://github.com/cyllas/zPlanner.git

# Install dependencies
cd zPlanner
npm install

# Run tests
npm test

# Start development mode
npm run dev

配置

这 settings.ts 文件允许配置：

export const settings = {
  defaultLanguage: "en-US",
  dateFormat: "MM/DD/YYYY",
  timeZone: "UTC",
  projectDefaults: {
    outputFormat: "html",
    indentSize: 2,
  },
  repository: {
    url: "https://github.com/cyllas/zPlanner",
  },
  version: "1.4.0",
};

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。