Zplanner (Project Management)

🚀 zPlanner v1.4.0

zPlanner是一款命令行工具，专注于协助项目规划与管理，尤其适用于软件开发项目。它满足了用户对简单强大命令行工具的需求，无需复杂图形界面，即可直接在终端完成项目管理工作。其独特之处在于，它能作为人工智能辅助开发环境中提示功能的记忆系统，通过维护结构化、层次化的项目记录，帮助保留开发上下文，使AI助手更好地理解项目结构、历史和当前状态，进而提供更精准、贴合情境的建议与支持。

🚀 快速开始

zPlanner旨在提供简单、高效、灵活的项目管理体验，支持直接在终端进行项目管理，减少行政任务时间，适应不同项目类型和方法论，生成清晰的HTML报告，维护进度历史和更新记录，还能作为AI辅助开发的记忆系统。

✨ 主要特性

设计理念

• AI优先设计：针对现代人工智能辅助开发进行优化，具备上下文保留、层次化结构、变更跟踪和清晰文档等特性，提升AI系统对项目的理解和解读能力。

功能特性

• 项目管理：支持项目创建与配置，采用层次化结构（阶段、任务和子任务），自动计算进度，可导出响应式HTML，跟踪更新日期。
• 阶段组织：可进行阶段的添加、重新排序、重命名、删除操作，并按阶段计算进度。
• 任务管理：能添加主任务和子任务，标记完成状态，更新描述，删除任务。
• HTML报告：拥有现代且响应式的设计，清晰展示层次结构，具备进度指示器和更新历史记录，采用BEM CSS专业样式。

📦 安装指南

使用以下命令进行全局安装：

npm install -g zplanner

💻 使用示例

基本用法

# 显示帮助信息
zplanner --help

# 查看版本信息
zplanner --version

配置文件

配置文件位于~/.config/zplanner/settings.json，内容如下：

{
  "defaultLanguage": "zh-CN",
  "dateFormat": "YYYY-MM-DD",
  "timeZone": "Asia/Shanghai",
  "projectDefaults": {
    "outputFormat": "html",
    "indentSize": 4
  },
  "repository": {
    "url": "https://github.com/cyllas/zPlanner"
  },
  "version": "1.4.0"
}

📚 详细文档

配置说明

settings.ts文件允许配置以下内容：

export const settings = {
  defaultLanguage: "zh-CN",
  dateFormat: "YYYY-MM-DD",
  timeZone: "Asia/Shanghai",
  projectDefaults: {
    outputFormat: "html",
    indentSize: 4,
  },
  repository: {
    url: "https://github.com/cyllas/zPlanner",
  },
  version: "1.4.0",
};

📄 许可证

本项目使用MIT许可证，详细内容请查看LICENSE文件。