zPlanner v1.4.0

zPlanner是一款命令行工具，旨在协助项目规划与管理，尤其专注于软件开发项目的管理。该工具源于对终端直接项目管理的需求，无需复杂的图形界面。

zPlanner的主要特色在于其作为AI辅助开发IDE的记忆系统功能。通过维护结构化的项目记录，ZPlanner帮助保存开发上下文，使AI助手能够更好地理解项目的结构、历史和当前状态，从而提供更准确和情境化的建议和支持。

目的

zPlanner创建的目标如下：

1. 简洁性：直接从终端进行项目管理
2. 效率：减少行政任务时间消耗
3. 灵活性：适应不同项目类型和方法论
4. 可视化：生成清晰响应式的HTML报告
5. 可追溯性：维护进度历史和更新记录
6. AI上下文：作为AI辅助开发的记忆系统，维护结构化的项目上下文

AI优先设计

zPlanner针对现代AI辅助开发进行了优化：

• 上下文保留：维护供AI助手使用的结构化历史记忆
• 层次结构：有助于AI理解项目的组织结构
• 变更跟踪：使AI助手了解项目演变
• 清晰文档：统一格式提升AI的解读能力

功能

项目管理

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

阶段组织

• 阶段添加
• 阶段重新排序
• 阶段重命名
• 阶段删除
• 按阶段计算进度

任务管理

• 主任务添加
• 子任务创建
• 完成标记
• 描述更新
• 任务删除

HTML报告

• 现代响应式设计
• 清晰的层次结构可视化
• 进度指示器
• 更新历史记录
• 专业BEM CSS样式

安装指南

npm install -g zplanner

使用说明

基本命令

项目管理

# 初始化新项目
zplanner init

# 生成项目文档
zplanner generate

# 配置项目设置
zplanner config

阶段操作

# 创建新阶段
zplanner phase create <名称>

# 更新现有阶段
zplanner phase update <名称> --start=<开始日期> --end=<结束日期>

# 删除阶段
zplanner phase delete <名称>

任务管理

# 添加任务到当前阶段
zplanner task add <标题> --phase=<阶段名>

# 更新任务详情
zplanner task update <ID> --title=<新标题> --status=<状态>

# 列出所有任务
zplanner task list --phase=<阶段名>

项目结构

src/
├── main.ts        # 主程序入口
├── services/      # 服务模块
│   ├── PhaseService.ts     # 阶段服务
│   └── TaskService.ts      # 任务服务
└── utils/         # 工具函数
    └── config.ts   # 配置管理

config/
├── phases.json    # 阶段定义
└── tasks.json     # 任务记录

reports/
├── output.html     # 生成的报告文件
└── templates/      # 报告模板

开发环境设置

# 克隆仓库并安装依赖
git clone https://github.com/cyllas/zPlanner.git
cd zPlanner
npm install

# 启动开发模式
npm run dev

配置文件

settings.ts允许配置：

export const settings = {
  defaultLanguage: "zh-CN",    # 默认语言设置为中文
  dateFormat: "MM/DD/YYYY",     # 日期格式：MM/DD/YYYY
  timeZone: "Asia/Shanghai",   # 时区设置为上海
  projectDefaults: {
    outputFormat: "html",       # 默认输出格式为HTML
    indentSize: 2,              # 缩进大小为2个空格
  },
  repository: {                 # 仓库信息
    url: "https://github.com/cyllas/zPlanner",
  },
  version: "1.4.0",            # 当前版本号
};

许可证

本项目采用MIT许可证，具体条款详见LICENSE文件。