@apiai/ba-cockpit-cli
v1.5.0
Published
CLI tool for BA Cockpit - Professional VS Code template for Business Analysts
Maintainers
Readme
🎯 BA Cockpit - Template pour Business Analysts
Template VS Code professionnel pour Business Analysts travaillant sur des projets bancaires, assurantiels ou fintech.
🚀 Démarrage Rapide
Option 1 : Utiliser comme Template GitHub
- Cliquez sur "Use this template" en haut de la page
- Créez votre propre repository
- Clonez-le localement
- Lancez
./setup.shpour créer votre premier projet
Option 2 : Clone Direct
git clone https://github.com/[votre-org]/ba-cockpit-template.git
cd ba-cockpit-template
./setup.sh📦 Contenu du Template
ba-cockpit-template/
├── 📁 .github/
│ ├── agents/ # 26 agents Copilot spécialisés
│ │ ├── agentrevieweruserstory.agent.md
│ │ ├── testMatrixGenerator.agent.md
│ │ ├── gherkinConverter.agent.md
│ │ └── ... (23 autres agents)
│ └── copilot-instructions.md # Configuration Copilot BA
│
├── 📁 .vscode/
│ ├── settings.json # Configuration VS Code optimisée
│ ├── keybindings.json # Raccourcis clavier BA
│ ├── tasks.json # Tâches automatisées
│ ├── markdown.code-snippets # Snippets US, Gherkin, etc.
│ └── agents/ # Lien symbolique vers .github/agents
│
├── 📁 templates/
│ ├── user-stories/
│ │ └── US-TEMPLATE.md # Template User Story complet
│ └── test-cases/
│ └── TC-TEMPLATE.md # Template Test Case
│
├── 📁 _exemple-projet-skillpilot/ # Projet exemple complet
│ ├── specs/ # User Stories exemples
│ ├── reports/ # Rapports de review
│ └── README.md
│
├── 📄 setup.sh # Script création de projet
├── 📄 CHEATSHEET_BA.md # Cheat sheet complète
├── 📄 GUIDE_DEMARRAGE.md # Guide de démarrage
└── 📄 README.md # Ce fichier✨ Fonctionnalités Principales
🤖 26 Agents Copilot Spécialisés
Point fort du BA Cockpit : Une équipe d'agents IA experts pour chaque tâche BA
Les agents sont automatiquement disponibles dans GitHub Copilot Chat. Mentionnez-les avec @ :
@agentrevieweruserstory Analyse cette User Story
@gherkinConverter Convertis en scénarios Gherkin
@testMatrixGenerator Génère la matrice de tests⚡ Quick Launch - Lancement rapide des agents
🌟 Méthode 1 : Menu Principal (NOUVEAU - Portable)
Cmd+K Cmd+M→ Menu principal avec accès à tout- Point d'entrée unique : Dashboard, doc, templates, raccourcis
- 100% portable (HTML pur, fonctionne partout)
🎨 Méthode 2 : Dashboard Graphique
Cmd+K Cmd+D→ Interface graphique des 26 agentsCmd+K Cmd+0-5→ Accès rapide au dashboard- Recherche en temps réel, badges TOP agents
- Cliquez sur une carte pour copier l'agent
📚 Méthode 3 : Fichier Markdown
- Ouvrez
.vscode/LAUNCHER.md - Tous les liens cliquables (agents, doc, templates)
- Idéal pour bookmark/accès rapide
💬 Méthode 4 : Copilot Chat classique
Cmd+K Cmd+C→ Ouvrir Copilot Chat- Tapez
@pour voir tous les agents
📚 Voir le catalogue complet : AGENTS-CATALOG.md (ou Cmd+Shift+P → "📚 Catalogue des Agents")
🏆 Top 10 des Agents les Plus Utiles
| Agent | Usage Principal | Gain de Temps | |-------|----------------|---------------| | @agentrevieweruserstory | Review QA complète de US | ⏱️ 30 min → 5 min | | @gherkinConverter | Critères d'acceptation | ⏱️ 20 min → 3 min | | @testMatrixGenerator | Matrice de tests | ⏱️ 1h → 10 min | | @impactAnalyzer | Analyse d'impact | ⏱️ 45 min → 10 min | | @dataSetGenerator | Données de test | ⏱️ 30 min → 5 min | | @transfotousertories | Notes → User Stories | ⏱️ 25 min → 5 min | | @wsjfBacklogPrioritizer | Priorisation WSJF | ⏱️ 40 min → 10 min | | @dpo-rgpd | Analyse RGPD | ⏱️ 1h → 15 min | | @mermaidFlowBuilder | Diagrammes processus | ⏱️ 20 min → 5 min | | @uatPlanner | Plan de recette | ⏱️ 45 min → 10 min |
📚 Catégories Complètes
- 🔍 Analyse & Review (5 agents) - Validation qualité, écarts, cohérence
- 📝 Rédaction & Conversion (4 agents) - US, Gherkin, traduction métier/tech
- 🧪 Test & Qualité (4 agents) - Matrices, UAT, traçabilité
- 📊 Données & Modélisation (4 agents) - Datasets, modèles, volumétrie
- 🔐 Sécurité & Conformité (3 agents) - RGPD, audit, API
- 🎯 Gestion de Projet (4 agents) - WSJF, RAID, architecture
- 🤝 Facilitation & Communication (2 agents) - Ateliers, documentation
📖 Voir le catalogue complet des 26 agents →
💡 Exemple de Workflow avec Agents
graph LR
A[Besoin brut] -->|@transfotousertories| B[US structurée]
B -->|@gherkinConverter| C[Critères Gherkin]
C -->|@agentrevieweruserstory| D[US validée]
D -->|@testMatrixGenerator| E[Matrice de tests]
E -->|@dataSetGenerator| F[Données test]⌨️ Raccourcis Clavier Optimisés
| Raccourci | Action |
|-----------|--------|
| Cmd+Alt+U | Créer une nouvelle User Story |
| Cmd+Alt+G | Insérer un scénario Gherkin |
| Cmd+K Cmd+C | Ouvrir Copilot Chat |
| Cmd+Shift+M | Prévisualiser Markdown |
📝 Snippets Prêts à l'Emploi
Tapez les mots-clés suivants dans vos fichiers Markdown :
us→ Template User Story completgherkin→ Critères d'acceptation Gherkinmermaid-flow→ Diagramme de fluxtest-matrix→ Matrice de testscopilot-us→ Prompt structuré pour Copilotagent-commands→ Liste de tous les agents
🎯 Dashboard Intégré
Visualisez vos statistiques projet en temps réel :
# Depuis n'importe quel projet
just BA Dashboard
# Ou lancez la tâche via VS Code (Cmd+Shift+P → "Run Task")Affiche :
- 📋 Nombre de User Stories
- 🧪 Nombre de Test Cases
- 📊 Nombre de Reviews
- 📈 Statistiques par statut (Brouillon / En revue / Validé)
🛠️ Installation & Configuration
Prérequis
- ✅ VS Code 1.85 ou supérieur
- ✅ GitHub Copilot (extension installée et activée)
- ✅ Git pour le versioning
- ⚠️ macOS/Linux (Windows nécessite WSL pour le script bash)
Installation des Extensions Recommandées
Le template inclut une liste d'extensions. VS Code vous proposera de les installer automatiquement à l'ouverture.
Extensions essentielles :
- GitHub Copilot
- Markdown All in One
- Mermaid Preview
- GitLens
🚦 Création de Votre Premier Projet
1. Lancer le Script Setup
cd ba-cockpit-template
./setup.shLe script vous demandera :
- 📝 Nom du projet (ex: "MonProjet")
- 👤 Nom du Business Analyst
- 🏢 Code client/organisation (ex: "CLT01")
2. Structure Générée
CLT01-MonProjet/
├── specs/ # Vos User Stories
├── reports/ # Rapports d'analyse
├── datasets/ # Jeux de données
├── reviews/ # Reviews et audits
├── README.md # Documentation projet
└── .gitignore # Fichiers à ignorer3. Commencer à Travailler
cd CLT01-MonProjet
code .Créez votre première User Story :
- Tapez
Cmd+Alt+UOU - Tapez
uspuis Tab OU - Copiez
/templates/user-stories/US-TEMPLATE.md
📚 Documentation
| Document | Description | |----------|-------------| | CHEATSHEET_BA.md | Cheat sheet complète des raccourcis et commandes | | GUIDE_DEMARRAGE.md | Guide de démarrage détaillé | | GUIDE_UX_BA_COCKPIT.md | Guide UX et workflows | | Agents Directory | Documentation de tous les agents |
🎓 Exemple Complet
Un projet exemple est fourni dans _exemple-projet-skillpilot/ :
- ✅ User Stories complètes avec critères Gherkin
- ✅ Test Cases structurés
- ✅ Reports de review
- ✅ Diagrammes Mermaid
🔄 Workflows Recommandés
Workflow 1 : Rédaction de User Story
- Créer :
Cmd+Alt+Uouus+ Tab - Rédiger : Remplir les sections (contexte, critères, règles métier)
- Enrichir : Demander à Copilot : "Enrichis cette US avec des cas limites"
- Valider :
@agentrevieweruserstory Review cette US - Tester :
@testMatrixGenerator Génère la matrice de tests
Workflow 2 : Analyse d'Impact
- Ouvrir la US concernée
- Lancer l'analyse :
@impactAnalyzer Analyse l'impact de cette US - Compléter : Ajouter les dépendances identifiées
- Tracer :
@traceabilityMatrixBuilder Crée la matrice de traçabilité
Workflow 3 : Génération de Tests
- Depuis la US :
@gherkinConverter Convertis en scénarios Gherkin - Créer TC : Copier le template
TC-TEMPLATE.md - Matrice :
@testMatrixGeneratorpour couverture complète - Données :
@dataSetGeneratorpour jeux de test
🤝 Personnalisation
Adapter les Templates
- Modifiez les templates dans
/templates/ - Ajustez les snippets dans
.vscode/markdown.code-snippets - Personnalisez les raccourcis dans
.vscode/keybindings.json
Ajouter vos Propres Agents
Créez un fichier .agent.md dans .github/agents/ :
You are a specialized Business Analyst agent focused on [VOTRE SPÉCIALITÉ].
Your role is to [DESCRIPTION DU RÔLE].
## Instructions
- [Instruction 1]
- [Instruction 2]
## Output Format
[Format de sortie attendu]Configurer le Dashboard
Éditez .vscode/tasks.json pour adapter les statistiques affichées.
🐛 Dépannage
Les agents Copilot ne s'affichent pas
- Vérifiez que GitHub Copilot est activé
- Rechargez VS Code :
Cmd+Shift+P→ "Reload Window" - Vérifiez que le dossier
.github/agents/existe
Les snippets ne fonctionnent pas
- Vérifiez que les fichiers
.code-snippetssont dans.vscode/ - Rechargez les snippets :
Cmd+Shift+P→ "Reload Window" - Tapez le mot-clé complet puis
Tab(pas Enter)
Le script setup.sh ne s'exécute pas
# Rendre le script exécutable
chmod +x setup.sh
# Lancer avec bash explicitement
bash setup.sh📊 Statistiques du Template
- 🤖 26 agents Copilot spécialisés
- ⌨️ 20+ raccourcis clavier optimisés
- 📝 30+ snippets prêts à l'emploi
- 📚 Templates complets US, TC, Reports
- 🎯 Dashboard intégré avec statistiques temps réel
🤝 Contribution
Les contributions sont les bienvenues ! Pour contribuer :
- Fork ce repository
- Créez une branche :
git checkout -b feature/amazing-feature - Committez :
git commit -m 'Add amazing feature' - Push :
git push origin feature/amazing-feature - Ouvrez une Pull Request
📝 Licence
Ce template est sous licence MIT. Voir le fichier LICENSE pour plus de détails.
🙏 Remerciements
- GitHub Copilot pour l'IA générative
- La communauté VS Code
- Les Business Analysts qui ont partagé leurs best practices
📞 Support
- 📧 Email : [votre-email]
- 💬 Discussions : GitHub Discussions
- 🐛 Issues : GitHub Issues
Fait avec ❤️ par des Business Analysts, pour des Business Analysts
