create-byan-agent 2.0.1 → 2.1.1

package/README.md

@@ -1,298 +1,361 @@
-# BYAN - Intelligent AI Agent Creator
+# BYAN v2.1.0 - Build Your AI Network
 
-**Create custom AI agents in 15 minutes** | GitHub Copilot CLI, VSCode, Claude Code
+[![npm version](https://img.shields.io/npm/v/create-byan-agent.svg)](https://www.npmjs.com/package/create-byan-agent)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://img.shields.io/badge/tests-1308%2F1308-brightgreen.svg)](https://github.com/yannsix/byan-v2)
 
-## Quick Start
+**Intelligent AI Agent Creator** | Powered by Merise Agile + TDD + 64 Mantras
 
-```bash
-npx create-byan-agent
-```
-
-That's it! The installer launches automatically.
+Create custom AI agents through intelligent structured interviews with advanced BMAD (Business Modeling & Agent Development) features.
 
-## What is BYAN?
-
-BYAN guides you through an intelligent interview to create personalized AI agents:
-
-1. ✅ Answer 12-15 simple questions (15-30 min)
-2. ✅ BYAN analyzes your needs
-3. ✅ Custom agent generated automatically
-4. ✅ Ready to use immediately
+---
 
-## Installation
+## 🚀 Quick Start
 
-### Option 1: NPX (Recommended)
+### Install & Run
 
 ```bash
+# Using npx (recommended - no installation needed)
 npx create-byan-agent
-```
 
-### Option 2: Global Install
-
-```bash
+# Or install globally
 npm install -g create-byan-agent
+
+# Then run
 create-byan-agent
 ```
 
-## Create Your First Agent
+### Programmatic Usage
 
-### 1. Launch BYAN
+```javascript
+const ByanV2 = require('create-byan-agent');
 
-**GitHub Copilot CLI:**
-```bash
-gh copilot
-@byan
-```
+const byan = new ByanV2({
+  maxQuestions: 12,
+  outputDir: './_bmad-output'
+});
 
-**Command Line:**
-```bash
-npx create-byan-agent
+await byan.startSession();
+
+// Interactive interview (12 questions)
+while (!byan.isComplete()) {
+  const question = byan.getNextQuestion();
+  const answer = await getUserInput(question.text);
+  await byan.submitResponse(answer);
+}
+
+// Generate agent profile
+const profile = await byan.generateProfile();
+console.log('Agent created:', profile.filePath);
 ```
 
-### 2. Choose Mode
+---
 
-**🎤 Full Interview (15-30 min)** - Recommended for first agent
-- 12-15 questions
-- In-depth analysis
-- Ultra-personalized agent
+## ✨ What's New in v2.1.0
 
-**⚡ Quick Create (5 min)** - For experienced users
-- 3-5 essential questions
-- Functional agent quickly
+### 4 New BMAD Modules
 
-### 3. Answer Questions
+**📚 Glossary Builder** - Auto-builds domain vocabularies
+- Auto-triggers for complex domains (ecommerce, finance, healthcare)
+- Validates definition clarity (min 70%)
+- Suggests related concepts
 
-BYAN asks questions in 4 categories:
+**🔍 Five Whys Analyzer** - Root cause analysis
+- Detects pain points automatically
+- 5 sequential WHY questions
+- Categorizes causes (technical/process/people/resource)
 
-1. **Context**: Your project, goals
-2. **Business**: Domain, constraints
-3. **Agent**: Desired skills, tasks
-4. **Validation**: Confirmation, adjustments
+**👂 Active Listener** - Intelligent response processing
+- Auto-reformulation every 3rd response
+- Validates confirmations
+- Session summaries with insights
 
-### 4. Automatic Generation
+**✅ Mantras Validator** - Quality validation
+- 64 BMAD/IA mantras
+- Compliance scoring (target: 80%+)
+- Category-based validation
 
-```
-✅ Complete analysis
-✅ Agent created: my-dev-agent.md
-✅ Validated and ready
-```
+**417 new tests** | **100% passing** | **95%+ coverage** | **< 10% overhead**
 
-Agent saved to:
-- GitHub Copilot: `.github/copilot/agents/`
-- Other platforms: `.codex/prompts/`
+---
 
-## Usage Examples
+## 🎯 Features
 
-### Code Review Agent
+### Core Capabilities
 
-```bash
-npx create-byan-agent
+- **Intelligent 4-Phase Interview**: Context → Business → Agent Needs → Validation
+- **Automatic Profile Generation**: Creates `.md` agent files with YAML frontmatter
+- **Built-in Validation**: Validates against GitHub Copilot CLI requirements
+- **Template System**: Flexible templates with placeholder resolution
+- **Quality Enforcement**: Zero emoji policy, clean code principles
+- **State Machine Workflow**: INTERVIEW → ANALYSIS → GENERATION → COMPLETED
 
-# BYAN asks:
-# Purpose? → "Review JavaScript code"
-# Tasks? → "Detect bugs, suggest optimizations"
-# Constraints? → "Follow our style guide"
+### Advanced BMAD Features (v2.1.0)
 
-# Result: code-reviewer.md created in 2 seconds
-```
+- **Domain Glossaries**: Auto-build glossaries with clarity validation
+- **Root Cause Analysis**: 5 Whys technique for pain point analysis
+- **Active Listening**: Intelligent reformulation and validation
+- **Mantra Validation**: 64 mantras compliance checking
 
-### Documentation Agent
+### 100% Backwards Compatible
 
-```bash
-npx create-byan-agent
+All v2.0.0 code works unchanged in v2.1.0. BMAD features are opt-in.
 
-# Purpose? → "Generate API documentation"
-# Tech? → "Node.js, Express, MongoDB"
-# Format? → "Markdown with examples"
+---
 
-# Result: doc-generator.md ready
-```
+## 📖 Usage Examples
 
-## Use Your Agent
+### Example 1: Basic Agent Creation
 
-### With GitHub Copilot CLI
+```javascript
+const ByanV2 = require('create-byan-agent');
 
-```bash
-gh copilot
-@my-dev-agent
-# Your agent responds!
+async function createAgent() {
+  const byan = new ByanV2();
+  await byan.startSession();
+  
+  // Answer 12 interview questions
+  await byan.submitResponse('code-review-assistant');
+  await byan.submitResponse('Reviews code for bugs and best practices');
+  // ... 10 more responses
+  
+  const profile = await byan.generateProfile();
+  console.log('✅ Agent created');
+}
 ```
 
-### With VSCode
-
-1. Command Palette (Ctrl+Shift+P)
-2. "GitHub Copilot: Chat"
-3. Type `@my-dev-agent`
+### Example 2: With BMAD Features
 
-### With Claude Code
+```javascript
+const ByanV2 = require('create-byan-agent');
 
-```bash
-claude chat --agent my-dev-agent
+async function createWithBMAD() {
+  const byan = new ByanV2({
+    bmad_features: {
+      glossary_builder: { enabled: true },
+      five_whys: { enabled: true },
+      active_listener: { enabled: true },
+      mantras_validator: { enabled: true }
+    }
+  });
+  
+  await byan.startSession();
+  
+  // Glossary auto-triggers for complex domains
+  const glossary = byan.startGlossary('ecommerce');
+  byan.addConcept('Order', 'Customer purchase request...');
+  
+  // Pain point detection
+  const detection = byan.detectPainPoints('Slow checkout');
+  if (detection.needsWhys) {
+    const question = byan.askWhy();
+    // ... 5 Whys analysis
+  }
+  
+  // Generate and validate
+  const profile = await byan.generateProfile();
+  const validation = byan.validateAgent(profile.content);
+  
+  console.log(`Score: ${validation.score * 100}%`);
+}
 ```
 
-## Key Concepts (v2.0)
+### Example 3: Validate Existing Agent
 
-### 1. Intelligent Interview (4 phases)
+```javascript
+const ByanV2 = require('create-byan-agent');
+const fs = require('fs');
 
-```
-CONTEXT → BUSINESS → AGENT → VALIDATION
+const byan = new ByanV2({
+  bmad_features: {
+    mantras_validator: { enabled: true }
+  }
+});
+
+const agentContent = fs.readFileSync('my-agent.md', 'utf-8');
+const validation = byan.validateAgent(agentContent);
+
+console.log(`Compliance: ${validation.score * 100}%`);
+console.log(`Compliant: ${validation.compliant.length}/64`);
+console.log(`Non-compliant: ${validation.nonCompliant.length}/64`);
 ```
 
-Minimum 3 questions per phase = 12 total
+---
+
+## 🔧 Configuration
 
-### 2. State Machine
+### Basic Configuration
 
+```javascript
+const byan = new ByanV2({
+  maxQuestions: 12,
+  outputDir: './_bmad-output/bmb-creations',
+  sessionId: 'my-session'
+});
 ```
-INTERVIEW → ANALYSIS → GENERATION → COMPLETED
+
+### BMAD Configuration
+
+```javascript
+const byan = new ByanV2({
+  bmad_features: {
+    glossary_builder: {
+      enabled: true,
+      auto_trigger_domains: ['ecommerce', 'finance', 'healthcare'],
+      min_concepts: 5,
+      clarity_threshold: 0.7
+    },
+    five_whys: {
+      enabled: true,
+      max_depth: 5,
+      auto_trigger: true
+    },
+    active_listener: {
+      enabled: true,
+      reformulation_frequency: 3
+    },
+    mantras_validator: {
+      enabled: true,
+      min_compliance_score: 0.8
+    }
+  }
+});
 ```
 
-### 3. Template System
+---
 
-Agents generated from professional templates with YAML frontmatter + XML structure.
+## 📊 Quality Metrics
 
-### 4. Automatic Validation
+- **Tests**: 1,308/1,308 passing (100%)
+  - Core v2.0: 891 tests
+  - BMAD v2.1: 417 tests
+- **Coverage**: 95%+
+- **Performance**: < 10% overhead vs v2.0.0
+- **Principles**: KISS, DRY, SOLID, TDD
+- **Standards**: Zero emojis (Mantra IA-23)
 
-- ✅ Correct YAML format
-- ✅ Valid XML structure
-- ✅ No emojis in code (Mantra IA-23)
-- ✅ Valid agent name
-- ✅ Clear description
+---
 
-### 5. Methodology: 64 Mantras
+## 📚 API Reference
 
-Quality principles applied:
-- **#37 Ockham's Razor**: Simplicity first
-- **IA-1 Trust But Verify**: Verify user needs
-- **IA-23 No Emoji Pollution**: Clean code
-- **IA-24 Clean Code**: Self-documenting
+### Main Class: ByanV2
 
-## Advanced Configuration
+#### Core Methods
 
-### Customize Output
+- `constructor(config)` - Initialize BYAN
+- `startSession()` - Start interview session
+- `getNextQuestion()` - Get next interview question
+- `submitResponse(answer)` - Submit answer
+- `generateProfile()` - Generate agent profile
+- `isComplete()` - Check if interview complete
 
-```javascript
-const ByanV2 = require('create-byan-agent');
+#### Glossary Builder (BMAD)
 
-const byan = new ByanV2({
-  outputFolder: './my-agents',
-  language: 'en',
-  template: 'custom'
-});
-```
+- `startGlossary(domain, options)` - Initialize glossary
+- `addConcept(term, definition)` - Add concept
+- `getConcepts()` - Get all concepts
+- `getGlossary()` - Get full glossary
 
-### Programmatic Usage
+#### Five Whys Analyzer (BMAD)
 
-```javascript
-const ByanV2 = require('create-byan-agent');
+- `detectPainPoints(response)` - Detect pain points
+- `askWhy()` - Get WHY question
+- `processWhyAnswer(answer)` - Process answer
+- `getRootCause()` - Get root cause analysis
 
-async function createAgent() {
-  const byan = new ByanV2();
-  await byan.startSession();
-  
-  const responses = [
-    'Backend development agent',
-    'REST API in Node.js',
-    'Tests, docs, deployment',
-    // ... 12 responses total
-  ];
-  
-  for (const response of responses) {
-    await byan.getNextQuestion();
-    await byan.submitResponse(response);
-  }
-  
-  const profile = await byan.generateProfile();
-  console.log('Agent created:', profile);
-}
-```
+#### Active Listener (BMAD)
 
-## Useful Commands
+- `listen(input, context)` - Process input with listening
+- `reformulate(input, style)` - Reformulate input
+- `validateResponse(input)` - Validate confirmation
+- `summarizeSession()` - Generate session summary
 
-```bash
-# List agents
-ls .github/copilot/agents/
+#### Mantras Validator (BMAD)
 
-# Edit agent
-code .github/copilot/agents/my-agent.md
+- `validateAgent(definition)` - Validate against mantras
+- `generateComplianceReport()` - Generate report
+- `validateMantra(mantraId, content)` - Validate specific mantra
+- `getMantras(category)` - Get mantras by category
+
+---
 
-# Validate agent
-npx create-byan-agent --validate my-agent.md
+## 🔄 Migration from v2.0.0
 
-# Version
-npx create-byan-agent --version
+**Good news**: Zero breaking changes! Your v2.0.0 code works unchanged.
+
+```javascript
+// v2.0.0 code - still works in v2.1.0
+const ByanV2 = require('create-byan-agent');
+const byan = new ByanV2();
+await byan.startSession();
+// ... your existing workflow
 ```
 
-## Help & Support
+To use new BMAD features, simply enable them in config. See [MIGRATION.md](https://github.com/yannsix/byan-v2/blob/main/MIGRATION-v2.0-to-v2.1.md) for details.
 
-### Get Help
+---
 
-```
-/bmad-help
-```
+## 📖 Documentation
 
-### Documentation
+- [Full Documentation](https://github.com/yannsix/byan-v2/blob/main/README-BYAN-V2.md)
+- [CHANGELOG v2.1.0](https://github.com/yannsix/byan-v2/blob/main/CHANGELOG-v2.1.0.md)
+- [Migration Guide](https://github.com/yannsix/byan-v2/blob/main/MIGRATION-v2.0-to-v2.1.md)
+- [Manual Testing Guide](https://github.com/yannsix/byan-v2/blob/main/BYAN-V2.1.0-MANUAL-TEST-PLAN.md)
+- [BMAD Quick Reference](https://github.com/yannsix/byan-v2/blob/main/BMAD-QUICK-REFERENCE.md)
 
-- [Full Guide](https://github.com/Yan-Acadenice/BYAN/blob/main/GUIDE-UTILISATION.md)
-- [API Reference](https://github.com/Yan-Acadenice/BYAN/blob/main/API-BYAN-V2.md)
-- [Examples](https://github.com/Yan-Acadenice/BYAN/tree/main/examples)
+---
 
-### Common Issues
+## 🤝 Contributing
 
-**Agent doesn't appear in Copilot**
-```bash
-cat .github/copilot/agents/my-agent.md
-gh copilot quit && gh copilot
-```
+Contributions welcome! Please read our contributing guidelines and submit pull requests to our [GitHub repository](https://github.com/yannsix/byan-v2).
 
-**"Node version too old"**
-```bash
-node --version  # Must be >= 18
-nvm install 18 && nvm use 18
-```
+---
 
-**Tests fail**
-```bash
-rm -rf node_modules package-lock.json
-npm install && npm test
-```
+## 📄 License
 
-## Stats (v2.0)
+MIT © Yan
 
-- ✅ **881/881 tests passing (100%)**
-- ✅ **14 modules**
-- ✅ **77 Story Points delivered**
-- ✅ **Agent in < 2 seconds** after interview
-- ✅ **64 mantras** applied automatically
+---
 
-## Use Cases
+## 🆘 Support
 
-**Developers**: Code review, test generation, refactoring, security analysis
+- **Issues**: [GitHub Issues](https://github.com/yannsix/byan-v2/issues)
+- **Repository**: [github.com/yannsix/byan-v2](https://github.com/yannsix/byan-v2)
 
-**Writers**: Documentation, proofreading, translation, content creation
+---
 
-**Project Managers**: Ticket analysis, reports, planning, prioritization
+## 🎯 Use Cases
 
-**Designers**: UI components, accessibility, CSS optimization, design systems
+### For Solo Developers
+Create specialized agents for your workflow without complex setup.
 
-## License
+### For Teams
+Build consistent agent profiles following team standards and mantras.
 
-MIT License
+### For Agencies
+Rapid agent prototyping with built-in quality validation.
 
-## Contributors
+### For Open Source
+Generate well-documented agent profiles for public repositories.
 
-**Core Team:**
-- **BYAN**: Intelligent agent creator
-- **RACHID**: NPM/NPX deployment specialist
-- **MARC**: GitHub Copilot CLI integration expert
-- **PATNOTE**: Update manager
-- **CARMACK**: Token optimizer
+---
 
-## Links
+## 🌟 Highlights
 
-- 📦 [NPM](https://www.npmjs.com/package/create-byan-agent)
-- 🐙 [GitHub](https://github.com/Yan-Acadenice/BYAN)
-- 📚 [Full Docs](https://github.com/Yan-Acadenice/BYAN/blob/main/install/README.md)
+- ✅ **Zero Setup**: Works immediately with npx
+- ✅ **Intelligent**: Smart interview adapts to your answers
+- ✅ **Quality**: Built-in validation against 64 mantras
+- ✅ **Fast**: Create agents in 10-15 minutes
+- ✅ **Flexible**: Use as CLI or programmatically
+- ✅ **Tested**: 1,308 tests, 100% passing
+- ✅ **Compatible**: Works with v2.0.0 code unchanged
 
 ---
 
-**BYAN v2.0** - Create professional AI agents in 15 minutes 🚀
+**Ready to create your first AI agent?**
+
+```bash
+npx create-byan-agent
+```
+
+🚀 Let's build something amazing!

package/install/.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  env: {
+    node: true,
+    es2021: true,
+    jest: true
+  },
+  extends: 'eslint:recommended',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module'
+  },
+  rules: {
+    'no-console': 'off', // CLI tool, console is OK
+    'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    'semi': ['error', 'always'],
+    'quotes': ['error', 'single'],
+    'indent': ['error', 2],
+    'comma-dangle': ['error', 'never']
+  }
+};

package/install/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "printWidth": 100
+}