Zplanner (Project Management)

🚀 zPlanner v1.4.0

zPlanner is a command-line tool designed to assist in project planning and management, with a particular focus on software development project management. It was born out of the need for a simple yet powerful command-line tool that allows project management directly in the terminal without a complex graphical interface.

🚀 Quick Start

Purpose

The goals of creating zPlanner are as follows:

1. Simplicity: Manage projects directly in the terminal.
2. Efficiency: Reduce time spent on administrative tasks.
3. Flexibility: Adapt to different types of projects and methodologies.
4. Visualization: Generate clear and responsive HTML reports.
5. Traceability: Maintain progress history and update records.
6. AI Context: Serve as a memory system for AI-assisted development, maintaining a structured project context.

AI-First Design

zPlanner is optimized for modern AI-assisted development:

• Context Preservation: Maintain a structured history for AI assistants to use.
• Hierarchical Structure: Facilitate AI systems to understand how the project is organized.
• Change Tracking: Enable AI assistants to understand the evolution of the project.
• Clear Documentation: Standardized formats enhance the interpretability of AI systems.

✨ Features

Project Management

• Project creation and configuration.
• Hierarchical structure (phases, tasks, and subtasks).
• Automatic progress calculation.
• Responsive HTML export.
• Update date tracking.

Phase Organization

• Add phases.
• Reorder phases.
• Rename phases.
• Delete phases.
• Calculate progress by phase.

Task Management

• Add main tasks.
• Create subtasks.
• Mark completion.
• Update descriptions.
• Delete tasks.

HTML Reports

• Modern and responsive design.
• Clear hierarchical structure visualization.
• Progress indicators.
• Update history.
• Professional styling using BEM CSS.

📦 Installation

npm install -g zplanner

💻 Usage Examples

Basic Usage

# Display help information
zplanner --help

# View version information
zplanner --version

Configuration File

The configuration file is located at ~/.config/zplanner/settings.json with the following content:

{
  "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"
}

📚 Documentation

Configuration

The settings.ts file allows the following configurations:

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",
};

📄 License

This project is licensed under the MIT License. For details, please refer to the LICENSE file.