docs: merge rich README style with current technical content

Combine the visual README (badges, Mermaid, images, citations, FAQ)
with up-to-date technical sections: ZeroClaw, MCP/CAD stack, Python
venv bootstrap, test suites, workflow catalog, ecosystem table, and
CI/release docs.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
This commit is contained in:
Clément SAILLANT
2026-03-09 02:33:32 +01:00
co-authored by Claude Opus 4.6
parent da0d4aa806
commit cb0401516d
+176 -119
View File
@@ -1,36 +1,32 @@
# Kill_LIFE 🚀 — Modèle de Projet Embarqué IA-Natif
<!-- Badges personnalisés -->
[![Build Status](https://img.shields.io/github/actions/workflow/status/electron-rare/Kill_LIFE/ci.yml?branch=main)](https://github.com/electron-rare/Kill_LIFE/actions)
<!-- Badges -->
[![CI](https://img.shields.io/github/actions/workflow/status/electron-rare/Kill_LIFE/ci.yml?branch=main&label=CI)](https://github.com/electron-rare/Kill_LIFE/actions)
[![Licence MIT](https://img.shields.io/badge/license-MIT-blue)](licenses/MIT.txt)
[![Compliance](https://img.shields.io/badge/compliance-passed-brightgreen)](docs/COMPLIANCE.md)
[![Coverage](https://img.shields.io/badge/coverage-90%25-brightgreen)](docs/coverage_report.html)
---
## Sommaire
Bienvenue dans **Kill_LIFE**, le modèle open source pour systèmes embarqués IA où chaque étape est traçable, chaque evidence pack est rangé, et chaque agent suit un workflow sécurisé. Ce projet vise la reproductibilité, la conformité et l’automatisation pour l’embarqué IA multi-cibles.
Bienvenue dans **Kill_LIFE**, le modèle open source pour systèmes embarqués IA où chaque étape est traçable, chaque evidence pack est rangé, et chaque agent suit un workflow sécurisé. Ce projet vise la reproductibilité, la conformité et l'automatisation pour l'embarqué IA multi-cibles.
## 🧩 Présentation
Kill_LIFE est un modèle agentique pour systèmes embarqués IA, orienté spec-first, sécurité et traçabilité. Il s’appuie sur des agents spécialisés, des workflows automatisés et une arborescence claire.
Kill_LIFE est un modèle agentique pour systèmes embarqués IA, orienté spec-first, sécurité et traçabilité. Il s'appuie sur des agents spécialisés, des workflows automatisés et une arborescence claire.
> « Bienvenue dans le meilleur des mondes : ici, chaque commit est validé, chaque gate est passé, et chaque agent sait que la vraie liberté, c’est d’avoir un evidence pack bien rangé. »
> « Bienvenue dans le meilleur des mondes : ici, chaque commit est validé, chaque gate est passé, et chaque agent sait que la vraie liberté, c'est d'avoir un evidence pack bien rangé. »
> — Aldous Huxley, version CI/CD
<div align="center">
<img src="docs/assets/banner_kill_life_generated.png" alt="Bannière Kill_LIFE" width="600" />
</div>
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/dont_panic_generated.png" alt="Don’t Panic" width="120" style="vertical-align:middle;margin:0 4px;" />
<img src="docs/assets/dont_panic_generated.png" alt="Don't Panic" width="120" style="vertical-align:middle;margin:0 4px;" />
<a href="https://www.youtube.com/playlist?list=PLApocalypse42" target="_blank">Playlist apocalypse</a>
</div>
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/arborescence_kill_life_generated.png" alt="Arborescence du projet Kill_LIFE" width="400" />
</div>
---
## 🧩 Architecture & Principes
@@ -42,15 +38,17 @@ Kill_LIFE est un modèle agentique pour systèmes embarqués IA, orienté spec-f
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/agents_bmad_generated.png" alt="Schéma des agents BMAD" width="400" />
</div>
- **Tool-first** : Scripts reproductibles ([tools/](tools/)), evidence pack dans `artifacts/`.
- **Pipeline hardware/firmware** : Bulk edits, exports, tests, conformité, snapshots.
- **CAD headless** : KiCad 10 first + FreeCAD + OpenSCAD via MCP, conteneurisés.
- **Sécurité & conformité** : Sanitisation, sorties sûres, sandboxing, scope guard, anti-prompt injection ([OpenClaw Sandbox](https://www.openclaw.io/)).
- **Runtime agentique** : `ZeroClaw` en local on-demand, `LangGraph` et `AutoGen` comme patterns d'intégration optionnels.
> « La réponse à la question ultime de la vie, de l’univers et du développement embarqué IA : 42 specs, 7 agents, et un pipeline qui ne panique jamais. »
> « Kill_LIFE, c’est l’open source embarqué version IA, mais aussi un clin d’œil à la fin du monde : ici, on ne craint ni l’apocalypse, ni les bugs, ni les injections de prompt. On rêve, on code, on documente, et on fait des bulk edits comme des réplicants en quête de conformité. »
> « La réponse à la question ultime de la vie, de l'univers et du développement embarqué IA : 42 specs, 7 agents, et un pipeline qui ne panique jamais. »
> — Le README qui ne panique jamais
([Les particules font-elles l’amour ?](https://lelectron-fou.bandcamp.com/album/les-particules-font-elles-l-amour-la-physique))
([Les particules font-elles l'amour ?](https://lelectron-fou.bandcamp.com/album/les-particules-font-elles-l-amour-la-physique))
---
@@ -63,8 +61,10 @@ Kill_LIFE est un modèle agentique pour systèmes embarqués IA, orienté spec-f
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/pipeline_hw_fw_generated.png" alt="Pipeline hardware/firmware" width="400" />
</div>
- **Conformité** : Profils injectés, validation automatique.
- **OpenClaw** : Labels & commentaires sanitisés, jamais de commit/push, sandbox obligatoire.
- **Workflow catalog** : Workflows JSON éditables par [`crazy_life`](https://github.com/electron-rare/crazy_life), validés contre un schéma JSON.
---
@@ -74,12 +74,12 @@ Kill_LIFE est un modèle agentique pour systèmes embarqués IA, orienté spec-f
```mermaid
flowchart TD
Issue[Issue (label ai:*)] --> PR[Pull Request]
PR --> Gate[Gate (tests, conformité)]
Issue[Issue label ai:*] --> PR[Pull Request]
PR --> Gate[Gate tests + conformité]
Gate --> Evidence[Evidence Pack]
Evidence --> CI[CI/CD]
CI --> Deploy[Déploiement multi-cible]
PR --> Agents[Agents (PM, Architecte, Firmware, QA, Doc, HW)]
PR --> Agents[Agents PM Architecte Firmware QA Doc HW]
Agents --> Specs[specs/]
Agents --> Firmware[firmware/]
Agents --> Hardware[hardware/]
@@ -95,29 +95,50 @@ flowchart TD
```
</div>
> _Parmegiani : Un bulk edit, c’est une métamorphose électronique, un peu comme un pack d’évidence qui se transforme en nuage de sons._
> _Parmegiani : Un bulk edit, c'est une métamorphose électronique, un peu comme un pack d'évidence qui se transforme en nuage de sons._
---
## 🗺️ Schéma de flux
## 🗺️ Structure du projet
Voir [KIKIFOU/diagramme.md](KIKIFOU/diagramme.md) pour un diagramme complet du pipeline.
```text
Kill_LIFE/
├── firmware/ # Code PlatformIO (ESP32/STM32)
├── hardware/ # Assets hardware et blocs KiCad
├── specs/ # Specs et tâches canoniques
├── workflows/ # Workflows JSON canoniques + templates
├── agents/ # 6 agents spécialisés (PM, Archi, FW, QA, Doc, HW)
├── bmad/ # Gates, rituels, handoffs
├── compliance/ # Profils réglementaires, evidence
├── openclaw/ # Labels, sandbox, onboarding
├── tools/
│ ├── compliance/ # Validation compliance
│ ├── hw/ # Stack CAD, MCP, exports, smoke
│ ├── ai/ # ZeroClaw launchers, intégrations
│ ├── mistral/ # Safe patch et outils Mistral
│ └── ci/ # Audit CI
├── deploy/cad/ # Dockerfiles et compose CAD/runtime
├── docs/ # Docs opérateur, bridge, plans, workflows
├── test/ # Tests Python
├── mcp.json # Profil MCP par défaut
└── mkdocs.yml # Site docs
```
## 🧾 Table de mapping
Voir [KIKIFOU/mapping.md](KIKIFOU/mapping.md) pour une synthèse des dossiers et dépendances.
Voir [KIKIFOU/diagramme.md](KIKIFOU/diagramme.md) pour le diagramme complet et [KIKIFOU/mapping.md](KIKIFOU/mapping.md) pour la table de mapping.
---
## 🚀 Installation & initialisation
## 🚀 Installation & démarrage rapide
### Prérequis
- OS : Linux, macOS, Windows (WSL)
- Python ≥ 3.8
- PlatformIO
- Python ≥ 3.10
- Docker + `docker compose`
- `gh` pour les opérations GitHub
- PlatformIO en natif ou via la stack conteneurisée
- KiCad (hardware)
- Docker (optionnel)
### Installation rapide
@@ -129,47 +150,109 @@ bash install_kill_life.sh
Voir [INSTALL.md](INSTALL.md) pour les détails.
---
### Bootstrap Python repo-local
## 🤝 Contribuer
```bash
bash tools/bootstrap_python_env.sh
```
1. Forke le dépôt et clone-le localement.
2. Suis le guide d’onboarding ([docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md)).
3. Ajoute des exemples minimalistes pour chaque agent (voir [agents/](agents/)).
4. Propose des blocks hardware, profils de conformité, tests.
5. Documente tes scripts et contributions.
6. Ouvre une PR, passe les gates, fournis un evidence pack.
7. Respecte les conventions de commit et de labelling (`ai:*`).
8. Vérifie la conformité et la sécurité (voir section Sécurité).
Options utiles :
- `--venv-dir /tmp/kill-life-venv` pour vérifier le bootstrap sur un environnement vierge
- `--reinstall` pour recréer proprement le venv cible
Pour toute question, consulte la [FAQ](docs/FAQ.md) ou ouvre une issue.
Le chemin supporté pour le Python du repo est `./.venv/bin/python`.
### Tests Python
> « Les particules rêvent-elles d’électron-ironique ? Peut-être font-elles l’amour dans le dossier hardware, pendant que les agents QA se demandent si la conformité est un rêve ou une réalité. »
> — Inspiré par Le Réplicant de K. Dick & Les particules font-elles l’amour
_« J’ai vu des evidence packs briller dans l’obscurité près des gates S1… »_
```bash
bash tools/test_python.sh
```
| Suite | Commande | Contenu |
|---|---|---|
| `stable` | `--suite stable` | Tests repo-locaux (specs, compliance, sanitizer, safe patch, schops) |
| `mcp` | `--suite mcp` | Tests MCP locaux (knowledge-base, github-dispatch, nexar) |
| `all` | `--suite all` | Les deux suites enchaînées |
Options : `--bootstrap` pour créer le venv avant, `--list` pour lister les commandes couvertes.
### Vérifications utiles
```bash
.venv/bin/python tools/compliance/validate.py --strict
.venv/bin/python tools/validate_specs.py --json
bash tools/hw/cad_stack.sh doctor
KILL_LIFE_PIO_MODE=container .venv/bin/python tools/auto_check_ci_cd.py
```
---
## 🔗 Liens utiles
## 🔧 CAD & MCP
- [Documentation complète](docs/index.md)
- [RUNBOOK opérateur](RUNBOOK.md)
- [Guide d’installation](INSTALL.md)
- [Synthèse technique et recommandations](KIKIFOU/synthese.md)
- [Diagramme pipeline](KIKIFOU/diagramme.md)
- [Mapping dossiers](KIKIFOU/mapping.md)
- [Gate Runner](https://gate-runner.com) — passe les gates, évite les bugs.
La stack CAD est documentée dans [`deploy/cad/README.md`](deploy/cad/README.md) et pilotée par [`tools/hw/cad_stack.sh`](tools/hw/cad_stack.sh).
- Cible actuelle : **KiCad 10 first** + FreeCAD + OpenSCAD
- Launcher MCP : [`tools/hw/run_kicad_mcp.sh`](tools/hw/run_kicad_mcp.sh)
- Configuration MCP : [`docs/MCP_SETUP.md`](docs/MCP_SETUP.md) et [`mcp.json`](mcp.json)
---
## 🤖 ZeroClaw (optionnel)
Le runtime opérateur `ZeroClaw` peut tourner nativement sur la machine opérateur. Le chemin supporté est le binaire officiel installé dans `~/.cargo/bin`.
```bash
bash tools/ai/zeroclaw_stack_up.sh # démarrer
bash tools/ai/zeroclaw_stack_down.sh # arrêter
```
Les runbooks et intégrations vivent dans [`tools/ai/integrations/`](tools/ai/integrations/) et restent consultables même quand le runtime n'est pas démarré.
---
## 📦 Workflow catalog
Les workflows éditables par `crazy_life` vivent dans [`workflows/`](workflows/) et sont validés contre [`workflows/workflow.schema.json`](workflows/workflow.schema.json).
- `workflows/*.json` : workflows canoniques
- `workflows/templates/*.json` : templates de création
- `.crazy-life/runs/` : état des runs locaux
- `.crazy-life/backups/workflows/` : révisions et restores
---
## 🦾 Workflows agents détaillés
### 1. Spécification → Implémentation Firmware
1. Rédige la spec dans `specs/`.
2. Ouvre une issue avec le label `ai:spec`.
3. L'agent PM/Architecte génère le plan et l'architecture.
4. L'agent Firmware implémente le code dans `firmware/`.
5. L'agent QA ajoute des tests Unity.
6. Evidence pack généré automatiquement.
### 2. Bulk Edit Hardware KiCad
1. Ouvre une issue avec le label `ai:hw`.
2. L'agent HW effectue un bulk edit via `tools/hw/schops`.
3. Exporte ERC/DRC, BOM, netlist.
4. Snapshot avant/après dans `artifacts/hw/<timestamp>/`.
### 3. Documentation & Conformité
1. Ouvre une issue avec le label `ai:docs` ou `ai:qa`.
2. L'agent Doc met à jour `docs/` et le README.
3. L'agent Conformité valide le profil et génère le rapport.
---
## 🛡️ Sécurité & conformité
- OpenClaw : sandbox obligatoire, jamais d’accès aux secrets ou au code source.
- OpenClaw : sandbox obligatoire, jamais d'accès aux secrets ou au code source.
- Workflows CI : validation, sanitisation, scope guard, anti-prompt injection.
- Evidence packs : tous les rapports dans `artifacts/<domaine>/<timestamp>/`.
- Tests hardware reproductibles via scripts documentés.
- Respect des conventions de labelling et de commit.
---
@@ -189,105 +272,79 @@ _« J’ai vu des evidence packs briller dans l’obscurité près des gates S1
<img src="docs/assets/gate_validation_generated.png" alt="Gate Validation" width="200" />
<img src="docs/assets/openclaw_sandbox_generated.png" alt="OpenClaw Sandbox" width="200" />
</div>
- **.github/** : Workflows CI, scope guard, enforcement labels.
- **licenses/** : MIT, CERN OHL v2, CC-BY 4.0.
---
## 🦾 Workflows agents
## 🌐 Écosystème
- **Scope guard** : Le label détermine les dossiers modifiables.
- Ouvre une issue avec le label `ai:spec`.
- L’agent PM/Architecte génère le plan et l’architecture.
- L’agent Firmware implémente le code dans `firmware/`.
- L’agent QA ajoute des tests Unity.
- Evidence pack généré automatiquement.
> Générateur de phrases dystopiques pour motiver les contributeurs.
- **Bulk Edit Hardware KiCad**
- **Documentation & Conformité**
1. Ouvre une issue avec le label `ai:docs` ou `ai:qa`.
2. L’agent Doc met à jour `docs/` et le README.
3. L’agent Conformité valide le profil et génère le rapport.
> _RtFM: Les agents QA écoutent le paysage du repo, à la recherche d’un bug caché dans le souffle._
> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_
| Repo | Rôle |
|---|---|
| **Kill_LIFE** | Source de vérité : workflows, runtime, evidence packs, firmware, CAD, compliance |
| [**crazy_life**](https://github.com/electron-rare/crazy_life) | Surface web/devops et workflow editor |
| [**mascarade**](https://github.com/electron-rare/mascarade) | Orchestration et bridge historique (sync uniquement) |
Articulation détaillée : [`docs/MASCARADE_BRIDGE.md`](docs/MASCARADE_BRIDGE.md)
---
## 📝 Installation & Sécurité
## ⚙️ CI & release
Un guide d’installation détaillé ([INSTALL.md](INSTALL.md)) explique comment installer le projet, configurer les environnements, sécuriser OpenClaw, lancer les tests hardware, générer la documentation et utiliser Docker.
Un script d’installation unique ([install_kill_life.sh](install_kill_life.sh)) automatise tout : dépendances, spec, profil de conformité, environnement Python, modules IA/hardware/firmware, tests, doc, Docker, et vérification de la sécurité OpenClaw.
Sécurité OpenClaw : sandbox obligatoire, jamais d’accès aux secrets ou au code source.
Tests hardware reproductibles via scripts documentés.
- `.github/workflows/ci.yml` : gate repo-local stable (bootstrap Python + `bash tools/test_python.sh --suite stable`)
- `.github/workflows/release_signing.yml` : release versionnée (tag `v*` ou `workflow_dispatch`)
- GitHub Pages : surfaces secondaires docs/evidence (pas un gate canonique)
---
## 🧬 Architecture agentique avancée
## 🤝 Contribuer
- Structure multi-agent (BMAD) : rôles PM, Architecte, Firmware, QA, Doc, HW, orchestrés par rituels, gates et handoffs.
- Développement spec-first : chaque évolution commence par une spécification, standards versionnés et profils injectés.
- Automatisation & sécurité : workflows CI, sanitisation, sorties sûres, scope guard, anti-prompt injection, OpenClaw sandbox.
- Multi-cibles & pipelines reproductibles : ESP32, STM32, Linux, tests natifs, bulk edits hardware KiCad, exports automatisés.
- Documentation claire & onboarding : README détaillé, FAQ, workflows, arborescence graphique, guides d’installation, politique de contribution.
1. Forke le dépôt et clone-le localement.
2. Suis le guide d'onboarding ([docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md)).
3. Ajoute des exemples minimalistes pour chaque agent (voir [agents/](agents/)).
4. Propose des blocks hardware, profils de conformité, tests.
5. Ouvre une PR, passe les gates, fournis un evidence pack.
6. Respecte les conventions de commit et de labelling (`ai:*`).
> « Les particules rêvent-elles d'électron-ironique ? Peut-être font-elles l'amour dans le dossier hardware, pendant que les agents QA se demandent si la conformité est un rêve ou une réalité. »
> — Inspiré par Le Réplicant de K. Dick & Les particules font-elles l'amour
_« J'ai vu des evidence packs briller dans l'obscurité près des gates S1… »_
---
## 🚀 Conventions, contribution & cross-platform
> _RtFM : Parfois, le README résonne comme un drone, et tout le projet s’accorde._
Toutes les conventions, instructions d’installation, sécurité, multi-agents, conformité, workflows et support multi-plateforme (Docker inclus) sont synthétisées.
Architecture, étapes d’initialisation, fonctions clés, sécurité OpenClaw, contribution.
## 🔗 Liens utiles
- [Documentation complète](docs/index.md)
- [RUNBOOK opérateur](RUNBOOK.md)
- [Guide d'installation](INSTALL.md)
- [Configuration MCP](docs/MCP_SETUP.md)
- [Synthèse technique](KIKIFOU/synthese.md)
- [Diagramme pipeline](KIKIFOU/diagramme.md)
- [Mapping dossiers](KIKIFOU/mapping.md)
---
## ❓ FAQ
**Q : Comment démarrer rapidement ?**
R : Suis la section « Installation & initialisation » ou le guide INSTALL.md.
R : `bash install_kill_life.sh` puis `bash tools/bootstrap_python_env.sh`.
**Q : Comment installer tout automatiquement ?**
R : Utilise le script `install_kill_life.sh`.
**Q : Comment lancer les tests ?**
R : `bash tools/test_python.sh --suite stable`
**Q : Comment sécuriser OpenClaw ?**
R : Sandbox obligatoire, jamais d’accès aux secrets ou au code source.
**Q : Comment lancer les tests hardware ?**
R : Suis les scripts documentés dans le README et INSTALL.md.
R : Sandbox obligatoire, jamais d'accès aux secrets ou au code source.
**Q : Comment contribuer ?**
R : Ajoute des profils, améliore les scripts, enrichis les standards, et respecte la politique anti-injection.
R : Forke, suis le RUNBOOK, ouvre une PR avec evidence pack, respecte les labels `ai:*`.
**Q : Où trouver la documentation complète ?**
R : Voir [docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md), [INSTALL.md](INSTALL.md).
R : [docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md), [INSTALL.md](INSTALL.md).
---
## 🦾 Workflows détaillés
### 1. Spécification → Implémentation Firmware
1. Rédige la spec dans `specs/`.
2. Ouvre une issue avec le label `ai:spec`.
3. L’agent PM/Architecte génère le plan et l’architecture.
4. L’agent Firmware implémente le code dans `firmware/`.
5. L’agent QA ajoute des tests Unity.
6. Evidence pack généré automatiquement.
> [Spec Generator](https://webkaoss.herokuapp.com/) — science-fiction automatisée.
### 2. Bulk Edit Hardware KiCad
1. Ouvre une issue avec le label `ai:hw`.
2. L’agent HW effectue un bulk edit via `tools/hw/schops`.
3. Exporte ERC/DRC, BOM, netlist.
4. Snapshot avant/après dans `artifacts/hw/<timestamp>/`.
### 3. Documentation & Conformité
1. Ouvre une issue avec le label `ai:docs` ou `ai:qa`.
2. L’agent Doc met à jour `docs/` et le README.
3. L’agent Conformité valide le profil et génère le rapport.
> _RtFM: Les agents QA écoutent le paysage du repo, à la recherche d’un bug caché dans le souffle._
> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_
## 📜 Licence
MIT. Voir [`licenses/MIT.txt`](licenses/MIT.txt).