truthmark 2.2.3 → 2.2.5

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.
@@ -0,0 +1,225 @@
1
+ # Truthmark
2
+
3
+ **Vos agents écrivent du code. Truthmark maintient une documentation destinée aux humains et vérifiable dans Git.**
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)
6
+
7
+ ![Bannière Truthmark](../assets/truthmark-banner.png)
8
+
9
+ ## 🚀 Démarrage rapide : exécution locale en cinq minutes
10
+
11
+ Exécutez ceci dans le dépôt Git que vous voulez faire gérer par Truthmark :
12
+
13
+ ```bash
14
+ cd /path/to/your-repo
15
+ npm install -g truthmark
16
+ truthmark config
17
+ ```
18
+
19
+ Activez l’hôte d’IA que vous utilisez réellement. Les nouvelles configurations sont neutres vis-à-vis des hôtes ; ajoutez donc une liste `platforms` de premier niveau à `.truthmark/config.yml` avant l’initialisation :
20
+
21
+ ```yaml
22
+ version: 2
23
+ platforms:
24
+ - codex # or: claude-code, github-copilot, opencode, antigravity, cursor
25
+ truthmark:
26
+ workspace: docs/truthmark
27
+ generated:
28
+ portal:
29
+ enabled: false
30
+ ```
31
+
32
+ Installez ensuite les documents de vérité locaux au dépôt, le routage et les surfaces de workflow pour agents :
33
+
34
+ ```bash
35
+ truthmark init
36
+ truthmark check
37
+ git diff
38
+ ```
39
+
40
+ 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é :
41
+
42
+ ```text
43
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
44
+ ```
45
+
46
+ 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é.
47
+
48
+ Si vous voulez seulement la validation CLI et ne voulez pas encore de workflows IA propres à un hôte, laissez `platforms` omis et exécutez `truthmark init && truthmark check` ; vous pourrez ajouter une plateforme plus tard et relancer `truthmark init`.
49
+
50
+ ## 💡 Le problème : l’écart de documentation avec l’IA
51
+
52
+ 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é.**
53
+
54
+ * Les comportements se perdent dans des historiques de discussion éphémères.
55
+ * Les documents d’architecture deviennent vite obsolètes.
56
+ * Les décisions produit disparaissent après la remise.
57
+ * Les réviseurs de code se retrouvent face à des diffs de code bruts sans comprendre le « pourquoi ».
58
+ * Chaque nouvelle session IA est contrainte de redécouvrir la vérité de votre dépôt depuis zéro.
59
+
60
+ ## 🎯 La solution : Truthmark
61
+
62
+ **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.
63
+
64
+ 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.
65
+
66
+ ### ✨ Pourquoi Truthmark est unique
67
+
68
+ Truthmark n’est pas simplement un autre outil de documentation. Il est profondément intégré au workflow IA :
69
+
70
+ * **🚫 Zéro dépendance fournisseur :** aucun service hébergé, aucune base de données cachée, aucun serveur supplémentaire à exploiter.
71
+ * **🌳 100 % natif Git :** tout vit dans votre dépôt. La vérité se déplace avec votre branche.
72
+ * **🤝 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.
73
+ * **✅ 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.
74
+
75
+ ## 🔄 Fonctionnement
76
+
77
+ Lorsqu’un 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 :
78
+
79
+ 1. 💻 **Code :** l’agent modifie le code fonctionnel.
80
+ 2. 🧪 **Test :** les tests pertinents sont exécutés.
81
+ 3. 🔍 **Vérifier :** Truthmark vérifie la documentation mappée dans le cadre de la revue de fin installée.
82
+ 4. 📝 **Documentation :** les docs sont mises à jour par l’agent lorsque la vérité du dépôt a changé.
83
+ 5. 👀 **Revue :** un humain examine le *diff de code* + le *diff de vérité*.
84
+
85
+ ## 🛠 Comment vous utilisez Truthmark
86
+
87
+ Truthmark fournit un contrat local au dépôt, avec deux façons de l’utiliser.
88
+
89
+ ### Les humains installent et valident le contrat
90
+
91
+ Les mainteneurs et la CI utilisent la CLI :
92
+
93
+ * `truthmark config` - crée la configuration initiale.
94
+ * `truthmark init` - installe ou actualise le routage, les échafaudages de documents de vérité et les instructions pour les hôtes IA.
95
+ * `truthmark check` - valide la vérité du dépôt depuis le terminal.
96
+
97
+ ### Les agents suivent le contrat pendant qu’ils codent
98
+
99
+ 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.
100
+
101
+ La boucle normale est simple :
102
+
103
+ 1. Demandez à votre agent de modifier du code ou de documenter un comportement existant.
104
+ 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.
105
+ 3. Vous relisez des diffs Git ordinaires : le code plus les éventuels changements de documents de vérité.
106
+
107
+ Les demandes agent lancées par l’utilisateur restent volontairement peu nombreuses :
108
+
109
+ * `/truthmark-document` - documente un comportement implémenté existant à partir du code et des tests.
110
+ * `/truthmark-realize` - implémente le code à partir de documents de vérité existants.
111
+ * `/truthmark-check` - audite la vérité du dépôt.
112
+
113
+ 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.
114
+ Truth Structure n’est pas une commande quotidienne ; elle répare le routage ou la propriété uniquement lorsque cela bloque le travail.
115
+
116
+ ## Ce que vous obtenez
117
+
118
+ | Capacité | Ce qu’elle fait |
119
+ | --- | --- |
120
+ | Vérité native Git | Conserve la vérité du dépôt dans du Markdown et de la configuration commités. |
121
+ | Documentation limitée à la branche | La vérité se déplace avec la branche au lieu de vivre dans une session privée. |
122
+ | CLI humaine | Fournit aux mainteneurs des commandes de configuration, d’actualisation, de validation et d’inspection. |
123
+ | Guidance agent installée | Indique aux agents de codage quand documenter, tester, synchroniser la vérité, auditer ou s’arrêter pour revue. |
124
+ | Routage explicite | Mappe les zones de code vers des documents de vérité canoniques. |
125
+ | Remises vérifiables | Produit des diffs Git ordinaires pour le code comme pour les documents de vérité. |
126
+ | Fonctionnement local d’abord | Ne nécessite aucun service hébergé, démon, base de données ni serveur MCP. |
127
+ | Limites d’écriture plus sûres | Sépare les workflows code-first, doc-first, read-only et doc-only. |
128
+ | 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. |
129
+ | 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. |
130
+
131
+ ## Aperçu visuel
132
+
133
+ ![Fonctionnalités Truthmark](../assets/truthmark-features.png)
134
+
135
+ **Fonctionnalités :** ce que Truthmark installe et comment les agents utilisent les instructions locales au dépôt.
136
+
137
+ ![Position de Truthmark](../assets/truthmark-position.png)
138
+
139
+ **Position :** où Truthmark se situe par rapport aux prompts, à la mémoire et aux workflows de spécification.
140
+
141
+ ![Flux de synchronisation Truthmark](../assets/truthmark-syncflow.png)
142
+
143
+ **Flux de synchronisation :** comment Truth Sync conclut les changements de code ordinaires avant la remise.
144
+
145
+ ## Pourquoi les équipes l’adoptent
146
+
147
+ Truthmark s’adresse aux équipes qui savent déjà que les agents IA peuvent générer du code.
148
+
149
+ Le prochain problème est la gouvernance.
150
+
151
+ Pas la gouvernance comme cérémonie. La gouvernance comme une question simple :
152
+
153
+ > Après ce changement assisté par l’IA, le dépôt dit-il encore la vérité ?
154
+
155
+ Truthmark aide les équipes à y répondre avec des fichiers commités, un routage explicite et des diffs vérifiables.
156
+
157
+ Il est utile lorsque vous avez besoin de :
158
+
159
+ - moins de dérive documentaire
160
+ - meilleures remises
161
+ - vérité produit spécifique à la branche
162
+ - documentation d’architecture et d’API durable
163
+ - propriété explicite entre docs et code
164
+ - limites d’écriture d’agents plus sûres
165
+ - documentation vérifiable plutôt que mémoire cachée
166
+ - une guidance agent qui fonctionne toujours depuis des fichiers commités dans le dépôt
167
+
168
+ ## Où Truthmark se situe
169
+
170
+ Truthmark ne remplace pas les prompts, la mémoire, les spécifications, les tests ni la revue de code.
171
+
172
+ Il donne à ces workflows un endroit durable où atterrir dans Git.
173
+
174
+ | Besoin | Meilleur choix |
175
+ | --- | --- |
176
+ | Meilleure sortie d’une session d’agent | Meilleur prompt |
177
+ | Continuité personnelle ou au niveau de la session | Outil de mémoire |
178
+ | Travail fonctionnel planifié d’abord | Workflow de spécification |
179
+ | Vérité limitée à une branche qui voyage avec le code | Truthmark |
180
+ | Validation de la correction du comportement | Tests et revue |
181
+ | Revue de changements de documentation assistés par l’IA | Truthmark plus revue Git |
182
+
183
+ Le périmètre de Truthmark est étroit par conception :
184
+
185
+ ```text
186
+ make repository truth explicit
187
+ route it to code
188
+ installer une guidance agent autour d’elle
189
+ keep the result reviewable in Git
190
+ ```
191
+
192
+ ## Aller plus loin
193
+
194
+ Le README est la vitrine : contexte rapide, démarrage rapide et modèle mental central.
195
+
196
+ 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).
197
+
198
+ ## État du projet
199
+
200
+ La version actuelle fournit :
201
+
202
+ - des commandes CLI locales pour config, init, check, index, impact et l’état des workflows
203
+ - instructions agent locales au dépôt générées pour Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity et Cursor
204
+ - 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
205
+ - des documents de vérité limités à la branche et des artefacts dérivés d’intelligence du dépôt
206
+
207
+ ## Documentation
208
+
209
+ - [Guide d’utilisation](../user-guide.md)
210
+ - [Index des docs](../README.md)
211
+ - [Vue d’ensemble de l’architecture](../truthmark/engineering/architecture/overview.md)
212
+ - [Contrats API et CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
213
+ - [Guide de maintenance de la vérité du dépôt](../standards/maintaining-repository-truth.md)
214
+
215
+ Pour les commandes de développement local et de contribution, consultez [CONTRIBUTING.md](../../CONTRIBUTING.md).
216
+
217
+ ## Limites de conception
218
+
219
+ Truthmark est volontairement petit : local, commité, limité à la branche et vérifiable.
220
+
221
+ 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.
222
+
223
+ ## Licence
224
+
225
+ MIT. Voir [LICENSE](../../LICENSE).
@@ -0,0 +1,225 @@
1
+ # Truthmark
2
+
3
+ **Agen Anda menulis kode. Truthmark memelihara dokumentasi yang ditujukan untuk manusia dan dapat ditinjau melalui Git.**
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)
6
+
7
+ ![Banner Truthmark](../assets/truthmark-banner.png)
8
+
9
+ ## 🚀 Mulai cepat: berjalan lokal dalam lima menit
10
+
11
+ Jalankan ini di dalam repositori Git yang ingin Anda kelola dengan Truthmark:
12
+
13
+ ```bash
14
+ cd /path/to/your-repo
15
+ npm install -g truthmark
16
+ truthmark config
17
+ ```
18
+
19
+ Aktifkan host AI yang benar-benar Anda gunakan. Konfigurasi baru bersifat netral terhadap host, jadi tambahkan daftar `platforms` tingkat atas ke `.truthmark/config.yml` sebelum inisialisasi:
20
+
21
+ ```yaml
22
+ version: 2
23
+ platforms:
24
+ - codex # or: claude-code, github-copilot, opencode, antigravity, cursor
25
+ truthmark:
26
+ workspace: docs/truthmark
27
+ generated:
28
+ portal:
29
+ enabled: false
30
+ ```
31
+
32
+ Kemudian pasang dokumen kebenaran lokal repositori, perutean, dan permukaan alur kerja agen:
33
+
34
+ ```bash
35
+ truthmark init
36
+ truthmark check
37
+ git diff
38
+ ```
39
+
40
+ Sekarang coba jalur adopsi yang paling umum: dokumentasikan satu perilaku yang sudah ada dari kode dan pengujian. Di host pengodean AI Anda, minta alur kerja yang terpasang:
41
+
42
+ ```text
43
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
44
+ ```
45
+
46
+ Setelah itu, pengguna biasanya tidak perlu memanggil Truth Sync secara langsung. Teruslah membuat kode melalui host AI Anda; instruksi repositori yang terpasang memberi tahu agen untuk menjalankan pengujian yang relevan dan melakukan tinjauan Truth Sync sebelum serah terima ketika kode fungsional berubah. Anda meninjau diff kode yang dihasilkan beserta diff dokumen truth.
47
+
48
+ Jika Anda hanya menginginkan validasi CLI dan belum menginginkan alur kerja AI khusus host, biarkan `platforms` tidak dicantumkan dan jalankan `truthmark init && truthmark check`; Anda dapat menambahkan platform nanti dan menjalankan ulang `truthmark init`.
49
+
50
+ ## 💡 Masalah: kesenjangan dokumentasi AI
51
+
52
+ Agen pengodean AI luar biasa dalam menulis kode dengan cepat. Namun kecepatan ini menciptakan mode kegagalan baru yang berbahaya: **cerita repositori menyimpang dari kenyataan.**
53
+
54
+ * Perilaku hilang dalam riwayat chat yang sementara.
55
+ * Dokumen arsitektur cepat tertinggal.
56
+ * Keputusan produk lenyap setelah serah terima.
57
+ * Peninjau kode dibiarkan memeriksa diff kode mentah tanpa memahami "mengapa".
58
+ * Setiap sesi AI baru dipaksa menemukan ulang kebenaran repositori Anda dari awal.
59
+
60
+ ## 🎯 Solusi: Truthmark
61
+
62
+ **Truthmark** memasang lapisan alur kerja native Git ke dalam repositori Anda. Ini memperbaiki bagian pengembangan AI yang biasanya rusak: membantu dokumentasi tetap selaras dengan kode.
63
+
64
+ Alih-alih berharap manusia dan agen AI ingat memperbarui dokumen, Truthmark menjadikan dokumentasi sebagai kebiasaan sistematis dan dapat ditinjau langsung di dalam repositori Anda.
65
+
66
+ ### ✨ Mengapa Truthmark unik
67
+
68
+ Truthmark bukan sekadar alat dokumentasi lain. Ia terintegrasi mendalam ke dalam alur kerja AI:
69
+
70
+ * **🚫 Tanpa ketergantungan vendor:** Tidak ada layanan ter-host, tidak ada basis data tersembunyi, tidak ada server tambahan untuk dioperasikan.
71
+ * **🌳 100% native Git:** Semuanya hidup di repositori Anda. Kebenaran bergerak bersama branch Anda.
72
+ * **🤝 Kontrak yang dimiliki manusia dan diikuti agen:** Pemelihara memiliki kontrak repositori; agen mengikuti instruksi yang terpasang saat membuat kode.
73
+ * **✅ Kepercayaan melalui verifikasi:** Pekerjaan AI menjadi lebih mudah dipercaya karena pekerjaan yang mengubah perilaku menyertakan keputusan atau diff dokumen kebenaran yang dapat ditinjau manusia.
74
+
75
+ ## 🔄 Cara kerjanya
76
+
77
+ Ketika agen AI memodifikasi kode Anda, pekerjaannya belum selesai. Truthmark memasang penjaga alur kerja saat penyelesaian yang diikuti agen sebelum serah terima:
78
+
79
+ 1. 💻 **Kode:** Agen memodifikasi kode fungsional.
80
+ 2. 🧪 **Uji:** Pengujian yang relevan dijalankan.
81
+ 3. 🔍 **Periksa:** Truthmark memeriksa dokumentasi yang dipetakan sebagai bagian dari tinjauan akhir yang terpasang.
82
+ 4. 📝 **Dokumentasikan:** Dokumen diperbarui oleh agen ketika kebenaran repositori berubah.
83
+ 5. 👀 **Tinjau:** Manusia meninjau *diff kode* + *diff kebenaran*.
84
+
85
+ ## 🛠 Cara Anda berinteraksi dengan Truthmark
86
+
87
+ Truthmark memiliki satu kontrak lokal repositori dengan dua cara pemakaian.
88
+
89
+ ### Manusia memasang dan memvalidasi kontrak
90
+
91
+ Pemelihara dan CI menggunakan CLI:
92
+
93
+ * `truthmark config` - membuat konfigurasi awal.
94
+ * `truthmark init` - memasang atau menyegarkan perutean, scaffold dokumen kebenaran, dan instruksi host AI.
95
+ * `truthmark check` - memvalidasi kebenaran repositori dari terminal.
96
+
97
+ ### Agen mengikuti kontrak saat membuat kode
98
+
99
+ Truthmark memasang instruksi lokal repositori untuk host pengodean AI yang didukung seperti Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, dan Cursor.
100
+
101
+ Alur normalnya sederhana:
102
+
103
+ 1. Minta agen Anda melakukan perubahan kode, atau minta ia mendokumentasikan perilaku yang sudah ada.
104
+ 2. Instruksi yang terpasang memberi tahu agen kapan harus menguji, kapan memperbarui dokumen kebenaran, dan kapan berhenti untuk tinjauan manusia.
105
+ 3. Anda meninjau diff Git biasa: kode plus perubahan dokumen kebenaran apa pun.
106
+
107
+ Permintaan agen yang dimulai pengguna sengaja dibuat sedikit:
108
+
109
+ * `/truthmark-document` - mendokumentasikan perilaku terimplementasi yang sudah ada dari kode dan pengujian.
110
+ * `/truthmark-realize` - mengimplementasikan kode dari dokumen kebenaran yang sudah ada.
111
+ * `/truthmark-check` - mengaudit kebenaran repositori.
112
+
113
+ Truth Sync bukan cara biasa untuk memulai pekerjaan; itu adalah tinjauan akhir setelah perubahan kode fungsional.
114
+ Truth Structure bukan perintah harian; ia memperbaiki perutean atau kepemilikan hanya ketika hal itu memblokir pekerjaan.
115
+
116
+ ## Yang Anda dapatkan
117
+
118
+ | Kapabilitas | Apa yang dilakukan |
119
+ | --- | --- |
120
+ | Kebenaran native Git | Menyimpan kebenaran repositori dalam Markdown dan konfigurasi yang di-commit. |
121
+ | Dokumentasi berlingkup branch | Kebenaran bergerak bersama branch alih-alih hidup dalam sesi privat. |
122
+ | CLI manusia | Memberi pemelihara perintah penyiapan, penyegaran, validasi, dan inspeksi. |
123
+ | Kontrak agen terpasang | Memberi agen panduan native host untuk dokumentasi, realisasi, audit, sinkronisasi akhir, dan perbaikan perutean terbatas. |
124
+ | Perutean eksplisit | Memetakan area kode ke dokumen kebenaran kanonis. |
125
+ | Serah terima yang dapat ditinjau | Menghasilkan diff Git biasa untuk kode maupun dokumen kebenaran. |
126
+ | Operasi lokal terlebih dahulu | Tidak membutuhkan layanan ter-host, daemon, basis data, atau server MCP. |
127
+ | Batas tulis yang lebih aman | Memisahkan alur kerja code-first, doc-first, read-only, dan doc-only. |
128
+ | Validasi | Melaporkan masalah perutean, otoritas, frontmatter, tautan, permukaan yang dihasilkan, cakupan branch, kesegaran, dan coverage. |
129
+ | Portal opsional | Menghasilkan situs presentasi HTML statis yang di-commit dari dokumen kebenaran Markdown ketika diaktifkan dan diminta secara eksplisit. |
130
+
131
+ ## Gambaran visual
132
+
133
+ ![Fitur Truthmark](../assets/truthmark-features.png)
134
+
135
+ **Fitur:** apa yang dipasang Truthmark dan bagaimana permukaan alur kerja dibagi.
136
+
137
+ ![Posisi Truthmark](../assets/truthmark-position.png)
138
+
139
+ **Posisi:** di mana Truthmark berada relatif terhadap prompt, memori, dan alur kerja spesifikasi.
140
+
141
+ ![Alur sinkronisasi Truthmark](../assets/truthmark-syncflow.png)
142
+
143
+ **Alur sinkronisasi:** bagaimana Truth Sync menutup perubahan kode normal sebelum serah terima.
144
+
145
+ ## Mengapa tim mengadopsinya
146
+
147
+ Truthmark ditujukan untuk tim yang sudah tahu bahwa agen AI dapat menghasilkan kode.
148
+
149
+ Masalah berikutnya adalah tata kelola.
150
+
151
+ Bukan tata kelola sebagai seremoni. Tata kelola sebagai pertanyaan sederhana:
152
+
153
+ > Setelah perubahan berbantuan AI ini, apakah repositori masih mengatakan kebenaran?
154
+
155
+ Truthmark membantu tim menjawabnya dengan file yang di-commit, perutean eksplisit, dan diff yang dapat ditinjau.
156
+
157
+ Ini berguna saat Anda membutuhkan:
158
+
159
+ - penyimpangan dokumentasi yang lebih kecil
160
+ - serah terima yang lebih baik
161
+ - kebenaran produk khusus branch
162
+ - dokumentasi arsitektur dan API yang tahan lama
163
+ - kepemilikan eksplisit antara dokumen dan kode
164
+ - batas tulis agen yang lebih aman
165
+ - dokumentasi yang dapat ditinjau alih-alih memori tersembunyi
166
+ - alur kerja AI yang tetap bekerja dari file repositori yang di-commit
167
+
168
+ ## Di mana Truthmark cocok
169
+
170
+ Truthmark tidak menggantikan prompt, memori, spesifikasi, pengujian, atau tinjauan kode.
171
+
172
+ Ia memberi alur kerja tersebut tempat yang tahan lama untuk mendarat di Git.
173
+
174
+ | Kebutuhan | Lebih cocok |
175
+ | --- | --- |
176
+ | Output lebih baik dari satu sesi agen | Prompt yang lebih baik |
177
+ | Kontinuitas pribadi atau tingkat sesi | Alat memori |
178
+ | Pekerjaan fitur yang dimulai dengan rencana | Alur kerja spesifikasi |
179
+ | Truth berlingkup branch yang ikut bersama kode | Truthmark |
180
+ | Memvalidasi kebenaran perilaku | Pengujian dan tinjauan |
181
+ | Meninjau perubahan dokumentasi berbantuan AI | Truthmark plus tinjauan Git |
182
+
183
+ Jalur Truthmark sengaja dirancang sempit:
184
+
185
+ ```text
186
+ make repository truth explicit
187
+ route it to code
188
+ memasang panduan agen di sekelilingnya
189
+ keep the result reviewable in Git
190
+ ```
191
+
192
+ ## Pelajari lebih dalam
193
+
194
+ README adalah etalase: konteks cepat, mulai cepat, dan model mental inti.
195
+
196
+ Untuk penggunaan per perintah, perbandingan permukaan, detail platform yang didukung, konfigurasi, perutean, Portal, dan contoh, baca [Panduan Pengguna Truthmark](../user-guide.md).
197
+
198
+ ## Status proyek
199
+
200
+ Rilis saat ini menyediakan:
201
+
202
+ - perintah CLI lokal untuk config, init, check, index, impact, dan status alur kerja
203
+ - instruksi agen lokal repositori yang dihasilkan untuk Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, dan Cursor
204
+ - diagnostik perutean, otoritas, frontmatter, tautan, kesegaran, permukaan yang dihasilkan, cakupan branch, dan coverage
205
+ - dokumen kebenaran berlingkup branch dan artefak kecerdasan repositori turunan
206
+
207
+ ## Dokumentasi
208
+
209
+ - [Panduan pengguna](../user-guide.md)
210
+ - [Indeks dokumen](../README.md)
211
+ - [Ikhtisar arsitektur](../truthmark/engineering/architecture/overview.md)
212
+ - [Kontrak API dan CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
213
+ - [Panduan pemeliharaan kebenaran repositori](../standards/maintaining-repository-truth.md)
214
+
215
+ Untuk perintah pengembangan lokal dan kontribusi, lihat [CONTRIBUTING.md](../../CONTRIBUTING.md).
216
+
217
+ ## Batas desain
218
+
219
+ Truthmark sengaja kecil: lokal, di-commit, berlingkup branch, dan dapat ditinjau.
220
+
221
+ Ini bukan layanan ter-host, server MCP, basis data vektor, lapisan memori tersembunyi, produk penegakan CI, atau mesin penulisan ulang kode otonom. Ini membantu kebenaran repositori tetap terlihat; tidak menggantikan pengujian, tinjauan kode, atau penilaian manusia.
222
+
223
+ ## Lisensi
224
+
225
+ MIT. Lihat [LICENSE](../../LICENSE).
@@ -0,0 +1,225 @@
1
+ # Truthmark
2
+
3
+ **I tuoi agenti scrivono codice. Truthmark mantiene documentazione pensata per le persone e revisionabile in Git.**
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)
6
+
7
+ ![Banner di Truthmark](../assets/truthmark-banner.png)
8
+
9
+ ## 🚀 Avvio rapido: eseguirlo localmente in cinque minuti
10
+
11
+ Esegui questo comando nel repository Git che vuoi far gestire a Truthmark:
12
+
13
+ ```bash
14
+ cd /path/to/your-repo
15
+ npm install -g truthmark
16
+ truthmark config
17
+ ```
18
+
19
+ Abilita l’host IA che usi davvero. Le nuove configurazioni sono neutrali rispetto all’host, quindi aggiungi un elenco `platforms` di primo livello a `.truthmark/config.yml` prima dell’inizializzazione:
20
+
21
+ ```yaml
22
+ version: 2
23
+ platforms:
24
+ - codex # or: claude-code, github-copilot, opencode, antigravity, cursor
25
+ truthmark:
26
+ workspace: docs/truthmark
27
+ generated:
28
+ portal:
29
+ enabled: false
30
+ ```
31
+
32
+ Poi installa i documenti di verità locali al repository, il routing e le superfici di workflow per agenti:
33
+
34
+ ```bash
35
+ truthmark init
36
+ truthmark check
37
+ git diff
38
+ ```
39
+
40
+ Ora prova il percorso di adozione più comune: documentare un comportamento esistente a partire da codice e test. Nel tuo host di coding IA, chiedi al workflow installato:
41
+
42
+ ```text
43
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
44
+ ```
45
+
46
+ Dopo questo, di norma gli utenti non dovrebbero invocare Truth Sync direttamente. Continua a scrivere codice tramite il tuo host IA; le istruzioni installate nel repository dicono all’agente di eseguire i test pertinenti e svolgere la revisione Truth Sync prima della consegna quando cambiano parti di codice funzionale. Tu revisioni il diff di codice risultante insieme al diff dei documenti di verità.
47
+
48
+ Se vuoi solo la validazione CLI e non vuoi ancora workflow IA specifici per un host, lascia `platforms` omesso ed esegui `truthmark init && truthmark check`; potrai aggiungere una piattaforma più tardi e rieseguire `truthmark init`.
49
+
50
+ ## 💡 Il problema: il divario di documentazione dell’IA
51
+
52
+ Gli agenti di coding IA sono straordinari nello scrivere codice rapidamente. Ma questa velocità crea una nuova modalità di errore pericolosa: **la storia del repository si allontana dalla realtà.**
53
+
54
+ * Il comportamento si perde in cronologie chat effimere.
55
+ * I documenti di architettura restano rapidamente indietro.
56
+ * Le decisioni di prodotto scompaiono dopo la consegna.
57
+ * I revisori del codice si ritrovano a esaminare diff di codice grezzi senza capire il “perché”.
58
+ * Ogni nuova sessione IA è costretta a riscoprire da zero la verità del repository.
59
+
60
+ ## 🎯 La soluzione: Truthmark
61
+
62
+ **Truthmark** installa nel tuo repository un livello di workflow nativo di Git. Risolve la parte dello sviluppo con IA che di solito si rompe: aiutare la documentazione a restare allineata al codice.
63
+
64
+ Invece di sperare che persone e agenti IA si ricordino di aggiornare la documentazione, Truthmark rende la documentazione un’abitudine sistematica e revisionabile direttamente nel repository.
65
+
66
+ ### ✨ Perché Truthmark è unico
67
+
68
+ Truthmark non è semplicemente un altro strumento di documentazione. È profondamente integrato nel workflow IA:
69
+
70
+ * **🚫 Nessun lock-in del fornitore:** nessun servizio ospitato, nessun database nascosto, nessun server aggiuntivo da gestire.
71
+ * **🌳 100% nativo di Git:** tutto vive nel tuo repository. La verità si muove con il tuo branch.
72
+ * **🤝 Contratto posseduto dagli umani e seguito dagli agenti:** I maintainer possiedono il contratto del repository; gli agenti seguono le istruzioni installate mentre scrivono codice.
73
+ * **✅ Fiducia tramite verifica:** il lavoro dell’IA diventa più facile da fidare perché il lavoro che cambia comportamento include una decisione o un diff di documento di verità revisionabile da una persona.
74
+
75
+ ## 🔄 Come funziona
76
+
77
+ Quando un agente IA modifica il tuo codice, il lavoro non è finito. Truthmark installa una protezione di workflow a fine attività che gli agenti seguono prima della consegna:
78
+
79
+ 1. 💻 **Codice:** l’agente modifica codice funzionale.
80
+ 2. 🧪 **Test:** vengono eseguiti i test pertinenti.
81
+ 3. 🔍 **Controllo:** Truthmark controlla la documentazione mappata come parte della revisione finale installata.
82
+ 4. 📝 **Documentazione:** i docs vengono aggiornati dall’agente quando la verità del repository è cambiata.
83
+ 5. 👀 **Revisione:** una persona revisiona il *diff di codice* + il *diff di verità*.
84
+
85
+ ## 🛠 Come interagisci con Truthmark
86
+
87
+ Truthmark ha un contratto locale al repository e due modi per usarlo.
88
+
89
+ ### Gli esseri umani installano e validano il contratto
90
+
91
+ Maintainer e CI usano la CLI:
92
+
93
+ * `truthmark config` - crea la configurazione iniziale.
94
+ * `truthmark init` - installa o aggiorna routing, scaffold dei documenti di verità e istruzioni per host IA.
95
+ * `truthmark check` - valida la verità del repository dal terminale.
96
+
97
+ ### Gli agenti seguono il contratto mentre scrivono codice
98
+
99
+ Truthmark installa istruzioni locali al repository per host di coding IA supportati come Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor.
100
+
101
+ Il ciclo normale è semplice:
102
+
103
+ 1. Chiedi al tuo agente una modifica al codice o di documentare un comportamento esistente.
104
+ 2. Le istruzioni installate dicono all’agente quando testare, quando aggiornare i documenti di verità e quando fermarsi per la revisione umana.
105
+ 3. Tu revisioni normali diff Git: codice più eventuali modifiche ai documenti di verità.
106
+
107
+ Le richieste agente avviate dall’utente sono intenzionalmente poche:
108
+
109
+ * `/truthmark-document` - documenta comportamento implementato esistente da codice e test.
110
+ * `/truthmark-realize` - implementa codice da documenti di verità esistenti.
111
+ * `/truthmark-check` - audita la verità del repository.
112
+
113
+ Truth Sync non è il modo abituale per iniziare il lavoro; è la revisione finale dopo modifiche funzionali al codice.
114
+ Truth Structure non è un comando quotidiano; ripara routing o ownership solo quando ciò blocca il lavoro.
115
+
116
+ ## Cosa ottieni
117
+
118
+ | Capacità | Cosa fa |
119
+ | --- | --- |
120
+ | Verità nativa di Git | Mantiene la verità del repository in Markdown e configurazione committati. |
121
+ | Documentazione con ambito di branch | La verità si muove con il branch invece di vivere in una sessione privata. |
122
+ | CLI umana | Offre ai maintainer comandi di setup, aggiornamento, validazione e ispezione. |
123
+ | Guida agente installata | Dice agli agenti di coding quando documentare, testare, sincronizzare la verità, auditare o fermarsi per revisione. |
124
+ | Routing esplicito | Mappa aree di codice a documenti di verità canonici. |
125
+ | Consegne revisionabili | Produce normali diff Git sia per il codice sia per i documenti di verità. |
126
+ | Operatività local-first | Non richiede servizi ospitati, daemon, database o server MCP. |
127
+ | Confini di scrittura più sicuri | Separa workflow code-first, doc-first, read-only e doc-only. |
128
+ | Validazione | Segnala problemi di routing, autorità, frontmatter, link, superfici generate, ambito di branch, freschezza e copertura. |
129
+ | Portal opzionale | Genera, quando esplicitamente abilitato e richiesto, un sito statico HTML committato a partire da documenti di verità Markdown. |
130
+
131
+ ## Panoramica visiva
132
+
133
+ ![Funzionalità di Truthmark](../assets/truthmark-features.png)
134
+
135
+ **Funzionalità:** cosa installa Truthmark e come è divisa la superficie di workflow.
136
+
137
+ ![Posizione di Truthmark](../assets/truthmark-position.png)
138
+
139
+ **Posizione:** dove Truthmark si colloca rispetto a prompt, memoria e workflow di specifica.
140
+
141
+ ![Flusso di sincronizzazione di Truthmark](../assets/truthmark-syncflow.png)
142
+
143
+ **Flusso di sincronizzazione:** come Truth Sync conclude le normali modifiche di codice prima della consegna.
144
+
145
+ ## Perché i team lo adottano
146
+
147
+ Truthmark è per team che sanno già che gli agenti IA possono generare codice.
148
+
149
+ Il problema successivo è la governance.
150
+
151
+ Non governance come cerimonia. Governance come una semplice domanda:
152
+
153
+ > Dopo questa modifica assistita dall’IA, il repository dice ancora la verità?
154
+
155
+ Truthmark aiuta i team a rispondere con file committati, routing esplicito e diff revisionabili.
156
+
157
+ È utile quando hai bisogno di:
158
+
159
+ - meno deriva della documentazione
160
+ - consegne migliori
161
+ - verità di prodotto specifica per branch
162
+ - documentazione durevole di architettura e API
163
+ - ownership esplicita tra docs e codice
164
+ - confini di scrittura degli agenti più sicuri
165
+ - documentazione revisionabile invece di memoria nascosta
166
+ - guida agente che funziona ancora da file committati nel repository
167
+
168
+ ## Dove si colloca Truthmark
169
+
170
+ Truthmark non sostituisce prompt, memoria, specifiche, test o code review.
171
+
172
+ Offre a questi workflow un luogo durevole in cui atterrare in Git.
173
+
174
+ | Esigenza | Scelta migliore |
175
+ | --- | --- |
176
+ | Output migliore da una sessione di agente | Prompt migliore |
177
+ | Continuità personale o a livello di sessione | Strumento di memoria |
178
+ | Lavoro su funzionalità guidato prima da un piano | Workflow di specifica |
179
+ | Verità con ambito di branch che viaggia con il codice | Truthmark |
180
+ | Validare la correttezza del comportamento | Test e revisione |
181
+ | Revisionare modifiche di documentazione assistite dall’IA | Truthmark più revisione Git |
182
+
183
+ La corsia di Truthmark è stretta per progettazione:
184
+
185
+ ```text
186
+ make repository truth explicit
187
+ route it to code
188
+ installare guida agente intorno a essa
189
+ keep the result reviewable in Git
190
+ ```
191
+
192
+ ## Approfondisci
193
+
194
+ Il README è la vetrina: contesto rapido, avvio rapido e il modello mentale centrale.
195
+
196
+ Per l’uso comando per comando, confronti tra superfici, dettagli sulle piattaforme supportate, configurazione, routing, Portal ed esempi, leggi la [guida utente di Truthmark](../user-guide.md).
197
+
198
+ ## Stato del progetto
199
+
200
+ La release attuale fornisce:
201
+
202
+ - comandi CLI locali per config, init, check, index, impact e stato dei workflow
203
+ - istruzioni agente locali al repository generate per Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor
204
+ - diagnostica su routing, autorità, frontmatter, link, freschezza, superfici generate, ambito di branch e copertura
205
+ - documenti di verità con ambito di branch e artefatti derivati di intelligence del repository
206
+
207
+ ## Documentazione
208
+
209
+ - [Guida utente](../user-guide.md)
210
+ - [Indice docs](../README.md)
211
+ - [Panoramica dell’architettura](../truthmark/engineering/architecture/overview.md)
212
+ - [Contratti API e CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
213
+ - [Guida alla manutenzione della verità del repository](../standards/maintaining-repository-truth.md)
214
+
215
+ Per i comandi di sviluppo locale e contribuzione, vedi [CONTRIBUTING.md](../../CONTRIBUTING.md).
216
+
217
+ ## Confini di progettazione
218
+
219
+ Truthmark è intenzionalmente piccolo: locale, committato, con ambito di branch e revisionabile.
220
+
221
+ Non è un servizio ospitato, un server MCP, un database vettoriale, un livello di memoria nascosto, un prodotto di enforcement CI o un motore autonomo di riscrittura del codice. Aiuta la verità del repository a restare visibile; non sostituisce test, code review o giudizio umano.
222
+
223
+ ## Licenza
224
+
225
+ MIT. Vedi [LICENSE](../../LICENSE).