Zplanner (Project Management)

🚀 zPlanner v1.4.0

zPlanner是一款命令行工具，專注於項目規劃與管理，尤其在軟件開發項目管理方面表現出色。它滿足了人們對簡單且強大的命令行工具的需求，無需複雜圖形界面，即可直接在終端進行高效的項目管理。此外，zPlanner還能作為人工智能輔助開發環境中提示功能的記憶系統，通過維護結構化和層次化的項目記錄，幫助AI助手更好地理解項目的結構、歷史和當前狀態，從而提供更精準、更貼合實際情況的建議與支持。

🚀 快速開始

zPlanner是一款強大的命令行工具，可直接在終端進行項目管理。以下是快速上手的步驟：

# 安裝zPlanner
npm install -g zplanner

# 顯示幫助信息
zplanner --help

# 查看版本信息
zplanner --version

✨ 主要特性

目的明確

zPlanner的設計目標涵蓋了簡單性、效率、靈活性等多個方面：

1. 簡單性：直接在終端進行項目管理。
2. 效率：減少行政任務的時間支出。
3. 靈活性：適應不同類型的項目和方法論。
4. 可視化：生成清晰且響應式的HTML報告。
5. 可追溯性：維護進度歷史和更新記錄。
6. AI上下文：作為人工智能輔助開發的記憶系統，維護結構化的項目上下文。

AI優先設計

zPlanner針對現代人工智能輔助開發進行了深度優化：

• 上下文保留：維護結構化的歷史記錄，供AI助手使用。
• 層次化結構：便於AI系統理解項目的組織方式。
• 變更跟蹤：使AI助手能夠理解項目的演變過程。
• 清晰文檔：標準化格式提升AI系統的解讀能力。

豐富功能

項目管理

• 項目創建與配置。
• 層次化結構（階段、任務和子任務）。
• 自動進度計算。
• 響應式HTML導出。
• 更新日期跟蹤。

階段組織

• 階段添加。
• 階段重新排序。
• 階段重命名。
• 階段刪除。
• 按階段計算進度。

任務管理

• 主任務添加。
• 子任務創建。
• 完成標記。
• 描述更新。
• 任務刪除。

HTML報告

• 現代且響應式設計。
• 清晰的層次結構可視化。
• 進度指示器。
• 更新歷史記錄。
• 使用BEM CSS的專業樣式。

📦 安裝指南

使用以下命令全局安裝zPlanner：

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文件。