mycontext-cli 1.0.17 → 1.0.20

package/README.md.backup

@@ -1,463 +0,0 @@
-# MyContext CLI
-
-**🧠 The AI That Actually Understands Your Project**
-
-AI-powered tool that generates production-ready React components through an advanced agent-driven workflow that deeply understands your project context.
-
-## 🚀 Quick Start
-
-```bash
-# Install CLI
-npm install -g mycontext-cli
-
-# Initialize project (supports current directory with ".")
-mycontext init . --description "Your project description"
-# OR
-mycontext init my-app --description "Your project description"
-cd my-app
-
-# Agent-Driven Workflow (New!)
-mycontext generate-context-files --description "Your project description"  # → A/B/C/D context files
-mycontext compile-prd                                                  # → Comprehensive PRD
-mycontext build-app --interactive                                      # → Complete app with agents
-```
-
-## 🤖 Agent-Driven Workflow (New!)
-
-MyContext uses 11 specialized AI agents working together in an orchestrated workflow:
-
-### 1. Context Generation (Agent: SpecAgent)
-
-```bash
-mycontext generate-context-files --description "Modern e-commerce platform"
-# Generates:
-# - A. Features (.mycontext/features.md)
-# - B. User Flows (.mycontext/user-flows.md)
-# - C. Edge Cases (.mycontext/edge-cases.md)
-# - D. Technical Specs (.mycontext/technical-specs.md)
-```
-
-### 2. PRD Compilation (Agent: PRDAgent)
-
-```bash
-mycontext compile-prd
-# Compiles A/B/C/D context files into:
-# - .mycontext/prd-compiled.md (comprehensive requirements)
-```
-
-### 3. Complete Application Build (Agent Orchestration)
-
-```bash
-mycontext build-app --interactive --max-retries 3
-# Orchestrates multiple agents:
-# - TypesAgent: Generates TypeScript types
-# - BrandAgent: Creates design system
-# - CodeGenAgent: Generates components
-# - QAAgent: Quality assurance
-# - DocsAgent: Documentation
-```
-
-## 🎯 Core Commands
-
-### Context & Planning
-
-```bash
-mycontext generate-context-files  # A/B/C/D context files (NEW)
-mycontext compile-prd            # Compile to comprehensive PRD (NEW)
-mycontext build-app              # Agent-orchestrated full build (NEW)
-mycontext generate types         # TypeScript type system
-mycontext generate brand-kit     # Complete brand system
-```
-
-### Component Generation
-
-```bash
-mycontext generate-components all --local --with-tests  # All components
-mycontext generate-components <group> --local          # Specific group
-mycontext core generate                               # Design anchor component
-```
-
-### Interactive & Management
-
-```bash
-mycontext enhance <component> --prompt "improvements"  # AI enhancement
-mycontext refine <component> --prompt "changes"        # AI refinement
-mycontext preview components                           # Live preview
-mycontext status --detailed                           # Project analysis
-```
-
-## Advanced Commands
-
-```bash
-# AI predictions and insights
-mycontext predict next              # Next development steps
-mycontext predict dependencies      # Package suggestions
-mycontext predict patterns         # Architecture patterns
-mycontext predict issues           # Potential problems
-
-# Interactive workflow
-mycontext build-app --interactive   # Human-in-the-loop generation
-mycontext build-app --max-retries 5 # Configure retry limits
-
-# Model management
-mycontext model list               # Available AI models
-mycontext model test               # Test AI provider connections
-mycontext setup                    # Local AI setup
-```
-
-## 📦 What You Get (Updated Structure)
-
-### Context Files (A/B/C/D Workflow)
-
-- **`.mycontext/features.md`** — Core product features and capabilities
-- **`.mycontext/user-flows.md`** — User journey maps and interaction patterns
-- **`.mycontext/edge-cases.md`** — Error scenarios and edge conditions
-- **`.mycontext/technical-specs.md`** — Architecture and technical requirements
-- **`.mycontext/prd-compiled.md`** — Comprehensive compiled PRD
-
-### Generated Assets
-
-- **`.mycontext/types/`** — Complete TypeScript type system (5 files)
-  - `index.ts` — Main type exports and interfaces
-  - `database.ts` — Database schema and data models
-  - `enums.ts` — Enum constants and type guards
-  - `ui.ts` — UI component prop types
-  - `utils.ts` — Utility types and helpers
-- **`.mycontext/brand-kit/`** — Complete design system
-  - `brand-kit.json` — Design tokens and theme configuration
-  - `globals.css` — CSS custom properties and variables
-  - `colors.md` — Color palette documentation
-  - `typography.md` — Typography specifications and hierarchy
-- **`components/`** — Production-ready React components with shadcn/ui
-- **`lib/`** — Shared utilities and hooks
-- **`docs/`** — Auto-generated component documentation
-
-## 🤖 Agent Architecture
-
-MyContext features a sophisticated multi-agent system with 11 specialized AI agents:
-
-### Core Agents
-
-- **SpecAgent**: Generates A/B/C/D context files from project descriptions
-- **PRDAgent**: Compiles context files into comprehensive PRDs
-- **TypesAgent**: Creates TypeScript type systems from features and flows
-- **BrandAgent**: Generates complete design systems and brand kits
-- **CodeGenAgent**: Produces production-ready React components
-- **QAAgent**: Performs quality assurance and validation
-- **DocsAgent**: Creates comprehensive documentation
-
-### Support Agents
-
-- **ArchitectAgent**: Provides architectural analysis and recommendations
-- **SecurityAgent**: Performs security analysis and best practices
-- **InteractiveAgent**: Handles human-in-the-loop interactions
-- **ProjectSetupAgent**: Manages project initialization and structure
-- **WorkflowAgent**: Orchestrates complete build processes
-
-### Agent Orchestration
-
-```bash
-mycontext build-app --interactive
-# Automatically coordinates all agents in the optimal sequence
-# Provides progress updates and handles failures gracefully
-# Supports human intervention when needed
-```
-
-## 💰 Business Model & Pricing
-
-### **Free Tier (Always Free)**
-
-- ✅ Unlimited basic generation with Qwen3 Coder
-- ✅ Core CLI features and commands
-- ✅ Community support and documentation
-- ✅ Local AI setup with Ollama
-
-### **Pro Tier ($9/month)**
-
-- ✅ Advanced AI generation with premium providers
-- ✅ Priority support and faster response times
-- ✅ Enhanced features and beta access
-- ✅ Team collaboration tools
-
-### **Enterprise Tier ($29/month)**
-
-- ✅ Custom AI model training and fine-tuning
-- ✅ White-label solutions and branding
-- ✅ On-premise deployment options
-- ✅ Dedicated enterprise support and SLAs
-
-### **Bring Your Own Keys (BYOK)**
-
-- ✅ Use your existing API provider accounts
-- ✅ Pay only for your actual API usage
-- ✅ Full control over costs and performance
-- ✅ No rate limits or usage tracking
-
-## 🤖 AI Provider Options
-
-MyContext supports multiple AI providers with intelligent fallback:
-
-### **Bring Your Own Keys (BYOK)**
-
-| Provider               | Environment Variable       | Best For                         | Cost           |
-| ---------------------- | -------------------------- | -------------------------------- | -------------- |
-| **Qwen3 Coder**        | `MYCONTEXT_QWEN_API_KEY`   | Free code generation, OpenRouter | **FREE**       |
-| **GitHub Models**      | `MYCONTEXT_GITHUB_TOKEN`   | Fast, high-quality generation    | Your API costs |
-| **Claude (Anthropic)** | `MYCONTEXT_CLAUDE_API_KEY` | Complex reasoning, detailed PRDs | Your API costs |
-| **OpenAI**             | `MYCONTEXT_OPENAI_API_KEY` | Versatile generation, refinement | Your API costs |
-| **X.AI (Grok)**        | `MYCONTEXT_GROK_TOKEN`     | Creative tasks, quick iterations | Your API costs |
-
-### **MyContext Managed Service**
-
-- **Rate Limited**: 10 requests per hour for free tier
-- **Paid Credits**: Purchase credits for unlimited usage
-- **Multi-Provider**: Automatic fallback across providers
-- **Usage Tracking**: Quality improvement and analytics
-
-### **Provider Priority Chain**
-
-1. **Your API Keys** (highest performance, your costs)
-2. **MyContext Managed Service** (balanced, our costs)
-3. **Qwen3 Coder FREE** (fallback, completely free)
-4. **Basic Templates** (ultimate fallback)
-
-## Environment Setup
-
-### Option 1: Bring Your Own API Keys (Recommended)
-
-Set up your preferred AI provider for best performance and cost control:
-
-```bash
-# Qwen3 Coder (FREE via OpenRouter - Recommended!)
-echo 'MYCONTEXT_QWEN_API_KEY=sk-or-xxx' > .mycontext/.env
-
-# Or GitHub Models (Fast, high-quality)
-echo 'MYCONTEXT_GITHUB_TOKEN=ghp_xxx' > .mycontext/.env
-
-# Or Claude (Best for complex reasoning)
-echo 'MYCONTEXT_CLAUDE_API_KEY=sk-ant-xxx' > .mycontext/.env
-
-# Or OpenAI (Most versatile)
-echo 'MYCONTEXT_OPENAI_API_KEY=sk-xxx' > .mycontext/.env
-
-# Or X.AI (Creative tasks)
-echo 'MYCONTEXT_GROK_TOKEN=xai-xxx' > .mycontext/.env
-```
-
-### Option 2: Use MyContext Managed Service
-
-No setup required! Just start using MyContext:
-
-```bash
-mycontext generate context --description "My project"
-```
-
-**Note**: Without API keys, you'll use MyContext's hosted service with rate limits and usage tracking.
-
-### Option 3: Local AI Setup (Free & Unlimited)
-
-```bash
-# Get Qwen3 Coder API key (FREE)
-# Visit https://openrouter.ai/ and create an account
-# Get your API key and add it to .mycontext/.env
-
-# Set up MyContext local AI
-mycontext setup
-
-# Verify setup
-mycontext model status
-```
-
-## 🧠 **Automatic Context Loading**
-
-MyContext commands automatically load context from your project files when no description is provided:
-
-```bash
-# These commands automatically use context files
-mycontext generate types          # Uses PRD and existing context
-mycontext predict next           # Uses project context for predictions
-mycontext enhance Button.tsx     # Uses brand and types for enhancements
-mycontext refine LoginForm.tsx   # Uses project context for refinements
-```
-
-### Context File Priority
-
-When no description is provided, commands load context in this order:
-
-1. **PRD** (`.mycontext/01-prd.md`) - Product requirements and project overview
-2. **Types** (`.mycontext/02-types.ts`) - TypeScript type definitions
-3. **User Stories** (`.mycontext/02_user_stories.md`) - User requirements
-4. **Technical Specs** (`.mycontext/03_technical_specs.md`) - Technical details
-5. **Component List** (`.mycontext/04-component-list.json`) - Component architecture
-6. **Brand** (`.mycontext/03-branding.md` or `brand/globals.css`) - Design system
-
-### Context Loading Benefits
-
-- **No Repetition**: Don't re-enter project details for every command
-- **Consistency**: All commands use the same project context
-- **Efficiency**: Faster workflow with automatic context detection
-- **Accuracy**: Better results with full project understanding
-
-## 🎯 **Integration Guide**
-
-### Using Generated Types
-
-```bash
-# Move the types folder to your lib directory
-mv .mycontext/types ./lib/
-
-# Import types in your components
-import type { User, ApiResponse } from "@/lib/types";
-import { USER_ROLES } from "@/lib/types/enums";
-```
-
-### Using Generated Brand System
-
-```bash
-# Copy the CSS to your globals.css
-cp .mycontext/brand/globals.css ./src/app/globals.css
-
-# Use the design tokens
-<div className="bg-primary text-primary-foreground p-4 rounded-lg">
-  Hello World
-</div>
-```
-
-## Key Features
-
-### 🤖 **Agent-Driven Development**
-
-- **11 Specialized Agents**: Each agent handles specific development tasks
-- **Intelligent Orchestration**: Agents work together seamlessly
-- **Human-in-the-Loop**: Interactive prompts and confirmations
-- **Quality Gates**: Built-in validation and retry mechanisms
-
-### 🎯 **Context-Aware Generation**
-
-- **Deep Project Understanding**: Analyzes existing codebase patterns
-- **A/B/C/D Context Files**: Comprehensive project specification
-- **Automatic Context Loading**: Commands use project context intelligently
-- **Consistent Results**: Same context produces consistent outputs
-
-### 🏗️ **Production-Ready Code**
-
-- **TypeScript First**: Complete type system with 5 specialized files
-- **Modern React**: Next.js 15, shadcn/ui, server components
-- **Accessibility**: WCAG compliant components
-- **Testing**: Comprehensive test suites included
-- **Documentation**: Auto-generated component docs
-
-### 🎨 **Complete Design System**
-
-- **Brand Kit Generation**: Colors, typography, components
-- **CSS Custom Properties**: Theme-able design tokens
-- **Component Library**: Consistent, reusable components
-- **Responsive Design**: Mobile-first approach
-
-### 🔧 **Developer Experience**
-
-- **Interactive CLI**: Guided workflows with progress indicators
-- **Multiple AI Providers**: Choose your preferred AI service
-- **Fallback Support**: Always works, even without API keys
-- **Extensible Architecture**: Plugin system for custom agents
-
-## 🛠️ Development & Contributing
-
-### Prerequisites
-
-- **Node.js**: 18+ (20+ recommended)
-- **pnpm**: Package manager
-- **Git**: Version control
-
-### Local Development
-
-```bash
-# Clone the monorepo
-git clone https://github.com/farajabien/mycontext.git
-cd mycontext
-
-# Install dependencies
-pnpm install
-
-# Build all packages
-pnpm build
-
-# Run CLI in development mode
-cd packages/cli
-pnpm dev --help
-```
-
-### Project Structure
-
-```
-mycontext-monorepo/
-├── packages/
-│   ├── cli/                    # Main CLI package
-│   │   ├── src/
-│   │   │   ├── commands/      # CLI command implementations
-│   │   │   ├── agents/        # AI agent implementations
-│   │   │   ├── utils/         # Utility functions
-│   │   │   └── config/        # Configuration files
-│   │   └── docs/              # CLI documentation
-│   └── ui/                     # Shared UI components
-├── apps/
-│   └── web/                    # Web platform (Next.js)
-└── docs/                       # Monorepo documentation
-```
-
-### Testing
-
-```bash
-# Run all tests
-pnpm test
-
-# Run CLI tests specifically
-cd packages/cli && pnpm test
-
-# Run with coverage
-pnpm test:coverage
-```
-
-### Contributing Guidelines
-
-1. **Fork** the repository
-2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
-3. **Commit** your changes (`git commit -m 'Add amazing feature'`)
-4. **Push** to the branch (`git push origin feature/amazing-feature`)
-5. **Open** a Pull Request
-
-### Code Standards
-
-- **TypeScript**: Strict type checking enabled
-- **ESLint**: Code quality and consistency
-- **Prettier**: Automatic code formatting
-- **Conventional Commits**: Structured commit messages
-
-## 📞 Support & Community
-
-### Getting Help
-
-- **📧 Email**: hello@fbien.com
-- **🐛 Issues**: [GitHub Issues](https://github.com/farajabien/mycontext/issues)
-- **💬 Discussions**: [GitHub Discussions](https://github.com/farajabien/mycontext/discussions)
-- **📖 Documentation**: [docs.mycontext.fbien.com](https://docs.mycontext.fbien.com)
-
-### Community
-
-- **Share Components**: Contribute to the component library
-- **Report Bugs**: Help improve stability and reliability
-- **Feature Requests**: Suggest new capabilities and improvements
-- **Beta Testing**: Get early access to new features
-
-### Enterprise Support
-
-- **Custom Deployments**: On-premise and private cloud options
-- **White-label Solutions**: Custom branding and integration
-- **Dedicated Support**: Priority response and SLAs
-- **Training**: Team onboarding and best practices
-
----
-
-**🚀 Ready to transform your development workflow with AI-powered agents?**
-
-_Built with ❤️ by the MyContext team - Making AI work for developers, not against them._