aidp 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26282ecc76062d41d599eb9bc8190303bcef16257fb98fa25250eecaf894270a
-  data.tar.gz: ee50c920a5aa61d2883f906c7bea5d09c6835725c27c359bd2bce7d698f594e2
+  metadata.gz: 381bf0e833041913a075cab54a3e5df2be98d6954afd3eee4b821b05e19cf65e
+  data.tar.gz: dc7290731fd9eec058a31596d0ecc3e6d4b655ac67160f418bd2747c5820ef64
 SHA512:
-  metadata.gz: 9fa312b72678f5bba517ee9add8c9fcd1bc06237f65781ddf429bb687b7f3a85fb3e031ebe992cb768d53885a09648d74c6f9d57282a6f988eeada7994ff534f
-  data.tar.gz: e15204813d179e130dea804b89dc0a5225e1410af19fc5420ed2e82a3992d19b7a6e9e2054dce0269dce957f1ebee42e6c881f301e8554643f0eff1167a6fd61
+  metadata.gz: 04e4b6dc94bc641f02a8a0e45debb464943f0f03d9518ee23c773513009d6cdbd321202919a7d4f0b3fddd1120f0e43d34ee29d0d7f26636d203d4bdd6184fda
+  data.tar.gz: 723a75d5c1bd1ec0b8d9902a897cfead64a070b023e3998cab7415564aaf360f1936b317b91683849a049653144e55450348488a5039722c230c00a45012e153

data/README.md

@@ -1,6 +1,6 @@
 # AI Dev Pipeline (aidp) - Ruby Gem
 
-A portable CLI that automates a complete AI development workflow from idea to implementation using your existing IDE assistants.
+A portable CLI that automates a complete AI development workflow from idea to implementation using your existing IDE assistants. Now with **Enhanced TUI** - a rich terminal interface that runs complete workflows with intelligent provider management and error recovery.
 
 ## Quick Start
 
@@ -11,142 +11,152 @@ gem install aidp
 # Navigate to your project
 cd /your/project
 
-# Start the workflow
-aidp execute next
+# Start the interactive TUI (default)
+aidp
 ```
 
-## User Workflow
+## Enhanced TUI
 
-The gem automates a complete development pipeline with **human-in-the-loop gates** at key decision points. Here's the simplest workflow:
+AIDP features a rich terminal interface that transforms it from a step-by-step tool into an intelligent development assistant. The enhanced TUI provides beautiful, interactive terminal components while running complete workflows automatically.
 
-### 1. Start Your Project
+### Features
 
-```bash
-cd /your/project
-aidp status                   # Check current progress
-aidp execute next             # Run the next pending step
-```
-
-### 2. Handle Gate Steps
-
-When you reach a **gate step** (PRD, Architecture, Tasks, Implementation), the AI will:
+- **🎨 Rich Terminal Interface**: Beautiful CLI UI components with progress bars, spinners, and frames
+- **📋 Interactive Navigation**: Hierarchical menu system with breadcrumb navigation
+- **⌨️ Keyboard Shortcuts**: Full keyboard navigation and control
+- **📊 Real-time Progress**: Live monitoring of progress and system status
+- **🔄 Workflow Control**: Pause, resume, cancel, and stop workflows with visual feedback
+- **💬 Smart Question Collection**: Interactive prompts with validation and error handling
 
-1. **Generate questions** in a file (e.g., `PRD_QUESTIONS.md`) if it needs more information
-2. **Create the main output** (e.g., `docs/PRD.md`)
-3. **Wait for your approval** before proceeding
-
-**Your actions at gates:**
+### Usage
 
 ```bash
-# Review the generated files
-cat PRD_QUESTIONS.md          # Check if AI needs more information
-cat docs/PRD.md              # Review the output
-
-# If PRD_QUESTIONS.md exists, answer the questions:
-# Edit the questions file directly with your answers
-nano PRD_QUESTIONS.md         # Add your answers below each question
+# Start the interactive TUI (default)
+aidp
 
-# Re-run the step to use your answers
-aidp execute prd              # AI will read your answers and complete the step
+# Show version information
+aidp --version
 
-# Once satisfied with the output, approve and continue
-aidp approve current          # Mark the step complete
-aidp execute next             # Continue to next step
+# Show help information
+aidp --help
 ```
 
-### 3. Continue the Pipeline
-
-For non-gate steps, the AI runs automatically:
+## AI Providers
 
-```bash
-aidp execute next             # Run next step automatically
-aidp status                   # Check progress
+AIDP intelligently manages multiple providers with automatic switching:
+
+- **Claude API** - Primary provider for complex analysis and code generation
+- **Gemini API** - Cost-effective fallback for general tasks
+- **Cursor CLI** - IDE-integrated provider for code-specific tasks
+
+The TUI automatically switches providers when:
+
+- Rate limits are hit
+- Providers fail or timeout
+- Cost limits are reached
+- Performance optimization is needed
+
+### Provider Configuration
+
+```yaml
+# aidp.yml
+providers:
+  claude:
+    type: "api"
+    api_key: "${AIDP_CLAUDE_API_KEY}"
+    max_tokens: 100000
+  gemini:
+    type: "api"
+    api_key: "${AIDP_GEMINI_API_KEY}"
+    max_tokens: 50000
+  cursor:
+    type: "package"
 ```
 
-### 4. Complete the Workflow
-
-The pipeline includes 15 steps total:
-
-- **Gates**: PRD, Architecture, Tasks, Implementation (require approval)
-- **Auto**: NFRs, ADRs, Domains, Contracts, Threat Model, Test Plan, Scaffolding, Static Analysis, Observability, Delivery, Docs Portal, Post-Release
-
-## Key Commands
+### Environment Variables
 
 ```bash
-aidp status                   # Show progress of all steps
-aidp execute next             # Run next pending step
-aidp approve current          # Approve current gate step
-aidp jobs                     # Monitor background jobs (real-time)
-aidp detect                   # See which AI provider will be used
-aidp execute <step>           # Run specific step (e.g., prd, arch, tasks)
-aidp approve <step>           # Approve specific step
-aidp reset                    # Reset all progress (start over)
+# Set API keys
+export AIDP_CLAUDE_API_KEY="your-claude-api-key"
+export AIDP_GEMINI_API_KEY="your-gemini-api-key"
 ```
 
-## AI Providers
+## Tree-sitter Static Analysis
 
-The gem automatically detects and uses the best available AI provider:
+AIDP includes powerful Tree-sitter-based static analysis capabilities for code.
 
-- **Cursor CLI** (`cursor-agent`) - Preferred
-- **Claude CLI** (`claude`/`claude-code`) - Fallback
-- **Gemini CLI** (`gemini`/`gemini-cli`) - Fallback
+### Tree-sitter Dependencies
 
-### Override Provider
+The Tree-sitter analysis requires the Tree-sitter system library and pre-compiled language parsers:
 
 ```bash
-AIDP_PROVIDER=anthropic aidp execute next
-AIDP_LLM_CMD=/usr/local/bin/claude aidp execute next
-```
+# Install Tree-sitter system library
+# macOS
+brew install tree-sitter
+
+# Ubuntu/Debian
+sudo apt-get install tree-sitter
 
-## Background Jobs
+# Or follow the ruby_tree_sitter README for other platforms
+# https://github.com/Faveod/ruby-tree-sitter#installation
 
-AIDP uses background jobs to handle all AI provider executions, providing better reliability and real-time monitoring capabilities.
+# Install Tree-sitter parsers
+./install_tree_sitter_parsers.sh
+```
 
-### Job Monitoring
+### Parser Installation Script
 
-Monitor running and completed jobs in real-time:
+The `install_tree_sitter_parsers.sh` script automatically downloads and installs pre-built Tree-sitter parsers:
 
 ```bash
-aidp jobs                     # Show job status with real-time updates
+# Make the script executable
+chmod +x install_tree_sitter_parsers.sh
+
+# Run the installation script
+./install_tree_sitter_parsers.sh
 ```
 
-The jobs view displays:
+The script will:
 
-- **Running jobs** with live progress updates
-- **Queued jobs** waiting to be processed
-- **Completed jobs** with execution results
-- **Failed jobs** with error details
+- Detect your OS and architecture (macOS ARM64, Linux x64, etc.)
+- Download the appropriate parser bundle from [Faveod/tree-sitter-parsers](https://github.com/Faveod/tree-sitter-parsers/releases/tag/v4.9)
+- Extract parsers to `.aidp/parsers/` directory
+- Set up the `TREE_SITTER_PARSERS` environment variable
 
-### Job Controls
+### Environment Setup
 
-From the jobs view, you can:
+After running the installation script, make the environment variable permanent:
 
-- **Retry failed jobs** by pressing `r` on a failed job
-- **View job details** by pressing `d` on any job
-- **Exit monitoring** by pressing `q`
+```bash
+# Add to your shell profile (e.g., ~/.zshrc, ~/.bashrc)
+echo 'export TREE_SITTER_PARSERS="$(pwd)/.aidp/parsers"' >> ~/.zshrc
 
-### Job Persistence
+# Reload your shell
+source ~/.zshrc
+```
 
-- Jobs persist across CLI restarts
-- Job history is preserved for analysis
-- Failed jobs can be retried at any time
-- All job metadata and logs are stored
+### Knowledge Base Structure
 
-### Database Setup
+The Tree-sitter analysis generates structured JSON files in `.aidp/kb/`:
 
-AIDP uses PostgreSQL for job management. Ensure PostgreSQL is installed and running:
+- **`symbols.json`** - Classes, modules, methods, and their metadata
+- **`imports.json`** - Require statements and dependencies
+- **`calls.json`** - Method calls and invocation patterns
+- **`metrics.json`** - Code complexity and size metrics
+- **`seams.json`** - Integration points and dependency injection opportunities
+- **`hotspots.json`** - Frequently changed code areas (based on git history)
+- **`tests.json`** - Test coverage analysis
+- **`cycles.json`** - Circular dependency detection
 
-```bash
-# macOS (using Homebrew)
-brew install postgresql
-brew services start postgresql
+### Legacy Code Analysis Features
 
-# Ubuntu/Debian
-sudo apt-get install postgresql postgresql-contrib
-sudo systemctl start postgresql
+The Tree-sitter analysis specifically supports:
 
-# The database will be created automatically on first use
-```
+- **Seam Detection**: Identifies I/O operations, global state access, and constructor dependencies
+- **Change Hotspots**: Uses git history to identify frequently modified code
+- **Dependency Analysis**: Maps import relationships and call graphs
+- **Test Coverage**: Identifies untested public APIs
+- **Refactoring Opportunities**: Suggests dependency injection points and seam locations
 
 ## File-Based Interaction
 
@@ -170,45 +180,13 @@ The questions file is only created when the AI needs additional information beyo
 
 ```bash
 # Enable debug output to see AI provider communication
-AIDP_DEBUG=1 aidp execute next
+AIDP_DEBUG=1 aidp
 
 # Log to a file for debugging
-AIDP_LOG_FILE=aidp.log aidp execute next
+AIDP_LOG_FILE=aidp.log aidp
 
 # Combine both for full debugging
-AIDP_DEBUG=1 AIDP_LOG_FILE=aidp.log aidp execute next
-```
-
-## Workflow Example
-
-Here's a typical session:
-
-```bash
-# 1. Start the workflow
-aidp execute next
-# → Creates docs/PRD.md and PRD_QUESTIONS.md
-
-# 2. Monitor job progress (optional)
-aidp jobs
-# → Shows real-time job status and progress
-
-# 3. Review the questions (if any)
-cat PRD_QUESTIONS.md
-# → If questions exist, edit the file with your answers, then re-run
-
-# 4. Review the PRD
-cat docs/PRD.md
-# → Edit if needed
-
-# 5. Approve and continue
-aidp approve current
-aidp execute next
-# → Creates docs/NFRs.md automatically
-
-# 6. Continue through gates
-aidp execute next
-# → Creates docs/Architecture.md and ARCH_QUESTIONS.md
-# → Repeat review/approve cycle
+AIDP_DEBUG=1 AIDP_LOG_FILE=aidp.log aidp
 ```
 
 ## Development
@@ -217,9 +195,19 @@ aidp execute next
 # Install dependencies
 bundle install
 
+# Install Tree-sitter parsers for development
+./install_tree_sitter_parsers.sh
+
+# Set up environment variables
+export TREE_SITTER_PARSERS="$(pwd)/.aidp/parsers"
+
 # Run tests
 bundle exec rspec
 
+# Run Tree-sitter analysis tests specifically
+bundle exec rspec spec/aidp/analysis/
+bundle exec rspec spec/integration/tree_sitter_analysis_workflow_spec.rb
+
 # Run linter
 bundle exec standardrb
 
@@ -230,35 +218,24 @@ bundle exec standardrb --fix
 bundle exec rake build
 ```
 
-## Contributing
+### Development Dependencies
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and conventional commit guidelines.
+The following system dependencies are required for development:
 
-## Pipeline Steps
+- **Tree-sitter** - System library for parsing (install via `brew install tree-sitter` or package manager)
+- **Ruby gems** - All required gems are specified in `aidp.gemspec` and installed via `bundle install`
 
-The gem automates a complete 15-step development pipeline:
+## Contributing
 
-### Gate Steps (Require Approval)
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and conventional commit guidelines.
 
-- **PRD** → Product Requirements Document (`docs/PRD.md`)
-- **Architecture** → System architecture and ADRs (`docs/Architecture.md`)
-- **Tasks** → Implementation tasks and backlog (`tasks/backlog.yaml`)
-- **Implementation** → Implementation strategy and guidance (`docs/ImplementationGuide.md`)
+## Documentation
 
-### Automatic Steps
+For detailed information:
 
-- **NFRs** → Non-Functional Requirements (`docs/NFRs.md`)
-- **ADRs** → Architecture Decision Records (`docs/adr/`)
-- **Domains** → Domain decomposition (`docs/DomainCharters/`)
-- **Contracts** → API/Event contracts (`contracts/`)
-- **Threat Model** → Security analysis (`docs/ThreatModel.md`)
-- **Test Plan** → Testing strategy (`docs/TestPlan.md`)
-- **Scaffolding** → Project structure guidance (`docs/ScaffoldingGuide.md`)
-- **Static Analysis** → Code quality tools (`docs/StaticAnalysis.md`)
-- **Observability** → Monitoring and SLOs (`docs/Observability.md`)
-- **Delivery** → Deployment strategy (`docs/DeliveryPlan.md`)
-- **Docs Portal** → Documentation portal (`docs/DocsPortalPlan.md`)
-- **Post-Release** → Post-release analysis (`docs/PostReleaseReport.md`)
+- **[TUI User Guide](docs/TUI_USER_GUIDE.md)** - Complete guide to using the enhanced TUI
+- **[Configuration Guide](docs/harness-configuration.md)** - Detailed configuration options and examples
+- **[Troubleshooting Guide](docs/harness-troubleshooting.md)** - Common issues and solutions
 
 ## Manual Workflow (Alternative)
 

data/bin/aidp

@@ -2,4 +2,4 @@
 # frozen_string_literal: true
 
 require "aidp"
-Aidp::CLI.start(ARGV)
+exit Aidp::CLI.run(ARGV)