UNPKG

archon-agent-kit-prp-automated

Version:

🚀 BREAKTHROUGH: Automated PRP Generation System - No more copying templates! Generates complete, customized PRPs automatically with 85.7% quality validation. Supports all project types: Web, Mobile, API, CLI, Microservices.

218 lines (160 loc) 6.13 kB
# 🚀 Quick Start Steps - Get Your PRPs in 2 Minutes! ## Overview This guide walks you through the **exact steps** to get 4 complete, customized PRPs automatically generated from your project description. **What you'll get:** - Planning PRP with extracted goals & constraints - API Contract with endpoints & data models - Implementation PRP with tech-specific details - Task breakdown with acceptance criteria --- ## 📋 **Step-by-Step Process** ### **Step 1: Install the Tool** ```bash npm install -g archon-agent-kit-prp-automated ``` **What happens:** The complete PRP automation system is installed globally on your machine. --- ### **Step 2: Create Your Project Directory** ```bash mkdir my-awesome-project cd my-awesome-project ``` **What happens:** You create a new directory for your project. --- ### **Step 3: Create INITIAL.md** Create a file called `INITIAL.md` in your project root with your project description: ```markdown # My Awesome Project ## Technology Stack - Backend: Python with FastAPI - Frontend: Next.js 15 with React - Database: PostgreSQL - Infrastructure: Docker ## Goals - Create a modern web application - Implement user authentication - Build responsive dashboard ## Success Criteria - Users can register and login - Dashboard loads in under 2 seconds - Mobile-responsive design ## Features - User management system - Real-time data updates - Admin panel - API endpoints ## Constraints - Must launch within 3 months - Should handle 1000+ users - Must be secure and compliant ``` **What happens:** This file tells the system what to build and what technologies to use. --- ### **Step 4: Initialize Your Project** ```bash archon-agent-kit-prp-automated init ``` **What happens:** - Technology stack detected automatically - Project structure created - **🎉 4 Complete PRPs Generated Automatically!** - Python environment set up - AI integration files copied **Expected output:** ``` Project initialization completed successfully! 4 PRPs generated automatically Technology patterns matched Quality validation completed ``` --- ### **Step 5: Check Your Generated PRPs** Look in the `PRPs/generated/` directory. You'll find: - `my-awesome-project-planning-prp.md` - Complete project planning - `my-awesome-project-api-contract.md` - API specification - `my-awesome-project-implementation-prp.md` - Technical implementation - `my-awesome-project-tasks.md` - Development task breakdown - `my-awesome-project-next-steps.md` - What to do next **What happens:** You now have professional-quality PRPs ready to use immediately! --- ### **Step 6: Choose Your AI Tool** #### **Option A: Claude** 1. Copy `.claude/commands/` to your project 2. Use `/prime-core` to initialize Claude 3. Use `/generate-next-steps` for guidance #### **Option B: Cursor** 1. Copy `.cursor/rules/` to your project 2. Use Cursor's AI chat with your generated context 3. Ask "Generate next steps for project development" **What happens:** Your AI tool now has full context about your project and generated PRPs. --- ### **Step 7: Start Developing!** Your PRPs contain everything you need: - **Goals and requirements** extracted from INITIAL.md - **Technology-specific patterns** and best practices - **Implementation details** tailored to your stack - **Task breakdown** with acceptance criteria - **Next steps** for immediate development **What happens:** You can start coding immediately with clear guidance and no guesswork! --- ## 🔍 **What Each Step Does** | Step | Action | Result | |------|--------|---------| | 1 | Install tool | Get PRP automation system | | 2 | Create directory | Set up project location | | 3 | Write INITIAL.md | Define project requirements | | 4 | Run init command | **🎉 Get 4 PRPs automatically!** | | 5 | Check PRPs | Verify generated content | | 6 | Setup AI tool | Get intelligent guidance | | 7 | Start coding | Build with confidence | --- ## 🚨 **Troubleshooting** ### **If INITIAL.md isn't detected:** - Make sure the file is named exactly `INITIAL.md` - Ensure it's in your project root directory - Check that the file has proper markdown formatting ### **If PRPs aren't generated:** - Verify Python 3.8+ is installed: `python3 --version` - Check the error messages in the terminal - Ensure you have write permissions in the directory ### **If AI integration fails:** - Copy the `.claude/` or `.cursor/` directories manually - Check that the directories are in the right location - Verify file permissions --- ## 🎯 **Success Indicators** **You're ready to code when:** - `PRPs/generated/` directory exists with 4+ .md files - Each PRP file has meaningful content (not empty templates) - Technology stack is correctly detected - Quality validation scores are above 0.3 - AI tool can access your project context --- ## ⚡ **Time Savings** **Before (Manual Process):** - Copy PRP templates: 5 minutes - Research best practices: 30 minutes - Fill in requirements: 45 minutes - Create implementation plan: 60 minutes - **Total: 2+ hours** **Now (Automated Process):** - Write INITIAL.md: 10 minutes - Run init command: 2 minutes - **Total: 12 minutes** **🎉 You save 1 hour 48 minutes per project!** --- ## 🔄 **Next Steps After Setup** 1. **Review generated PRPs** - Understand what was created 2. **Customize if needed** - Add project-specific details 3. **Share with team** - Everyone has the same context 4. **Start development** - Follow the implementation PRP 5. **Track progress** - Use the task breakdown PRP --- ## 💡 **Pro Tips** - **Be specific in INITIAL.md** - More detail = better PRPs - **Include constraints** - Helps with realistic planning - **List all features** - Ensures complete coverage - **Specify tech stack** - Gets technology-specific guidance - **Set success criteria** - Creates measurable goals --- **That's it!** Follow these 7 steps and you'll have professional-quality PRPs in under 15 minutes. No more guessing, no more manual work - just automated PRP generation that actually works! 🚀