{"_id":"@aardvarq/bmad-cli","name":"@aardvarq/bmad-cli","dist-tags":{"latest":"6.2.0"},"versions":{"6.2.0":{"name":"@aardvarq/bmad-cli","version":"6.2.0","description":"BMAD CLI - Terminal interface for AARDVARQ Task Refinement Pipeline","main":"dist/index.js","bin":{"bmad":"dist/index.js"},"scripts":{"build":"tsc","dev":"tsx src/index.ts","test":"vitest","test:coverage":"vitest --coverage","lint":"eslint src --ext .ts","format":"prettier --write \"src/**/*.ts\"","prepare":"npm run build","prepublishOnly":"npm run build && npm test"},"keywords":["aardvarq","bmad","cli","task-refinement","firebase","task-management","workflow","automation","firestore","command-line"],"repository":{"type":"git","url":"git+https://github.com/aardvarq/bmad-cli.git"},"bugs":{"url":"https://github.com/aardvarq/bmad-cli/issues"},"homepage":"https://github.com/aardvarq/bmad-cli#readme","author":{"name":"AARDVARQ Team"},"license":"MIT","dependencies":{"chalk":"^5.3.0","cli-table3":"^0.6.5","commander":"^12.1.0","conf":"^12.0.0","firebase-admin":"^12.5.0","inquirer":"^9.2.15","ora":"^8.1.1","yaml":"^2.4.0","zod":"^3.23.8"},"devDependencies":{"@types/inquirer":"^9.0.7","@types/node":"^20.17.6","@typescript-eslint/eslint-plugin":"^8.18.2","@typescript-eslint/parser":"^8.18.2","@vitest/coverage-v8":"^4.0.15","eslint":"^9.18.0","prettier":"^3.4.2","tsx":"^4.19.2","typescript":"^5.7.2","vitest":"^4.0.15"},"engines":{"node":">=20.0.0"},"gitHead":"8ec4889ebfbd485ef6c793e236cdec0d0e15d2ea","types":"./dist/index.d.ts","_id":"@aardvarq/bmad-cli@6.2.0","_nodeVersion":"24.11.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-uixB5NmTDe09NNtjPPXn79BnRbwyz49o50YP0Z3Mx3/pN+/S+2/g1Krt6orqO2SUCe6I7kbNpjabHCSozeQq7A==","shasum":"9fd7ba86980957c3b689d2cdb26db5af2e0eb6e7","tarball":"https://registry.npmjs.org/@aardvarq/bmad-cli/-/bmad-cli-6.2.0.tgz","fileCount":207,"unpackedSize":319022,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFcM1UT76BcNmYRigKfXdJ6RU7xII3Fu+5088kHBKjR0AiB7IvzihBCkyG+JXhG+UYOWjtRjjFplhRGn6HTvwz81Nw=="}]},"_npmUser":{"name":"aardvarq","email":"ryan@mauchconsultinggroup.com"},"directories":{},"maintainers":[{"name":"aardvarq","email":"ryan@mauchconsultinggroup.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/bmad-cli_6.2.0_1765299430459_0.5622989286184661"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-09T16:57:10.352Z","6.2.0":"2025-12-09T16:57:10.641Z","modified":"2025-12-09T16:57:10.927Z"},"maintainers":[{"name":"aardvarq","email":"ryan@mauchconsultinggroup.com"}],"description":"BMAD CLI - Terminal interface for AARDVARQ Task Refinement Pipeline","homepage":"https://github.com/aardvarq/bmad-cli#readme","keywords":["aardvarq","bmad","cli","task-refinement","firebase","task-management","workflow","automation","firestore","command-line"],"repository":{"type":"git","url":"git+https://github.com/aardvarq/bmad-cli.git"},"author":{"name":"AARDVARQ Team"},"bugs":{"url":"https://github.com/aardvarq/bmad-cli/issues"},"license":"MIT","readme":"# BMAD CLI\r\n\r\n> **Version:** 6.2.0  \r\n> **Terminal interface for AARDVARQ Task Refinement Pipeline**\r\n\r\nThe BMAD CLI provides a fast, terminal-based interface for interacting with AARDVARQ's Task Refinement Pipeline. Submit tasks, respond to gap questions, monitor pipeline status, and automate workflows without leaving your development environment.\r\n\r\n## Features\r\n\r\n- ⚡ **Fast Task Submission** - Submit tasks in seconds\r\n- 🤖 **Interactive Q&A** - Answer gap questions with intelligent suggestions\r\n- 📊 **Real-time Monitoring** - Watch pipeline status and gap identification in real-time\r\n- 📝 **Template System** - Use templates for common task types\r\n- 📈 **Analytics** - View gap patterns and pipeline throughput\r\n- 🔄 **Automation Ready** - Script-friendly with JSON/YAML support\r\n\r\n## Installation\r\n\r\n### Global Installation (Recommended)\r\n\r\n```bash\r\nnpm install -g @aardvarq/bmad-cli\r\n```\r\n\r\n### Local Development\r\n\r\n```bash\r\ngit clone <repo>\r\ncd bmad-cli\r\nnpm install\r\nnpm link\r\n```\r\n\r\n### Shell Completion\r\n\r\n#### Bash\r\n\r\n```bash\r\n# Add to ~/.bashrc or ~/.bash_profile\r\nsource <(bmad completion bash)\r\n# Or manually:\r\nsource /path/to/bmad-cli/completions/bmad.bash\r\n```\r\n\r\n#### Zsh\r\n\r\n```bash\r\n# Add to ~/.zshrc\r\nsource <(bmad completion zsh)\r\n# Or manually:\r\nsource /path/to/bmad-cli/completions/bmad.zsh\r\n```\r\n\r\n#### PowerShell\r\n\r\n```powershell\r\n# Add to $PROFILE\r\n. .\\bmad-cli\\completions\\bmad.ps1\r\n```\r\n\r\n## Quick Start\r\n\r\n### 1. Authenticate\r\n\r\n```bash\r\nbmad auth login\r\n# Enter path to your Firebase service account JSON file\r\n```\r\n\r\n### 2. Submit a Task\r\n\r\n```bash\r\n# Simple submission\r\nbmad submit \"Add user authentication feature\"\r\n\r\n# With template\r\nbmad submit \"Add payment processing\" --template integration --var service=Stripe\r\n\r\n# Interactive mode\r\nbmad submit --interactive\r\n\r\n# From file\r\nbmad submit --file task.yaml\r\n```\r\n\r\n### 3. Answer Gap Questions\r\n\r\n```bash\r\n# Interactive answering\r\nbmad answer --task <task-id>\r\n\r\n# From file\r\nbmad answer --file answers.yaml --task <task-id>\r\n\r\n# List pending questions\r\nbmad questions --task <task-id>\r\n```\r\n\r\n### 4. Monitor Pipeline\r\n\r\n```bash\r\n# View pipeline status\r\nbmad pipeline status\r\n\r\n# Watch gaps in real-time\r\nbmad gaps watch --task <task-id>\r\n\r\n# View task details\r\nbmad pipeline status --task <task-id>\r\n```\r\n\r\n## Command Reference\r\n\r\n### Authentication\r\n\r\n```bash\r\nbmad auth login          # Authenticate with Firebase\r\nbmad auth logout         # Clear stored credentials\r\nbmad auth status         # Check authentication status\r\n```\r\n\r\n### Task Submission\r\n\r\n```bash\r\nbmad submit [description]              # Submit a new task\r\n  --template <name>                     # Use a task template\r\n  --var <key=value...>                  # Template variables\r\n  --file <path>                         # Load from YAML/JSON file\r\n  --interactive                         # Interactive wizard\r\n  --from-commit                         # Extract from git commit\r\n  --priority <level>                    # Task priority\r\n  --dry-run                             # Validate without submitting\r\n```\r\n\r\n### Gap Q&A\r\n\r\n```bash\r\nbmad answer                             # Answer gap questions\r\n  --session <id>                        # Q&A session ID\r\n  --task <id>                           # Task ID (finds active session)\r\n  --file <path>                         # Load answers from file\r\n  --interactive                         # Interactive mode\r\n\r\nbmad questions                          # List pending questions\r\n  --task <id>                           # Task ID\r\n  --severity <level>                    # Filter by severity\r\n  --dimension <type>                    # Filter by dimension\r\n```\r\n\r\n### Pipeline Management\r\n\r\n```bash\r\nbmad pipeline status                    # View pipeline status\r\n  --task <id>                           # Specific task\r\n  --all                                 # Include completed\r\n  --json                                # JSON output\r\n\r\nbmad pipeline list                      # List tasks\r\n  --stage <stage>                       # Filter by stage\r\n  --priority <priority>                 # Filter by priority\r\n  --limit <number>                      # Limit results\r\n\r\nbmad pipeline upgrade                   # Upgrade task to next stage\r\n  --task <id>                           # Task ID\r\n  --force                               # Force upgrade\r\n\r\nbmad pipeline cancel                    # Cancel a task\r\n  --task <id>                           # Task ID\r\n  --reason <reason>                     # Cancellation reason\r\n```\r\n\r\n### Gap Tracking\r\n\r\n```bash\r\nbmad gaps watch                         # Watch gaps in real-time\r\n  --task <id>                           # Task ID\r\n\r\nbmad gaps list                          # List all gaps\r\n  --task <id>                           # Task ID\r\n  --severity <level>                    # Filter by severity\r\n  --unanswered                          # Show only unanswered\r\n  --json                                # JSON output\r\n\r\nbmad gaps show                           # Show gap details\r\n  --gap <id>                            # Gap ID\r\n```\r\n\r\n### Reviews\r\n\r\n```bash\r\nbmad review show                         # Show review details\r\n  --task <id>                           # Task ID\r\n  --agent <name>                        # Specific agent\r\n  --output <type>                       # Output type (summary/full/spec)\r\n  --json                                # JSON output\r\n\r\nbmad review conversation                 # Show agent conversation\r\n  --task <id>                           # Task ID\r\n  --full                                # Show full conversation\r\n```\r\n\r\n### Templates\r\n\r\n```bash\r\nbmad template list                      # List templates\r\n  --built-in                           # Built-in only\r\n  --custom                             # Custom only\r\n\r\nbmad template show <name>               # Show template details\r\n\r\nbmad template create <name>             # Create template\r\n  --from-task <id>                     # Create from task\r\n  --interactive                        # Interactive wizard\r\n\r\nbmad template delete <name>             # Delete template\r\n```\r\n\r\n### Analytics\r\n\r\n```bash\r\nbmad analytics gaps                     # Analyze gap patterns\r\n  --last <period>                      # Time period (7d, 30d, 90d)\r\n  --dimension <type>                   # Filter by dimension\r\n  --json                               # JSON output\r\n\r\nbmad analytics throughput               # View throughput metrics\r\n  --last <period>                      # Time period\r\n\r\nbmad analytics agents                   # View agent performance\r\n  --last <period>                      # Time period\r\n```\r\n\r\n### Configuration\r\n\r\n```bash\r\nbmad config get [key]                   # Get configuration value\r\nbmad config set <key> <value>          # Set configuration value\r\nbmad config list                        # List all configuration\r\nbmad config reset                       # Reset to defaults\r\n  --key <key>                          # Reset specific key\r\n```\r\n\r\n## Configuration\r\n\r\nConfiguration is stored in `~/.bmad/config.json`. Key settings:\r\n\r\n```json\r\n{\r\n  \"pipeline\": {\r\n    \"minimumCompleteness\": 85,\r\n    \"criticalGapsRequired\": true,\r\n    \"autoSubmitThreshold\": 95\r\n  },\r\n  \"output\": {\r\n    \"format\": \"table\",\r\n    \"colorEnabled\": true,\r\n    \"verbosity\": \"normal\"\r\n  },\r\n  \"suggestions\": {\r\n    \"enabled\": true,\r\n    \"similarityThreshold\": 0.7,\r\n    \"maxSuggestions\": 3\r\n  }\r\n}\r\n```\r\n\r\n## Templates\r\n\r\n### Built-in Templates\r\n\r\n- `feature-addition` - Standard template for adding new features\r\n- `bug-fix` - Template for bug fix tasks\r\n- `integration` - Template for third-party integrations\r\n- `refactor` - Template for code refactoring tasks\r\n\r\n### Using Templates\r\n\r\n```bash\r\n# Submit with template\r\nbmad submit \"Add OAuth login\" --template feature-addition --var feature=OAuth\r\n\r\n# Create custom template\r\nbmad template create my-template --interactive\r\n\r\n# Create from existing task\r\nbmad template create my-template --from-task <task-id>\r\n```\r\n\r\n## File Formats\r\n\r\n### Task Submission File\r\n\r\n```yaml\r\n# task.yaml\r\ndescription: Add multi-currency support to billing\r\npriority: high\r\n\r\npreAnswers:\r\n  target_users: \"Small business owners, solopreneurs\"\r\n  mvp_scope: \"USD, EUR, GBP only\"\r\n  api_integration: \"Use Stripe multi-currency APIs\"\r\n\r\nbusinessContext:\r\n  justification: \"Enable EU market expansion\"\r\n  roi: \"30% revenue increase projected\"\r\n\r\ntechnicalContext:\r\n  security: \"PCI DSS compliance required\"\r\n  performance: \"Currency conversion < 100ms\"\r\n```\r\n\r\n### Answer File\r\n\r\n```yaml\r\n# answers.yaml\r\nquestions:\r\n  q-gap-001:\r\n    answer: \"Target users are small business owners with 1-10 employees\"\r\n  q-gap-002:\r\n    answer: \"MVP will support USD, EUR, GBP. Additional currencies in Phase 2\"\r\n    format: text\r\n  q-gap-003:\r\n    answer:\r\n      - \"Handle rate fluctuations with daily updates\"\r\n      - \"Round to 2 decimal places\"\r\n      - \"Display conversion fees transparently\"\r\n    format: list\r\n```\r\n\r\n## Environment Variables\r\n\r\n| Variable | Description | Default |\r\n|----------|-------------|---------|\r\n| `GOOGLE_APPLICATION_CREDENTIALS` | Path to service account JSON | - |\r\n| `BMAD_PROJECT_ID` | Firebase project ID | - |\r\n| `BMAD_DEBUG` | Enable debug output | `false` |\r\n| `BMAD_CONFIG_PATH` | Custom config file path | `~/.bmad/config.json` |\r\n| `BMAD_TEMPLATE_PATH` | Custom template directory | `~/.bmad/templates` |\r\n| `BMAD_NO_COLOR` | Disable colored output | `false` |\r\n\r\n## Development\r\n\r\n### Building\r\n\r\n```bash\r\nnpm run build\r\n```\r\n\r\n### Testing\r\n\r\n```bash\r\nnpm test\r\nnpm run test:coverage\r\n```\r\n\r\n### Linting\r\n\r\n```bash\r\nnpm run lint\r\nnpm run format\r\n```\r\n\r\n## Troubleshooting\r\n\r\n### Authentication Issues\r\n\r\n```bash\r\n# Check authentication status\r\nbmad auth status\r\n\r\n# Re-authenticate\r\nbmad auth logout\r\nbmad auth login\r\n```\r\n\r\n### Connection Issues\r\n\r\n```bash\r\n# Enable debug mode\r\nexport BMAD_DEBUG=true\r\nbmad pipeline status\r\n\r\n# Check Firebase configuration\r\nbmad config get projectId\r\n```\r\n\r\n## License\r\n\r\nMIT\r\n\r\n## Documentation\r\n\r\n- **[API Reference](./docs/API_REFERENCE.md)** - Complete command reference\r\n- **[Common Workflows](./docs/COMMON_WORKFLOWS.md)** - Practical examples and workflows\r\n- **[Troubleshooting Guide](./docs/TROUBLESHOOTING.md)** - Common issues and solutions\r\n- **[Firebase Testing Guide](./docs/FIREBASE_TESTING_GUIDE.md)** - Firebase integration guide\r\n\r\n## Support\r\n\r\nFor issues and questions, please refer to the [Troubleshooting Guide](./docs/TROUBLESHOOTING.md) or contact the development team.\r\n\r\n","readmeFilename":"README.md","_rev":"1-db8f7b36a89c9ddaf239183ab4f2a019"}