create-byan-agent 2.0.1 → 2.1.0

package/install/QUICKSTART.md

@@ -0,0 +1,311 @@
+# ⚡ BYAN Quickstart - 5 Minutes Install
+
+**Version:** 1.1.1  
+**Target:** Experienced developers who just want commands
+
+> 💡 **Promise:** Copy-paste these commands, you'll have BYAN running in 5 minutes.
+
+---
+
+## 🎯 What You'll Get
+
+**6 specialized agents:**
+- 🏗️ **BYAN** / ⚡ **BYAN-Test** → Create agents
+- 🤖 **Marc** → Fix Copilot CLI issues
+- 📦 **Rachid** → Publish to npm
+- 🛡️ **Patnote** → Update without breaking
+- ⚡ **Carmack** → Optimize tokens (-40%)
+
+---
+
+## 🚀 GitHub Copilot CLI - Quickstart
+
+### Prerequisites
+```bash
+# Required: GitHub CLI + Copilot extension
+gh --version          # Should show v2.40.0+
+gh extension list     # Should show github/gh-copilot
+```
+
+**If missing:**
+```bash
+# Install GitHub CLI (choose your OS)
+# Windows: winget install --id GitHub.cli
+# Linux: See https://cli.github.com/
+
+# Install Copilot extension
+gh extension install github/gh-copilot
+
+# Auth (one-time)
+gh auth login
+```
+
+---
+
+### Install BYAN
+```bash
+cd ~
+npx create-byan-agent@1.1.1
+```
+
+**Prompts:**
+- Name? → Your name
+- Language? → `Francais` or `English`
+- Output? → Press Enter (default)
+
+**⏱️ Time:** 2-3 minutes
+
+---
+
+### Validate
+```bash
+# Check files created
+ls .github/agents/    # Should show 29 .md files
+
+# Launch Copilot
+gh copilot
+
+# In Copilot, type:
+/agent                # Should list byan, marc, rachid, etc.
+
+# Test invoke
+@byan                 # Should show BYAN menu
+```
+
+---
+
+## 🤖 Claude Code - Quickstart
+
+### Config File
+
+**Windows:**
+```powershell
+mkdir $env:APPDATA\Claude\
+notepad $env:APPDATA\Claude\claude_desktop_config.json
+```
+
+**Linux/macOS:**
+```bash
+mkdir -p ~/.config/Claude/
+nano ~/.config/Claude/claude_desktop_config.json
+```
+
+### JSON Config
+```json
+{
+  "mcpServers": {
+    "byan-agents": {
+      "command": "node",
+      "args": ["/absolute/path/to/_bmad/mcp-server.js"],
+      "env": {
+        "BMAD_ROOT": "/absolute/path/to/_bmad"
+      }
+    }
+  }
+}
+```
+
+**⚠️ Replace paths with your actual paths**
+
+---
+
+### MCP Server Script
+
+**Create `_bmad/mcp-server.js`:**
+```javascript
+#!/usr/bin/env node
+const fs = require('fs');
+const path = require('path');
+const BMAD_ROOT = process.env.BMAD_ROOT || process.cwd();
+
+function listByanAgents() {
+  const agents = [];
+  ['byan', 'byan-test', 'marc', 'rachid', 'patnote', 'carmack'].forEach(name => {
+    const p = path.join(BMAD_ROOT, 'bmb', 'agents', `${name}.md`);
+    if (fs.existsSync(p)) agents.push({ name, path: p, content: fs.readFileSync(p, 'utf-8') });
+  });
+  return agents;
+}
+
+console.log('BYAN MCP Server started');
+console.log(`Agents: ${listByanAgents().map(a => a.name).join(', ')}`);
+
+process.stdin.on('data', (data) => {
+  const req = JSON.parse(data.toString());
+  if (req.method === 'list_agents') {
+    process.stdout.write(JSON.stringify({ agents: listByanAgents() }));
+  }
+});
+```
+
+**Restart Claude Desktop** → Done!
+
+---
+
+## 🎯 Agent Invocation
+
+### In GitHub Copilot CLI
+```bash
+gh copilot --agent=byan         # Create agents (standard)
+gh copilot --agent=byan-test    # Create agents (optimized)
+gh copilot --agent=marc         # Fix Copilot CLI issues
+gh copilot --agent=rachid       # Publish to npm
+gh copilot --agent=patnote      # Update manager
+gh copilot --agent=carmack      # Token optimizer
+```
+
+### In Claude Code
+```
+@byan         # Create agents
+@marc         # Fix issues
+@rachid       # Publish npm
+```
+
+---
+
+## 🔴 Troubleshooting - 1 Minute Fixes
+
+### "gh: command not found"
+```bash
+# Install GitHub CLI
+# Windows: winget install --id GitHub.cli
+# Linux: curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list && sudo apt update && sudo apt install gh
+```
+
+---
+
+### "extension not installed: copilot"
+```bash
+gh extension install github/gh-copilot
+```
+
+---
+
+### "/agent doesn't list my agents"
+```bash
+# Check files exist
+ls .github/agents/bmad-agent-*.md    # Should show 29 files
+
+# Call Marc to fix
+gh copilot --agent=marc
+# Type: 1 (Validate)
+```
+
+---
+
+### "npx: command not found"
+```bash
+# Install Node.js
+# Windows: Download from https://nodejs.org/
+# Linux: curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - && sudo apt-get install -y nodejs
+```
+
+---
+
+### "Permission denied" on Linux
+```bash
+# Fix npm permissions
+mkdir ~/.npm-global
+npm config set prefix '~/.npm-global'
+echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
+source ~/.bashrc
+```
+
+---
+
+## 📋 Validation Checklist
+
+```bash
+# Run these commands, all should pass:
+gh --version                         # ✅ v2.40.0+
+gh extension list | grep copilot     # ✅ Shows copilot
+node --version                       # ✅ v18.0.0+
+ls .github/agents/*.md | wc -l       # ✅ Shows 29
+gh copilot                           # ✅ Launches
+# In Copilot: /agent                 # ✅ Lists agents
+# In Copilot: @byan                  # ✅ Shows menu
+```
+
+---
+
+## 🎯 Quick Use Cases
+
+### Create an agent
+```bash
+gh copilot --agent=byan
+# Type: 1 (Intelligent Interview)
+```
+
+### Publish to npm
+```bash
+gh copilot --agent=rachid
+# Type: 5 (Publish)
+```
+
+### Fix detection issue
+```bash
+gh copilot --agent=marc
+# Type: 1 (Validate)
+```
+
+### Optimize tokens
+```bash
+gh copilot --agent=carmack
+# Type: 1 (Optimize)
+```
+
+### Update safely
+```bash
+gh copilot --agent=patnote
+# Type: 1 (Update)
+```
+
+---
+
+## 📚 Full Documentation
+
+**Need more details?** See [GUIDE-INSTALLATION-BYAN-SIMPLE.md](GUIDE-INSTALLATION-BYAN-SIMPLE.md)
+- Beginner-friendly explanations
+- Windows + Linux detailed
+- 10 troubleshooting scenarios
+- 8 FAQ with solutions
+
+---
+
+## 🆘 Get Help
+
+**Stuck?** Call Marc:
+```bash
+gh copilot --agent=marc
+```
+
+Marc diagnoses and fixes Copilot CLI issues automatically.
+
+---
+
+## 📊 Agent Reference Table
+
+| Agent | Icon | Role | Command |
+|-------|------|------|---------|
+| BYAN | 🏗️ | Create agents (standard) | `--agent=byan` |
+| BYAN-Test | ⚡ | Create agents (optimized -46% tokens) | `--agent=byan-test` |
+| Marc | 🤖 | GitHub Copilot CLI expert | `--agent=marc` |
+| Rachid | 📦 | NPM deployment specialist | `--agent=rachid` |
+| Patnote | 🛡️ | Update manager (safe updates) | `--agent=patnote` |
+| Carmack | ⚡ | Token optimizer (reduce costs) | `--agent=carmack` |
+
+---
+
+## 🔗 Links
+
+- **Main README:** [README.md](README.md)
+- **Full Installation Guide:** [GUIDE-INSTALLATION-BYAN-SIMPLE.md](GUIDE-INSTALLATION-BYAN-SIMPLE.md)
+- **CHANGELOG:** [CHANGELOG.md](CHANGELOG.md)
+
+---
+
+**⏱️ Total time:** 5 minutes  
+**Commands:** 8 essential  
+**Validation:** 7 checks  
+
+**Happy speed-running!** ⚡🏗️

package/install/README-NPM-SHORT.md

@@ -0,0 +1,298 @@
+# BYAN - Intelligent AI Agent Creator
+
+**Create custom AI agents in 15 minutes** | GitHub Copilot CLI, VSCode, Claude Code
+
+## Quick Start
+
+```bash
+npx create-byan-agent
+```
+
+That's it! The installer launches automatically.
+
+## 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
+
+### Option 1: NPX (Recommended)
+
+```bash
+npx create-byan-agent
+```
+
+### Option 2: Global Install
+
+```bash
+npm install -g create-byan-agent
+create-byan-agent
+```
+
+## Create Your First Agent
+
+### 1. Launch BYAN
+
+**GitHub Copilot CLI:**
+```bash
+gh copilot
+@byan
+```
+
+**Command Line:**
+```bash
+npx create-byan-agent
+```
+
+### 2. Choose Mode
+
+**🎤 Full Interview (15-30 min)** - Recommended for first agent
+- 12-15 questions
+- In-depth analysis
+- Ultra-personalized agent
+
+**⚡ Quick Create (5 min)** - For experienced users
+- 3-5 essential questions
+- Functional agent quickly
+
+### 3. Answer Questions
+
+BYAN asks questions in 4 categories:
+
+1. **Context**: Your project, goals
+2. **Business**: Domain, constraints
+3. **Agent**: Desired skills, tasks
+4. **Validation**: Confirmation, adjustments
+
+### 4. Automatic Generation
+
+```
+✅ Complete analysis
+✅ Agent created: my-dev-agent.md
+✅ Validated and ready
+```
+
+Agent saved to:
+- GitHub Copilot: `.github/copilot/agents/`
+- Other platforms: `.codex/prompts/`
+
+## Usage Examples
+
+### Code Review Agent
+
+```bash
+npx create-byan-agent
+
+# BYAN asks:
+# Purpose? → "Review JavaScript code"
+# Tasks? → "Detect bugs, suggest optimizations"
+# Constraints? → "Follow our style guide"
+
+# Result: code-reviewer.md created in 2 seconds
+```
+
+### Documentation Agent
+
+```bash
+npx create-byan-agent
+
+# Purpose? → "Generate API documentation"
+# Tech? → "Node.js, Express, MongoDB"
+# Format? → "Markdown with examples"
+
+# Result: doc-generator.md ready
+```
+
+## Use Your Agent
+
+### With GitHub Copilot CLI
+
+```bash
+gh copilot
+@my-dev-agent
+# Your agent responds!
+```
+
+### With VSCode
+
+1. Command Palette (Ctrl+Shift+P)
+2. "GitHub Copilot: Chat"
+3. Type `@my-dev-agent`
+
+### With Claude Code
+
+```bash
+claude chat --agent my-dev-agent
+```
+
+## Key Concepts (v2.0)
+
+### 1. Intelligent Interview (4 phases)
+
+```
+CONTEXT → BUSINESS → AGENT → VALIDATION
+```
+
+Minimum 3 questions per phase = 12 total
+
+### 2. State Machine
+
+```
+INTERVIEW → ANALYSIS → GENERATION → COMPLETED
+```
+
+### 3. Template System
+
+Agents generated from professional templates with YAML frontmatter + XML structure.
+
+### 4. Automatic Validation
+
+- ✅ Correct YAML format
+- ✅ Valid XML structure
+- ✅ No emojis in code (Mantra IA-23)
+- ✅ Valid agent name
+- ✅ Clear description
+
+### 5. Methodology: 64 Mantras
+
+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
+
+## Advanced Configuration
+
+### Customize Output
+
+```javascript
+const ByanV2 = require('create-byan-agent');
+
+const byan = new ByanV2({
+  outputFolder: './my-agents',
+  language: 'en',
+  template: 'custom'
+});
+```
+
+### Programmatic Usage
+
+```javascript
+const ByanV2 = require('create-byan-agent');
+
+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);
+}
+```
+
+## Useful Commands
+
+```bash
+# List agents
+ls .github/copilot/agents/
+
+# Edit agent
+code .github/copilot/agents/my-agent.md
+
+# Validate agent
+npx create-byan-agent --validate my-agent.md
+
+# Version
+npx create-byan-agent --version
+```
+
+## Help & Support
+
+### Get Help
+
+```
+/bmad-help
+```
+
+### Documentation
+
+- [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
+
+**Agent doesn't appear in Copilot**
+```bash
+cat .github/copilot/agents/my-agent.md
+gh copilot quit && gh copilot
+```
+
+**"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
+```
+
+## Stats (v2.0)
+
+- ✅ **881/881 tests passing (100%)**
+- ✅ **14 modules**
+- ✅ **77 Story Points delivered**
+- ✅ **Agent in < 2 seconds** after interview
+- ✅ **64 mantras** applied automatically
+
+## Use Cases
+
+**Developers**: Code review, test generation, refactoring, security analysis
+
+**Writers**: Documentation, proofreading, translation, content creation
+
+**Project Managers**: Ticket analysis, reports, planning, prioritization
+
+**Designers**: UI components, accessibility, CSS optimization, design systems
+
+## License
+
+MIT License
+
+## Contributors
+
+**Core Team:**
+- **BYAN**: Intelligent agent creator
+- **RACHID**: NPM/NPX deployment specialist
+- **MARC**: GitHub Copilot CLI integration expert
+- **PATNOTE**: Update manager
+- **CARMACK**: Token optimizer
+
+## Links
+
+- 📦 [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)
+
+---
+
+**BYAN v2.0** - Create professional AI agents in 15 minutes 🚀