truthmark 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,219 +2,193 @@
2
2
 
3
3
  **Vos agents écrivent du code. Truthmark maintient une documentation destinée aux humains et vérifiable dans Git.**
4
4
 
5
- [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
5
+ Truthmark installe des workflows natifs de Git qui permettent aux agents de codage IA de créer de nouveaux documents produit et d’ingénierie à partir du code et des tests existants, de les maintenir à jour après chaque changement de code et de vous remettre des diffs Markdown ordinaires à examiner.
6
6
 
7
- ![Bannière Truthmark](../assets/truthmark-banner.png)
7
+ [![npm version](https://img.shields.io/npm/v/truthmark?color=cb3837&label=npm)](https://www.npmjs.com/package/truthmark)
8
+ [![CI](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml)
9
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../../LICENSE)
10
+ [![Node.js >=24](https://img.shields.io/badge/node-%3E%3D24-339933?logo=node.js&logoColor=white)](../../package.json)
8
11
 
9
- ## 🚀 Démarrage rapide : exécution locale en cinq minutes
12
+ [Commencer](#démarrage-rapide-créez-votre-premier-document-de-vérité) · [Site web](https://merlinhu1.github.io/truthmark/) · [Guide d’utilisation](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md) · [GitHub](https://github.com/merlinhu1/truthmark)
10
13
 
11
- Exécutez ceci dans le dépôt Git que vous voulez faire gérer par Truthmark :
14
+ <details>
15
+ <summary>Lire ce README en 16 langues</summary>
12
16
 
13
- ```bash
14
- cd /path/to/your-repo
15
- npm install -g truthmark
16
- truthmark init
17
- truthmark check
18
- git diff
19
- ```
17
+ [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
20
18
 
21
- Dans un terminal interactif, `truthmark init` affiche une sélection multiple numérotée. Choisissez zéro ou plusieurs plateformes, ou `none` pour une installation neutre vis-à-vis des hôtes et limitée à la CLI.
19
+ </details>
22
20
 
23
- Pour les scripts et la CI, répétez `--platform` ; `--json` ne déclenche jamais d’invite :
21
+ ## Créez les premiers documents et gardez-les vrais
24
22
 
25
- ```bash
26
- truthmark init --platform codex --platform cursor
27
- truthmark init --json
28
- ```
23
+ La plupart des outils de documentation s’arrêtent après la génération. Truthmark offre aux agents un cycle de vie documentaire complet au sein de votre dépôt :
29
24
 
30
- Lors d’une première exécution non interactive sans `--platform`, l’installation reste neutre ; les exécutions suivantes conservent la sélection enregistrée dans `.truthmark/config.yml`.
25
+ - **Créer de nouveaux documents à partir d’un logiciel fonctionnel.** Truth Document lit le code et les tests, puis crée une documentation produit ou d’ingénierie au périmètre clairement défini.
26
+ - **Maintenir automatiquement l’alignement des documents.** Truth Sync s’exécute lors de la remise de l’agent après les changements de code fonctionnel et actualise la vérité du dépôt avant la fin du travail.
27
+ - **Transformer les documents en code.** Truth Realize implémente les documents de vérité approuvés tout en préservant un workflow propre, axé d’abord sur la documentation.
28
+ - **Réparer la propriété à mesure que le code grandit.** Truth Structure crée des routes au périmètre clair et des documents de démarrage pour les zones nouvelles ou surchargées.
29
+ - **Tout examiner dans Git.** Le code, les décisions, les contrats, l’architecture, les opérations et le comportement voyagent ensemble avec la branche.
31
30
 
32
- Essayez maintenant le chemin d’adoption le plus courant : documenter, à partir du code et des tests, un comportement existant. Dans votre hôte de codage IA, demandez au workflow installé :
31
+ Aucune base de connaissances hébergée. Aucune mémoire d’agent privée. Aucune documentation prisonnière de l’historique des discussions.
33
32
 
34
- ```text
35
- /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
36
- ```
33
+ ## Démarrage rapide : créez votre premier document de vérité
37
34
 
38
- Après cela, les utilisateurs ne devraient normalement pas invoquer Truth Sync directement. Continuez à coder dans votre hôte d’IA ; les instructions installées dans le dépôt indiquent à l’agent d’exécuter les tests pertinents et d’effectuer la revue Truth Sync avant la remise lorsqu’il y a des changements de code fonctionnel. Vous examinez le diff de code obtenu ainsi que le diff des documents de vérité.
35
+ **Prérequis :** Node.js 24 ou version ultérieure, un dépôt Git et un hôte de codage IA compatible avec les workflows d’agents.
39
36
 
40
- Si vous voulez seulement la validation CLI, choisissez `none` puis exécutez `truthmark check` ; vous pourrez relancer `truthmark init` plus tard pour sélectionner des plateformes.
37
+ Exécutez ces commandes dans le dépôt que Truthmark doit gérer :
41
38
 
42
- ## 💡 Le problème : l’écart de documentation avec l’IA
39
+ ```bash
40
+ cd /path/to/your-repo
41
+ npm install -g truthmark
42
+ truthmark init
43
+ ```
43
44
 
44
- Les agents de codage IA sont incroyablement efficaces pour écrire du code rapidement. Mais cette vitesse crée un nouveau mode de défaillance dangereux : **le récit du dépôt s’éloigne de la réalité.**
45
+ `truthmark init` vous permet de sélectionner Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, Cursor ou une configuration de l’interface en ligne de commande indépendante de l’hôte.
45
46
 
46
- * Les comportements se perdent dans des historiques de discussion éphémères.
47
- * Les documents d’architecture deviennent vite obsolètes.
48
- * Les décisions produit disparaissent après la remise.
49
- * Les réviseurs de code se retrouvent face à des diffs de code bruts sans comprendre le « pourquoi ».
50
- * Chaque nouvelle session IA est contrainte de redécouvrir la vérité de votre dépôt depuis zéro.
47
+ Demandez maintenant à votre agent configuré de documenter un comportement réel :
51
48
 
52
- ## 🎯 La solution : Truthmark
49
+ ```text
50
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
51
+ ```
53
52
 
54
- **Truthmark** installe dans votre dépôt une couche de workflow native Git. Il corrige la partie du développement avec l’IA qui casse généralement : aider la documentation à rester alignée sur le code.
53
+ Truth Document crée un nouveau document de vérité au périmètre clair s’il n’en existe pas, actualise le document propriétaire existant dans le cas contraire et met à jour le routage si nécessaire. Il ne modifie pas le code fonctionnel.
55
54
 
56
- Au lieu d’espérer que les humains et les agents IA se souviennent de mettre les docs à jour, Truthmark transforme la documentation en habitude systématique et vérifiable directement dans votre dépôt.
55
+ Examinez le résultat :
57
56
 
58
- ### ✨ Pourquoi Truthmark est unique
57
+ ```bash
58
+ truthmark check
59
+ git status --short --untracked-files=all
60
+ git diff
61
+ ```
59
62
 
60
- Truthmark n’est pas simplement un autre outil de documentation. Il est profondément intégré au workflow IA :
63
+ Vous devriez maintenant disposer de :
61
64
 
62
- * **🚫 Zéro dépendance fournisseur :** aucun service hébergé, aucune base de données cachée, aucun serveur supplémentaire à exploiter.
63
- * **🌳 100 % natif Git :** tout vit dans votre dépôt. La vérité se déplace avec votre branche.
64
- * **🤝 Contrat possédé par les humains, suivi par les agents :** Les mainteneurs possèdent le contrat du dépôt ; les agents suivent les instructions installées pendant qu’ils codent.
65
- * **✅ Confiance par la vérification :** le travail de l’IA devient plus facile à faire confiance, car tout travail qui change le comportement inclut une décision ou un diff de document de vérité vérifiable par un humain.
65
+ ```text
66
+ docs/truthmark/engineering/behaviors/session-timeout.md
67
+ docs/truthmark/routes/areas/authentication.md
68
+ ```
66
69
 
67
- ## 🔄 Fonctionnement
70
+ Les chemins exacts suivent la structure de propriété de votre dépôt. Les nouveaux fichiers apparaissent dans `git status` ; les modifications apportées aux fichiers suivis apparaissent dans `git diff`.
68
71
 
69
- Lorsquun agent IA modifie votre code, le travail n’est pas terminé. Truthmark installe une garde de workflow de fin de tâche que les agents suivent avant la remise :
72
+ Linvocation varie selon l’hôte. OpenCode utilise `/skill truthmark-document`, Antigravity utilise `@truthmark-document`, et les autres hôtes compatibles utilisent leur surface native de skill ou de commande slash. Consultez le [tableau des plateformes](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md#supported-agent-platforms) pour connaître les commandes exactes.
70
73
 
71
- 1. 💻 **Code :** l’agent modifie le code fonctionnel.
72
- 2. 🧪 **Test :** les tests pertinents sont exécutés.
73
- 3. 🔍 **Vérifier :** Truthmark vérifie la documentation mappée dans le cadre de la revue de fin installée.
74
- 4. 📝 **Documentation :** les docs sont mises à jour par l’agent lorsque la vérité du dépôt a changé.
75
- 5. 👀 **Revue :** un humain examine le *diff de code* + le *diff de vérité*.
74
+ Pour les scripts et l’intégration continue, transmettez explicitement les plateformes sélectionnées :
76
75
 
77
- ## 🛠 Comment vous utilisez Truthmark
76
+ ```bash
77
+ truthmark init --platform codex --platform cursor
78
+ truthmark init --json
79
+ ```
78
80
 
79
- Truthmark fournit un contrat local au dépôt, avec deux façons de l’utiliser.
81
+ Choisissez `none` en mode interactif ou exécutez `truthmark init --clear-platforms` pour obtenir un dépôt indépendant de l’hôte. Vous pourrez ajouter des plateformes d’agents plus tard en relançant `truthmark init`.
80
82
 
81
- ### Les humains installent et valident le contrat
83
+ Pour les diagnostics de fraîcheur relatifs à une branche, transmettez une base Git :
82
84
 
83
- Les mainteneurs et la CI utilisent la CLI :
85
+ ```bash
86
+ truthmark check --base <base-ref>
87
+ ```
84
88
 
85
- * `truthmark init` - crée ou actualise la configuration, permet de choisir zéro ou plusieurs plateformes et installe le routage, les échafaudages de documents de vérité et les instructions des hôtes sélectionnés.
86
- * `truthmark check` - valide la vérité du dépôt depuis le terminal.
89
+ ## Fonctionnement de Truthmark
87
90
 
88
- ### Les agents suivent le contrat pendant qu’ils codent
91
+ <picture>
92
+ <source media="(max-width: 700px)" srcset="../assets/truthmark-workflow-mobile.svg">
93
+ <img src="../assets/truthmark-workflow.svg" alt="Fonctionnement de Truthmark" width="1440">
94
+ </picture>
89
95
 
90
- Truthmark installe des instructions locales au dépôt pour les hôtes de codage IA pris en charge, comme Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity et Cursor.
96
+ L’interface en ligne de commande Truthmark installe et valide le contrat du dépôt. Votre agent de codage effectue l’examen des preuves et le travail documentaire via les workflows natifs de l’hôte qui ont été installés.
91
97
 
92
- La boucle normale est simple :
98
+ Un changement de code normal suit une boucle simple :
93
99
 
94
- 1. Demandez à votre agent de modifier du code ou de documenter un comportement existant.
95
- 2. Les instructions installées indiquent à l’agent quand tester, quand mettre à jour les documents de vérité et quand s’arrêter pour une revue humaine.
96
- 3. Vous relisez des diffs Git ordinaires : le code plus les éventuels changements de documents de vérité.
100
+ 1. L’agent modifie le code fonctionnel.
101
+ 2. Les tests pertinents sont exécutés.
102
+ 3. Truth Sync vérifie la documentation mappée.
103
+ 4. Lorsque la vérité du dépôt a changé, l’agent crée ou actualise les documents et le routage.
104
+ 5. Vous examinez ensemble le diff de code et le diff de vérité.
97
105
 
98
- Les demandes agent lancées par l’utilisateur restent volontairement peu nombreuses :
106
+ ## Workflows
99
107
 
100
- * `/truthmark-document` - documente un comportement implémenté existant à partir du code et des tests.
101
- * `/truthmark-realize` - implémente le code à partir de documents de vérité existants.
102
- * `/truthmark-check` - audite la vérité du dépôt.
108
+ | Workflow | Quand l’utiliser | Résultat |
109
+ | -------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
110
+ | **Truth Document** | Du code existant doit être documenté | Crée ou actualise des documents produit et d’ingénierie fondés sur des preuves |
111
+ | **Truth Sync** | Du code fonctionnel a changé | Maintient l’alignement des documents mappés et du routage avant la remise |
112
+ | **Truth Structure** | Une nouvelle zone doit avoir un propriétaire ou les documents existants sont trop larges | Crée des routes au périmètre clair et des documents de démarrage sous forme de structure |
113
+ | **Truth Realize** | Un document de vérité approuvé doit devenir un logiciel fonctionnel | Actualise le code fonctionnel à partir de la documentation |
114
+ | **Truth Check** | La vérité du dépôt doit être auditée | Signale les problèmes de routage, de propriété, de preuves et de documentation |
115
+ | **Truthmark Portal** | L’équipe veut un site documentaire consultable | Génère une présentation HTML statique commitée à partir des documents de vérité Markdown |
103
116
 
104
- Truth Sync n’est pas la façon habituelle de commencer un travail ; c’est la revue de fin après des changements de code fonctionnel.
105
- Truth Structure n’est pas une commande quotidienne ; elle répare le routage ou la propriété uniquement lorsque cela bloque le travail.
117
+ Truthmark installe ces workflows sous forme de surfaces natives au dépôt pour Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity et Cursor.
106
118
 
107
119
  ## Ce que vous obtenez
108
120
 
109
- | Capacité | Ce qu’elle fait |
110
- | --- | --- |
111
- | Vérité native Git | Conserve la vérité du dépôt dans du Markdown et de la configuration commités. |
112
- | Documentation limitée à la branche | La vérité se déplace avec la branche au lieu de vivre dans une session privée. |
113
- | CLI humaine | Fournit aux mainteneurs des commandes de configuration, d’actualisation, de validation et d’inspection. |
114
- | Guidance agent installée | Indique aux agents de codage quand documenter, tester, synchroniser la vérité, auditer ou s’arrêter pour revue. |
115
- | Routage explicite | Mappe les zones de code vers des documents de vérité canoniques. |
116
- | Remises vérifiables | Produit des diffs Git ordinaires pour le code comme pour les documents de vérité. |
117
- | Fonctionnement local d’abord | Ne nécessite aucun service hébergé, démon, base de données ni serveur MCP. |
118
- | Limites d’écriture plus sûres | Sépare les workflows code-first, doc-first, read-only et doc-only. |
119
- | Validation | Signale les problèmes de routage, d’autorité, de frontmatter, de liens, de surfaces générées, de portée de branche, de fraîcheur et de couverture. |
120
- | Portal optionnel | Génère, lorsqu’il est explicitement activé et demandé, un site de présentation HTML statique commité à partir des documents de vérité Markdown. |
121
+ ### Une documentation qui part de la réalité
121
122
 
122
- ## Aperçu visuel
123
+ Truthmark peut créer de la documentation pour les capacités produit, le comportement de l’implémentation, les interfaces de programmation d’applications, l’architecture, les workflows, les opérations et les tests. Le code et les tests fournissent les preuves ; des documents Markdown au périmètre clair préservent le résultat.
123
124
 
124
- ![Fonctionnalités Truthmark](../assets/truthmark-features.png)
125
+ ### Une documentation qui survit au prochain changement
125
126
 
126
- **Fonctionnalités :** ce que Truthmark installe et comment les agents utilisent les instructions locales au dépôt.
127
+ Les routes relient les zones de code aux documents canoniques. Lorsque les agents modifient un comportement, Truth Sync sait où placer la vérité correspondante et maintient une remise vérifiable.
127
128
 
128
- ![Position de Truthmark](../assets/truthmark-position.png)
129
+ ### La vérité produit et la vérité d’ingénierie dans des voies distinctes
129
130
 
130
- **Position :** Truthmark se situe par rapport aux prompts, à la mémoire et aux workflows de spécification.
131
+ La vérité produit consigne les promesses destinées aux utilisateurs, les limites, les décisions et les critères d’acceptation. La vérité d’ingénierie consigne le comportement actuel, les contrats, l’architecture, les workflows, les opérations et le comportement des tests.
131
132
 
132
- ![Flux de synchronisation Truthmark](../assets/truthmark-syncflow.png)
133
+ ### Collaboration native de Git
133
134
 
134
- **Flux de synchronisation :** comment Truth Sync conclut les changements de code ordinaires avant la remise.
135
+ Tout ce qui compte réside dans des fichiers commités dans le dépôt. La vérité suit la branche, fonctionne avec les pull requests ordinaires et reste visible pour chaque mainteneur et chaque agent de codage.
135
136
 
136
- ## Pourquoi les équipes ladoptent
137
+ ### Fonctionnement local dabord
137
138
 
138
- Truthmark s’adresse aux équipes qui savent déjà que les agents IA peuvent générer du code.
139
+ Truthmark ne nécessite ni service hébergé, ni démon, ni base de données, ni magasin vectoriel, ni serveur Model Context Protocol. Le dépôt transporte son propre workflow documentaire.
139
140
 
140
- Le prochain problème est la gouvernance.
141
+ ## La place de Truthmark
141
142
 
142
- Pas la gouvernance comme cérémonie. La gouvernance comme une question simple :
143
+ | Besoin | Meilleur choix |
144
+ | ---------------------------------------------------------- | ------------------------- |
145
+ | Obtenir un meilleur résultat d’une seule session d’agent | Meilleur prompt |
146
+ | Continuité personnelle ou au niveau de la session | Outil de mémoire |
147
+ | Travail fonctionnel axé d’abord sur la planification | Workflow de spécification |
148
+ | Documentation limitée à la branche qui voyage avec le code | **Truthmark** |
149
+ | Exactitude du comportement | Tests et revue de code |
150
+ | Documentation assistée par l’IA et vérifiable | **Truthmark + revue Git** |
143
151
 
144
- > Après ce changement assisté par l’IA, le dépôt dit-il encore la vérité ?
152
+ Truthmark est conçu pour les mainteneurs et les équipes dingénierie qui utilisent déjà des agents de codage IA et veulent que le dépôt continue à dire la vérité aussi vite que le code évolue.
145
153
 
146
- Truthmark aide les équipes à y répondre avec des fichiers commités, un routage explicite et des diffs vérifiables.
154
+ ## Hôtes compatibles et ligne de commande
147
155
 
148
- Il est utile lorsque vous avez besoin de :
156
+ Hôtes d’agents compatibles :
149
157
 
150
- - moins de dérive documentaire
151
- - meilleures remises
152
- - vérité produit spécifique à la branche
153
- - documentation d’architecture et d’API durable
154
- - propriété explicite entre docs et code
155
- - limites d’écriture d’agents plus sûres
156
- - documentation vérifiable plutôt que mémoire cachée
157
- - une guidance agent qui fonctionne toujours depuis des fichiers commités dans le dépôt
158
+ - Codex
159
+ - Claude Code
160
+ - GitHub Copilot
161
+ - OpenCode
162
+ - Antigravity
163
+ - Cursor
158
164
 
159
- ## Où Truthmark se situe
165
+ <details>
166
+ <summary>Référence de la ligne de commande</summary>
160
167
 
161
- Truthmark ne remplace pas les prompts, la mémoire, les spécifications, les tests ni la revue de code.
168
+ | Commande | Objectif |
169
+ | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
170
+ | `truthmark init` | Créer ou actualiser la configuration, le routage, les modèles et les workflows des hôtes sélectionnés |
171
+ | `truthmark check [--base <ref>]` | Valider la vérité du dépôt et, facultativement, exécuter les diagnostics de fraîcheur de la branche |
172
+ | `truthmark index --json` | Examiner les métadonnées dérivées du dépôt et du routage |
173
+ | `truthmark impact --base <ref> --json` | Mapper les fichiers modifiés vers les documents, les propriétaires et les tests proches |
174
+ | `truthmark workflow status --workflow <id> [--base <ref>] --json` | Examiner l’applicabilité et les cibles du workflow |
175
+ | `truthmark validate ...` | Valider les rapports de workflow et les baux d’écriture |
176
+ | `truthmark uninstall --dry-run` / `truthmark uninstall --apply` | Prévisualiser ou supprimer les surfaces d’hôtes générées tout en préservant la vérité rédigée |
162
177
 
163
- Il donne à ces workflows un endroit durable atterrir dans Git.
178
+ Une sortie JSON structurée est disponible dans toute l’interface en ligne de commande pour les scripts et l’intégration continue.
164
179
 
165
- | Besoin | Meilleur choix |
166
- | --- | --- |
167
- | Meilleure sortie d’une session d’agent | Meilleur prompt |
168
- | Continuité personnelle ou au niveau de la session | Outil de mémoire |
169
- | Travail fonctionnel planifié d’abord | Workflow de spécification |
170
- | Vérité limitée à une branche qui voyage avec le code | Truthmark |
171
- | Validation de la correction du comportement | Tests et revue |
172
- | Revue de changements de documentation assistés par l’IA | Truthmark plus revue Git |
180
+ </details>
173
181
 
174
- Le périmètre de Truthmark est étroit par conception :
175
-
176
- ```text
177
- make repository truth explicit
178
- route it to code
179
- installer une guidance agent autour d’elle
180
- keep the result reviewable in Git
181
- ```
182
+ ## En savoir plus
182
183
 
183
- ## Aller plus loin
184
+ - [Guide d’utilisation de Truthmark](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md)
185
+ - [Index de la documentation](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
186
+ - [Vue d’ensemble de l’architecture](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
187
+ - [Contrats de configuration, de routage et de commande](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
188
+ - [Contribuer](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
184
189
 
185
- Le README est la vitrine : contexte rapide, démarrage rapide et modèle mental central.
186
-
187
- Pour l’utilisation commande par commande, les comparaisons de surfaces, les détails des plateformes prises en charge, la configuration, le routage, Portal et des exemples, lisez le [guide d’utilisation Truthmark](../user-guide.md).
188
-
189
- ## État du projet
190
-
191
- La version actuelle fournit :
192
-
193
- - des commandes CLI locales pour init, check, index, impact et l’état des workflows
194
- - instructions agent locales au dépôt générées pour Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity et Cursor
195
- - des diagnostics de routage, d’autorité, de frontmatter, de liens, de fraîcheur, de surfaces générées, de portée de branche et de couverture
196
- - des documents de vérité limités à la branche et des artefacts dérivés d’intelligence du dépôt
197
-
198
- ## Documentation
199
-
200
- - [Guide d’utilisation](../user-guide.md)
201
- - [Index des docs](../README.md)
202
- - [Vue d’ensemble de l’architecture](../truthmark/engineering/architecture/overview.md)
203
- - [Contrats API et CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
204
- - [Guide de maintenance de la vérité du dépôt](../standards/maintaining-repository-truth.md)
205
-
206
- Pour les commandes de développement local et de contribution, consultez [CONTRIBUTING.md](../../CONTRIBUTING.md).
207
-
208
- ## Limites de conception
209
-
210
- Truthmark est volontairement petit : local, commité, limité à la branche et vérifiable.
211
-
212
- Ce n’est pas un service hébergé, un serveur MCP, une base de données vectorielle, une couche de mémoire cachée, un produit d’application CI ni un moteur autonome de réécriture de code. Il aide la vérité du dépôt à rester visible ; il ne remplace pas les tests, la revue de code ni le jugement humain.
190
+ **Installez Truthmark, sélectionnez votre hôte de codage et transformez dès aujourd’hui un comportement réel en documentation.**
213
191
 
214
192
  ## Licence
215
193
 
216
194
  MIT. Voir [LICENSE](../../LICENSE).
217
-
218
- ## Suppression sûre
219
-
220
- Utilisez `truthmark uninstall --dry-run` pour examiner précisément les surfaces hôtes générées, puis `truthmark uninstall --apply` pour les supprimer. Les truth rédigées, la configuration, les templates, la sortie Portal, les fichiers Gemini et les fichiers utilisateur non liés sont conservés ; supprimez séparément une installation npm globale avec votre gestionnaire de paquets.