docs: restore rich README with badges, Mermaid, images and FAQ

Bring back the detailed README from 9734c88 with visual assets,
agent diagrams, literary references and contributor guide.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
This commit is contained in:
Clément SAILLANT
2026-03-09 02:31:51 +01:00
co-authored by Claude Opus 4.6
parent 4975be54cb
commit da0d4aa806
+241 -124
View File
@@ -1,53 +1,125 @@
# Kill_LIFE
# Kill_LIFE 🚀 — Modèle de Projet Embarqué IA-Natif
Template de projet embarque IA-natif, spec-first, avec gates de qualite, evidence packs et outillage runtime pour firmware, CAD et conformite.
<!-- 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)
[![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)
[![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)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](licenses/MIT.txt)
---
## Principe
## Sommaire
Kill_LIFE structure un projet embarque autour de specs testables, d'agents specialises, de gates de qualite et d'artefacts verifiables. Le depot couvre trois axes:
- firmware et CI locale/containeurisee
- CAD headless KiCad 10 first
- evidence, compliance et workflows canoniques
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 lautomatisation pour lembarqué IA multi-cibles.
Le runtime operateur local `ZeroClaw` reste supporte pour les boucles
agentiques et les integrations. `LangGraph` et `AutoGen` sont gardes comme
patterns d'integration optionnels autour de `ZeroClaw`, pas comme chemins
critiques du gate stable repo-local.
## Structure utile
## 🧩 Présentation
```text
Kill_LIFE/
├── firmware/ # Code PlatformIO
├── hardware/ # Assets hardware et blocs
├── specs/ # Specs et taches canoniques
├── workflows/ # Workflows JSON canoniques + templates
├── tools/
│ ├── compliance/ # Validation compliance
│ ├── hw/ # Stack CAD, MCP, exports, smoke
│ ├── mistral/ # Safe patch et outils Mistral
│ └── ci/ # Audit CI
├── deploy/cad/ # Dockerfiles et compose CAD/runtime
├── docs/ # Docs operateur, bridge, plans, workflows
├── test/ # Tests Python
├── mcp.json # Profil MCP par defaut
└── mkdocs.yml # Site docs
Kill_LIFE est un modèle agentique pour systèmes embarqués IA, orienté spec-first, sécurité et traçabilité. Il sappuie 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é, cest davoir 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="Dont 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
- **Spec-first** : Chaque évolution commence par une définition claire dans `specs/` ([Spec Generator FX](https://www.youtube.com/watch?v=9bZkp7q19f0)).
> _Schaeffer : Les agents du pipeline écoutent le bruit des specs comme une symphonie de sons trouvés._
- **Injection de standards** : Standards versionnés et profils injectés (Agent OS).
- **BMAD / BMAD-METHOD** : Agents par rôles (PM, Architecte, Firmware, QA, Doc, HW), rituels, gates, handoffs ([agents/](agents/), [bmad/](bmad/)).
<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.
- **Sécurité & conformité** : Sanitisation, sorties sûres, sandboxing, scope guard, anti-prompt injection ([OpenClaw Sandbox](https://www.openclaw.io/)).
> « La réponse à la question ultime de la vie, de lunivers et du développement embarqué IA : 42 specs, 7 agents, et un pipeline qui ne panique jamais. »
> « Kill_LIFE, cest lopen source embarqué version IA, mais aussi un clin d’œil à la fin du monde : ici, on ne craint ni lapocalypse, 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é. »
> — Le README qui ne panique jamais
([Les particules font-elles lamour ?](https://lelectron-fou.bandcamp.com/album/les-particules-font-elles-l-amour-la-physique))
---
## ✨ Fonctionnalités principales
- **Développement guidé par la spec** : User stories, contraintes, architecture, plans, backlog.
- **Automatisation** : Issue → PR avec tests unitaires, sanitisation, evidence pack.
- **Multi-cibles** : ESP32, STM32, Linux, tests natifs.
- **Pipeline matériel** : KiCad, exports SVG/ERC/DRC/BOM/netlist, bulk edits.
<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.
---
## 🖥️ Schéma agentique (Mermaid)
<div align="center">
```mermaid
flowchart TD
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)]
Agents --> Specs[specs/]
Agents --> Firmware[firmware/]
Agents --> Hardware[hardware/]
Agents --> Docs[docs/]
Agents --> Compliance[compliance/]
Agents --> Tools[tools/]
Agents --> OpenClaw[openclaw/]
Specs --> Standards[standards/]
Firmware --> Tests[tests/]
Hardware --> Exports[exports/]
Compliance --> Evidence
OpenClaw --> Sandbox[Sandbox]
```
## Demarrage rapide
</div>
> _Parmegiani : Un bulk edit, cest une métamorphose électronique, un peu comme un pack d’évidence qui se transforme en nuage de sons._
### Prerequis
---
- Python 3.10+
- Docker + `docker compose`
- `gh` pour les operations GitHub
- PlatformIO en natif ou via la stack conteneurisee
## 🗺️ Schéma de flux
### Installation
Voir [KIKIFOU/diagramme.md](KIKIFOU/diagramme.md) pour un diagramme complet du pipeline.
## 🧾 Table de mapping
Voir [KIKIFOU/mapping.md](KIKIFOU/mapping.md) pour une synthèse des dossiers et dépendances.
---
## 🚀 Installation & initialisation
### Prérequis
- OS : Linux, macOS, Windows (WSL)
- Python ≥ 3.8
- PlatformIO
- KiCad (hardware)
- Docker (optionnel)
### Installation rapide
```bash
git clone https://github.com/electron-rare/Kill_LIFE.git
@@ -55,122 +127,167 @@ cd Kill_LIFE
bash install_kill_life.sh
```
### ZeroClaw natif (optionnel)
Voir [INSTALL.md](INSTALL.md) pour les détails.
Le runtime operateur `ZeroClaw` peut aussi tourner nativement sur la machine
operateur. Le chemin supporte dans ce repo est le binaire officiel installe
dans `~/.cargo/bin`, avec compatibilite maintenue pour
`zeroclaw/target/release/zeroclaw`.
---
```bash
git clone https://github.com/zeroclaw-labs/zeroclaw.git zeroclaw
bash zeroclaw/bootstrap.sh --no-guided --prefer-prebuilt
mkdir -p "$HOME/.local/bin" zeroclaw/target/release
ln -sfn "$HOME/.cargo/bin/zeroclaw" "$HOME/.local/bin/zeroclaw"
ln -sfn "$HOME/.cargo/bin/zeroclaw" zeroclaw/target/release/zeroclaw
zeroclaw --version
```
## 🤝 Contribuer
Les launchers `tools/ai/zeroclaw_*.sh` resolvent maintenant la racine du repo
dynamiquement et retombent sur `command -v zeroclaw` si besoin.
1. Forke le dépôt et clone-le localement.
2. Suis le guide donboarding ([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é).
Posture operateur retenue:
- `zeroclaw.saillant.cc` = surface live du runtime natif quand la stack est
demarree
- `zeroclaw-docs.saillant.cc` = runbook ZeroClaw statique
- `langgraph.saillant.cc` = runbook LangGraph statique
- la stack native reste demarrable a la demande via `tools/ai/zeroclaw_stack_up.sh`
- le fallback provider `OpenRouter` est supporte et valide sur un appel webhook
reel
Pour toute question, consulte la [FAQ](docs/FAQ.md) ou ouvre une issue.
Chemin operateur supporte:
```bash
bash tools/ai/zeroclaw_stack_up.sh
bash tools/ai/zeroclaw_stack_down.sh
```
> « Les particules rêvent-elles d’électron-ironique ? Peut-être font-elles lamour 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 lamour
_« Jai vu des evidence packs briller dans lobscurité près des gates S1… »_
Le runtime `ZeroClaw` reste on-demand. Les runbooks et index d'integration
servis via `mascarade`/`edge-proxy` viennent de [`tools/ai/integrations/`](tools/ai/integrations/).
Ils restent consultables meme quand le runtime `ZeroClaw` n'est pas demarre.
---
### Bootstrap Python repo-local
## 🔗 Liens utiles
```bash
bash tools/bootstrap_python_env.sh
```
- [Documentation complète](docs/index.md)
- [RUNBOOK opérateur](RUNBOOK.md)
- [Guide dinstallation](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.
Options utiles:
- `--venv-dir /tmp/kill-life-venv` pour verifier le bootstrap sur une machine ou un environnement vierge
- `--reinstall` pour recreer proprement le venv cible
---
Le chemin supporte pour le Python du repo est `./.venv/bin/python`.
## 🛡️ Sécurité & conformité
### Tests Python repo-local
- OpenClaw : sandbox obligatoire, jamais daccè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.
```bash
bash tools/test_python.sh
```
---
Ce chemin couvre la suite Python repo-locale stable (`setup_repo`, `mcp_runtime_status`, `openclaw_sanitizer`, `apply_safe_patch`, `validate_specs`, `tools/hw/schops/tests`) sans dependre du `python3` systeme.
Les checks dependants du mirror specs ou des runtimes MCP restent des commandes d'integration separees.
## 🛠️ Fonctions clés
Options utiles:
- `--suite stable` pour le chemin repo-local supporte par defaut
- `--suite mcp` pour les tests MCP locaux (`knowledge-base`, `github-dispatch`, `nexar`)
- `--suite all` pour enchainer les deux
- `--bootstrap` pour creer le venv cible avant de lancer les tests
- `--list` pour afficher exactement les commandes couvertes
- **specs/** : Source de vérité, plans, backlog.
- **standards/** : Standards globaux, profils injectés.
- **bmad/** : Gates, rituels, templates.
- **agents/** : Prompts pour chaque rôle.
- **tools/** : Scripts IA, cockpit, conformité, watch.
- **firmware/** : PlatformIO, tests Unity, multi-cibles.
- **hardware/** : KiCad, bulk edits, exports.
- **openclaw/** : Labels, commentaires, sandbox.
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/bulk_edit_party_generated.png" alt="Bulk Edit Party" width="200" />
<img src="docs/assets/evidence_pack_generated.png" alt="Evidence Pack" width="200" />
<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.
Exemple de verification sur un venv temporaire:
---
```bash
bash tools/test_python.sh --bootstrap --venv-dir /tmp/kill-life-venv --suite stable
```
## 🦾 Workflows agents
### Verifications utiles
- **Scope guard** : Le label détermine les dossiers modifiables.
- Ouvre une issue avec le label `ai:spec`.
- Lagent PM/Architecte génère le plan et larchitecture.
- Lagent Firmware implémente le code dans `firmware/`.
- Lagent 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. Lagent Doc met à jour `docs/` et le README.
3. Lagent Conformité valide le profil et génère le rapport.
> _RtFM: Les agents QA écoutent le paysage du repo, à la recherche dun bug caché dans le souffle._
> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_
```bash
python3 tools/compliance/validate.py --strict
python3 tools/validate_specs.py --json
bash tools/hw/cad_stack.sh doctor
KILL_LIFE_PIO_MODE=container python3 tools/auto_check_ci_cd.py
```
---
## Workflow catalog
## 📝 Installation & Sécurité
Les workflows editables par `crazy_life` vivent dans [`workflows/`](workflows/) et sont valides contre [`workflows/workflow.schema.json`](workflows/workflow.schema.json).
Un guide dinstallation 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 dinstallation 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.
- `workflows/*.json` : workflows canoniques
- `workflows/templates/*.json` : templates de creation
- `.crazy-life/runs/` : etat des runs locaux
- `.crazy-life/backups/workflows/` : revisions et restores
Sécurité OpenClaw : sandbox obligatoire, jamais daccès aux secrets ou au code source.
Tests hardware reproductibles via scripts documentés.
## CAD et MCP
---
La stack CAD est documentee dans [`deploy/cad/README.md`](deploy/cad/README.md) et pilotee par [`tools/hw/cad_stack.sh`](tools/hw/cad_stack.sh).
## 🧬 Architecture agentique avancée
- cible actuelle: KiCad 10 first
- 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)
- 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 dinstallation, politique de contribution.
## Ecosysteme
---
- [`crazy_life`](https://github.com/electron-rare/crazy_life) : repo canonique web/devops
- [`mascarade`](https://github.com/electron-rare/mascarade) : repo compagnon/orchestration et bridge historique optionnel
- [`docs/MASCARADE_BRIDGE.md`](docs/MASCARADE_BRIDGE.md) : articulation locale entre les depots
## 🚀 Conventions, contribution & cross-platform
> _RtFM : Parfois, le README résonne comme un drone, et tout le projet saccorde._
Toutes les conventions, instructions dinstallation, sécurité, multi-agents, conformité, workflows et support multi-plateforme (Docker inclus) sont synthétisées.
Architecture, étapes dinitialisation, fonctions clés, sécurité OpenClaw, contribution.
Contrat multi-repo:
- `crazy_life` publie la surface web/devops et le workflow editor.
- `Kill_LIFE` reste la source de verite pour `workflows/*.json`, le runtime, les evidence packs, le firmware, le CAD et la compliance.
- `mascarade` ne redevient pas la source canonique de release web; le bridge reste un mecanisme de sync seulement.
---
## CI et release
## ❓ FAQ
- `.github/workflows/ci.yml` porte le gate repo-local stable: bootstrap Python + `bash tools/test_python.sh --suite stable`.
- `.github/workflows/release_signing.yml` reste le workflow de release versionnee; il attend un tag `v*` ou un `workflow_dispatch` avec `release_tag` explicite.
- GitHub Pages n'est pas un gate canonique pour la release `Crazy Lane`; les workflows Pages de `Kill_LIFE` restent des surfaces secondaires docs/evidence.
**Q : Comment démarrer rapidement ?**
R : Suis la section « Installation & initialisation » ou le guide INSTALL.md.
## Licence
**Q : Comment installer tout automatiquement ?**
R : Utilise le script `install_kill_life.sh`.
**Q : Comment sécuriser OpenClaw ?**
R : Sandbox obligatoire, jamais daccè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.
**Q : Comment contribuer ?**
R : Ajoute des profils, améliore les scripts, enrichis les standards, et respecte la politique anti-injection.
**Q : Où trouver la documentation complète ?**
R : Voir [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. Lagent PM/Architecte génère le plan et larchitecture.
4. Lagent Firmware implémente le code dans `firmware/`.
5. Lagent 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. Lagent 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. Lagent Doc met à jour `docs/` et le README.
3. Lagent Conformité valide le profil et génère le rapport.
> _RtFM: Les agents QA écoutent le paysage du repo, à la recherche dun bug caché dans le souffle._
> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_
MIT. Voir [`licenses/MIT.txt`](licenses/MIT.txt).