PPlanner - Project Planning Generator

Generate comprehensive project documentation from simple markdown descriptions with optional AI enhancement.

🚀 Features

• Template-based generation - Create standardized project docs without AI
• AI-enhanced mode - Use OpenAI, Anthropic, or Google Gemini for smarter documentation
• Multi-platform support - Web, iOS, Android, Desktop, API, CLI projects
• Interactive questionnaires - Fill in missing project details
• Comprehensive output - README, design docs, tech stack, features, and more

📦 Installation

npm install -g pplanner

🔧 Setup

1. Create API Keys (Optional - for AI mode)

Create a .env file in your project directory:

# You only need one of these keys
OPENAI_API_KEY=your_openai_key_here
ANTHROPIC_API_KEY=your_anthropic_key_here
GOOGLE_API_KEY=your_google_key_here

2. Get API Keys

• OpenAI: https://platform.openai.com/api-keys
• Anthropic: https://console.anthropic.com/
• Google: https://ai.google.dev/

📝 Usage

Basic Usage

# Start with questionnaire only (no file needed)
pplanner

# Use AI-enhanced mode
pplanner --anthropic

# Load project info from file, then questionnaire
pplanner my-project.md

# Skip questionnaire, use template mode
pplanner my-project.md --noit

LLM Provider Selection

# Use specific provider (no file needed)
pplanner --openai
pplanner --anthropic
pplanner --google

# Use with file
pplanner my-project.md --openai

# Force template mode
pplanner --nollm

Command Line Options

pplanner [file] [options]

Arguments:
  [file]       Optional markdown file with project description

Options:
  --nollm      Use template-based generation (default)
  --llm        Use AI-enhanced generation
  --openai     Use OpenAI (GPT-4)
  --anthropic  Use Anthropic (Claude)
  --google     Use Google (Gemini)
  --noit       Skip interactive questionnaire
  --help       Show help

📄 Input Format

With File Input

Create a markdown file with your project description:

# My Awesome Project

A comprehensive task management application with real-time collaboration features.

## Features

- Task creation and management
- Real-time collaboration
- File attachments
- Push notifications

## Tech Stack

React, Node.js, PostgreSQL, Socket.io

## Platforms

Web, iOS, Android

With File References

During questionnaire, reference external files:

✨ What are the main features? @examples/features.md
💻 Enter WEB tech stack: React, @examples/techstack.txt
📖 Brief project description: @examples/description.md, Custom additions

Supported file formats:

• @examples/features.md - Extracts list items from markdown
• @examples/techstack.txt - Reads line-by-line from text
• @examples/data.json - Parses arrays or object values

📂 Generated Output

The tool creates a project_planning/ directory with:

• README.md - Project overview and setup instructions
• DESIGN.md - Architecture and technical design
• TECH_STACK.md - Technology choices and rationale
• FEATURES.md - Feature specifications with user stories
• CODING_STYLE.md - Code standards and conventions
• DEVELOPMENT.md - Development workflow and setup
• DEPLOYMENT.md - Deployment procedures and infrastructure
• DEPLOYMENT_.md - Platform-specific deployment (if multi-platform)

🤖 AI Enhancement

When using --llm mode, the tool enhances your documentation with:

• Detailed user stories with personas and acceptance criteria
• Technical architecture with component breakdowns
• Technology rationale with pros/cons and alternatives
• Implementation guidelines and best practices

🎯 Supported Platforms

• Web - React, Vue, Angular, Next.js
• iOS - Swift, Objective-C, SwiftUI
• Android - Kotlin, Java, Jetpack Compose
• Desktop - Electron, Tauri, Qt
• API/Backend - REST, GraphQL, microservices
• CLI - Command line tools and scripts

🔄 Modes

Template Mode (--nollm)

• Fast generation using predefined templates
• No API keys required
• Consistent structure
• Good for rapid prototyping

AI Mode (--llm)

• Enhanced with AI-generated content
• Requires API keys
• More detailed and contextual
• Better for production projects

🛠️ Development

# Clone the repository
git clone https://github.com/thangk/pplanner.git
cd pplanner

# Install dependencies
npm install

# Run locally
npm start project-description.md

# Run tests
npm test

📋 Examples

Start Fresh with AI

pplanner --anthropic

Use File + Questionnaire

pplanner examples/webapp.md

Quick Template Generation

pplanner examples/mobile-app.md --noit

File References in Questionnaire

pplanner
# Then during questionnaire:
# Features: @examples/features.md, Custom feature
# Tech stack: React, @examples/backend-stack.txt

🐛 Troubleshooting

No API Keys Error

❌ Environment Configuration Error
📝 Please create a .env file with at least one API key

Solution: Create .env file with your API keys (see Setup section)

File Not Found

❌ Failed to read file 'project.md'

Solution: Ensure the markdown file exists and path is correct

Permission Denied

❌ Permission denied

Solution: Run with appropriate permissions or check file ownership

📄 License

MIT License - see LICENSE file for details.

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request

📧 Support

• 🐛 Issues: GitHub Issues
• 📖 Documentation: Wiki
• 💬 Discussions: GitHub Discussions

Made with ❤️ by Kap Thang