truthmark 2.2.3 → 2.2.6

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.
package/README.de.md DELETED
@@ -1,823 +0,0 @@
1
- # Truthmark
2
-
3
- **Deine Agenten schreiben Code. Truthmark hält menschenlesbare Dokumentation in Git überprüfbar.**
4
-
5
- [English](README.md) | Deutsch | [中文](README.zh.md) | [Español](README.es.md) | [Русский](README.ru.md)
6
-
7
- ![Truthmark-Banner](docs/assets/truthmark-banner.png)
8
-
9
- KI-Coding-Agenten können ein Repository schneller verändern, als Menschen die Dokumentation ausrichten können.
10
-
11
- Truthmark repariert den Teil, der normalerweise nach dem Code-Schreiben bricht: die Repository-Truth.
12
-
13
- Es installiert eine Git-native, branch-gebundene Workflow-Schicht, die KI-Coding-Agenten hilft, die richtigen Dokumente zu aktualisieren, Ownership-Grenzen zu respektieren und Menschen normale Diffs zur Prüfung zu hinterlassen.
14
-
15
- Kein gehosteter Dienst.
16
-
17
- Keine Datenbank.
18
-
19
- Keine verborgene Memory-Schicht.
20
-
21
- Kein zusätzlicher Server im Betrieb.
22
-
23
- Nur Repository-Truth, die mit dem Branch mitwandert.
24
-
25
- ## Das Problem
26
-
27
- KI-Coding-Agenten sind gut darin, Code zu erzeugen. Dadurch entsteht eine neue Fehlerart.
28
-
29
- Die Implementierung ändert sich, aber die Repository-Erzählung driftet ab:
30
-
31
- - Verhalten lebt im Chatverlauf
32
- - Architekturdokumente fallen zurück
33
- - Produktentscheidungen verschwinden nach der Übergabe
34
- - Reviewer sehen Code-Diffs ohne die zugehörigen Truth-Diffs
35
- - Branches entwickeln unbemerkt unterschiedliche Versionen davon, „was wahr ist“
36
- - jede Agentensitzung muss Repository-Truth neu entdecken
37
-
38
- Truthmark verwandelt diese fragile Repository-Truth in versionierte Repository-Infrastruktur.
39
-
40
- Statt darauf zu vertrauen, dass jeder Mensch und jeder Agent die richtige Dokumentationsgewohnheit beibehält, installiert Truthmark diese Gewohnheit im Repository.
41
-
42
- ## Das Versprechen
43
-
44
- Wenn ein Agent funktionalen Code ändert, sollte die Arbeit nicht mit einem reinen Code-Diff enden.
45
-
46
- Der normale Truthmark-Pfad ist:
47
-
48
- ```text
49
- agent ändert funktionalen Code
50
- relevante Tests laufen
51
- Truth Sync prüft zugeordnete Truth-Dokumente
52
- Truth-Dokumente werden bei Bedarf aktualisiert
53
- Mensch prüft Code-Diff + Truth-Diff
54
- committen oder übergeben
55
- ```
56
-
57
- Das ist der Kernwert: **KI-Arbeit wird leichter vertrauenswürdig, weil das Repository lesbar bleibt.**
58
-
59
- ## Zwei Schnittstellen, ein Truth-System
60
-
61
- Truthmark ist nicht nur eine CLI.
62
-
63
- Es hat zwei unterschiedliche Schnittstellen, und diese Unterscheidung ist wichtig.
64
-
65
- ### 1. CLI für Menschen
66
-
67
- Die CLI ist für Maintainer, Reviewer und Automatisierung.
68
-
69
- Nutze sie, um ein Repository zu konfigurieren, Workflow-Dateien zu installieren oder zu aktualisieren, Truth-Artefakte zu validieren und optionales Review-Material zu erzeugen.
70
-
71
- ```bash
72
- truthmark config
73
- truthmark init
74
- truthmark check
75
- ```
76
-
77
- Die CLI bereitet die Repository-Umgebung vor und validiert sie.
78
-
79
- Sie ist nicht die Runtime für den KI-Workflow.
80
-
81
- ### 2. KI-seitige Workflow-Schnittstellen
82
-
83
- Die KI-seitigen Schnittstellen sind für Coding-Agenten.
84
-
85
- Truthmark installiert host-native Skills, Prompts, Commands, verwaltete Instruktionsblöcke und unterstützte Subagent-Schnittstellen, damit KI-Agenten repository-spezifische Truth-Workflows in ihren normalen Coding-Tools befolgen können.
86
-
87
- Beispiele:
88
-
89
- ```text
90
- /truthmark-sync
91
- /truthmark-document
92
- /truthmark-structure
93
- /truthmark-realize
94
- /truthmark-check
95
- ```
96
-
97
- Sie sehen wie Befehle aus, weil Agenten-Hosts Workflows über Slash-Commands, Prompts, Skills oder Projektbefehle bereitstellen.
98
-
99
- Es sind keine Shell-Befehle.
100
-
101
- Es sind KI-seitige Workflow-Einstiegspunkte.
102
-
103
- Die Trennung ist das Produkt:
104
-
105
- ```text
106
- Menschen besitzen den Repository-Vertrag
107
- Truthmark installiert den Vertrag ins Repo
108
- Agenten arbeiten innerhalb dieses Vertrags
109
- Truth-Updates erscheinen als Git-Diffs
110
- Menschen prüfen das Ergebnis
111
- ```
112
-
113
- ## Quick Start
114
-
115
- ### Voraussetzungen
116
-
117
- - Node.js `>=20`
118
- - npm
119
- - ein Git-Repository
120
-
121
- ### Truthmark installieren
122
-
123
- Führe dies in dem Repository aus, das du initialisieren möchtest:
124
-
125
- ```bash
126
- cd /path/to/your-repo
127
- npm install -g truthmark
128
- ```
129
-
130
- ### Den Repository-Truth-Vertrag erstellen
131
-
132
- ```bash
133
- truthmark config
134
- ```
135
-
136
- Das erzeugt:
137
-
138
- ```text
139
- .truthmark/config.yml
140
- ```
141
-
142
- Prüfe diese Datei, bevor du fortfährst. Sie definiert den versionierten Hierarchievertrag für das Repository.
143
-
144
- ### Die Workflow-Schnittstellen installieren
145
-
146
- ```bash
147
- truthmark init
148
- ```
149
-
150
- Das installiert oder aktualisiert:
151
-
152
- - Routendateien
153
- - Truth-Doc-Scaffolding
154
- - verwaltete Instruktionsblöcke
155
- - KI-seitige Workflow-Schnittstellen für konfigurierte Plattformen
156
-
157
- Die Standardvorlagen für Truth-Dokumente werden in [Template Standards](docs/standards/template-standards.md) begründet. Dort werden sie anerkannten Software-Engineering-Referenzen wie ISO/IEC/IEEE 42010, ISO/IEC/IEEE 29148, ISO/IEC/IEEE 12207, ISO/IEC 25010, C4, arc42, OpenAPI, SemVer, Google SRE und Diátaxis zugeordnet.
158
-
159
- ### Das Setup validieren
160
-
161
- ```bash
162
- truthmark check
163
- ```
164
-
165
- Prüfe danach die generierten Dateien, bevor du committest.
166
-
167
- Die konkreten Dateien hängen von `.truthmark/config.yml` ab, aber die Installation hat immer dieselbe Form: Routing, Truth-Scaffolding, kompakte verwaltete Instruktionen und host-native Workflow-Schnittstellen für die aktivierten Plattformen.
168
-
169
- ## Erste echte Nutzung
170
-
171
- Die meisten Repositories brauchen nach der Initialisierung einen Aufräumschritt.
172
-
173
- Das Standard-Scaffold beginnt mit einem vorläufigen breiten Bootstrap-Bereich `repository`. Bevor echter Code normal synchronisiert wird, teile diese Bootstrap-Route in präzises Routing auf.
174
-
175
- Bitte deinen Agenten, die breite Route in tatsächliche Produkt-, Service-, Domänen- oder Ownership-Bereiche aufzuteilen:
176
-
177
- ```text
178
- /truthmark-structure die breite repository-area in auth, billing und notifications aufteilen
179
- ```
180
-
181
- Wenn das Projekt bereits implementierte Features hat, aber Truth-Dokumente fehlen oder schwach sind, bitte den installierten Truth-Document-Workflow, einen fokussierten Bereich zu dokumentieren:
182
-
183
- ```text
184
- /truthmark-document dokumentiere das implementierte payment-retry-verhalten in src/billing/retry.ts und den zugehörigen tests
185
- ```
186
-
187
- Truth Document ist der häufigste erste Workflow für bestehende Projekte. Er inspiziert Implementierung, Tests, Routen und vorhandene Dokumentation und erstellt oder repariert danach Truth-Dokumente und Routing, ohne funktionalen Code zu ändern.
188
-
189
- Danach nutzt du deinen KI-Coding-Agenten normal.
190
-
191
- Wenn der Agent funktionalen Code ändert, wirkt Truth Sync als Abschlusskontrolle und prüft vor der Übergabe, ob zugeordnete Truth-Dokumente geändert werden müssen.
192
-
193
- ## Was du bekommst
194
-
195
- | Fähigkeit | Was sie tut |
196
- | --- | --- |
197
- | Git-native Repository-Truth | Hält Repository-Truth in versioniertem Markdown und Config. |
198
- | Branch-gebundene Dokumentation | Repository-Truth wandert mit dem Branch statt in einer privaten Sitzung zu leben. |
199
- | CLI für Menschen | Gibt Maintainern Befehle für Setup, Aktualisierung, Validierung und Inspektion. |
200
- | KI-seitige Workflows | Gibt Agenten host-native Workflows für Sync, Dokumentation, Struktur, Preview, Realisierung und Audit. |
201
- | Explizites Routing | Ordnet Codebereiche kanonischen Truth-Dokumenten zu. |
202
- | Prüffähige Übergaben | Erzeugt normale Git-Diffs für Code und Truth-Dokumente. |
203
- | Local-first-Betrieb | Benötigt keinen gehosteten Dienst, keinen Daemon, keine Datenbank und keinen MCP-Server. |
204
- | Sicherere Schreibgrenzen | Trennt code-first, doc-first, read-only und doc-only Workflows. |
205
- | Validierung | Meldet Probleme bei Routing, Autorität, Frontmatter, Links, generierten Schnittstellen, Branch-Scope, Freshness und Coverage. |
206
- | Optionales Portal | Erzeugt eine versionierte statische HTML-Präsentationssite aus Markdown-Truth-Dokumenten, wenn es ausdrücklich aktiviert und angefragt wird. |
207
-
208
- ## Visueller Überblick
209
-
210
- ![Truthmark-Funktionen](docs/assets/truthmark-features.png)
211
-
212
- **Funktionen:** was Truthmark installiert und wie die Workflow-Oberfläche aufgeteilt ist.
213
-
214
- ![Truthmark-Positionierung](docs/assets/truthmark-position.png)
215
-
216
- **Positionierung:** wo Truthmark im Verhältnis zu Prompts, Memory und Spec-Workflows steht.
217
-
218
- ![Truthmark-Sync-Ablauf](docs/assets/truthmark-syncflow.png)
219
-
220
- **Sync-Ablauf:** wie Truth Sync normale Codeänderungen vor der Übergabe abschließt.
221
-
222
- ## Warum Teams es nutzen
223
-
224
- Truthmark ist für Teams, die bereits wissen, dass KI-Agenten Code erzeugen können.
225
-
226
- Das nächste Problem ist Governance.
227
-
228
- Nicht Governance als Zeremonie. Governance als einfache Frage:
229
-
230
- > Erzählt das Repository nach dieser KI-gestützten Änderung noch den aktuellen Stand?
231
-
232
- Truthmark hilft Teams, diese Frage mit versionierten Dateien, explizitem Routing und prüffähigen Diffs zu beantworten.
233
-
234
- Es ist nützlich, wenn du Folgendes brauchst:
235
-
236
- - weniger Dokumentationsdrift
237
- - bessere Übergaben
238
- - branch-spezifische Produktwahrheit
239
- - dauerhafte Architektur- und API-Dokumentation
240
- - explizite Ownership zwischen Dokumentation und Code
241
- - sicherere Schreibgrenzen für Agenten
242
- - prüffähige Dokumentation statt verborgener Memory
243
- - KI-Workflows, die weiterhin aus versionierten Repo-Dateien funktionieren
244
-
245
- ## Wo Truthmark hineinpasst
246
-
247
- Truthmark ersetzt keine Prompts, Memory, Specs, Tests oder Code Review.
248
-
249
- Es gibt diesen Workflows einen dauerhaften Ort in Git.
250
-
251
- | Bedarf | Besser passend |
252
- | --- | --- |
253
- | Bessere Ausgabe aus einer Agentensitzung | Besserer Prompt |
254
- | Persönliche oder sitzungsbezogene Kontinuität | Memory-Tool |
255
- | Plan-first Feature-Arbeit | Spec-Workflow |
256
- | Branch-bezogene Repository-Truth, die mit dem Code mitwandert | Truthmark |
257
- | Korrektheit von Verhalten validieren | Tests und Review |
258
- | KI-gestützte Dokumentationsänderungen prüfen | Truthmark plus Git-Review |
259
-
260
- Truthmarks Spur ist absichtlich eng:
261
-
262
- ```text
263
- Repository-Truth explizit machen
264
- sie zu Code routen
265
- Agenten-Workflows darum installieren
266
- das Ergebnis in Git prüffähig halten
267
- ```
268
-
269
- ## Wie Truthmark läuft
270
-
271
- Truthmark läuft lokal gegen den aktiven Git-Worktree.
272
-
273
- Die CLI für Menschen liest und schreibt Repository-Dateien und beendet sich danach.
274
-
275
- Die KI-seitigen Workflow-Schnittstellen sind versionierte Dateien, die Agenten-Hosts später laden können. Dadurch können Agenten dem installierten Workflow aus dem Repository-Zustand folgen, statt von einem Hintergrundprozess von Truthmark abzuhängen.
276
-
277
- Die Schichten greifen so ineinander:
278
-
279
- ```mermaid
280
- flowchart LR
281
- Human["Human / CI"] --> CLI["Truthmark CLI"]
282
- CLI --> Config["Config und Routing"]
283
- CLI --> Truth["Kanonische Truth-Dokumente"]
284
- CLI --> Surfaces["Generierte host-native Workflows"]
285
- Surfaces --> Hosts["Codex / Claude Code / Copilot / OpenCode / Gemini"]
286
- Hosts --> Worktree["Aktiver Git-Worktree"]
287
- Hosts -->|"helper checks / validate / index"| CLI
288
- Worktree --> Truth
289
- ```
290
-
291
- Agents sprechen nicht mit einem Truthmark-Daemon, können aber die installierte Truthmark CLI ausführen, wenn ein Workflow Validierung, Indexing oder Helper-Checks verlangt.
292
-
293
- Truthmark besitzt die generierten Workflow-Schnittstellen, aber der wichtige Vertrag ist architektonisch: repo-lokale Config und Routing zeigen Agents auf kanonische Truth-Dokumente, während host-native Workflows jedem unterstützten Agent einen eigenen Weg geben, dieselben Truthmark-Prozeduren auszuführen.
294
-
295
- Generierte Workflow-Schnittstellen enthalten Truthmark-Versionsmarker. Nach einem Upgrade von Truthmark erneut ausführen:
296
-
297
- ```bash
298
- truthmark init
299
- ```
300
-
301
- Prüfe danach die generierten Diffs.
302
-
303
- ## Unterstützte Agentenplattformen
304
-
305
- Die Standardkonfiguration enthält jede unterstützte Plattform.
306
-
307
- Entferne Plattformen, die du nicht nutzt, aus `.truthmark/config.yml`, und führe danach erneut aus:
308
-
309
- ```bash
310
- truthmark init
311
- ```
312
-
313
- | Plattform-Configname | Generierte Oberfläche | Aufrufform |
314
- | --- | --- | --- |
315
- | `codex` | `.agents/skills/truthmark-*/`, `.codex/agents/` | `/truthmark-*` oder `$truthmark-*` |
316
- | `claude-code` | `.claude/skills/truthmark-*/`, `.claude/agents/`, `CLAUDE.md` | `/truthmark-*` |
317
- | `github-copilot` | `.github/skills/truthmark-*/`, `.github/prompts/`, `.github/agents/`, `.github/copilot-instructions.md` | `/truthmark-*` in unterstützten Copilot-IDEs; `@truth-*` Custom Agents in Copilot CLI |
318
- | `opencode` | `.opencode/skills/truthmark-*/`, `.opencode/agents/` | `/skill truthmark-*` |
319
- | `gemini-cli` | `.gemini/skills/truthmark-*/`, `.gemini/commands/truthmark/`, `.gemini/agents/`, `GEMINI.md` | `/truthmark:*` |
320
-
321
- Unbekannte Plattformnamen sind Config-Fehler.
322
-
323
- Das Entfernen einer Plattform stoppt künftige Aktualisierungen für diese Plattform. Es löscht zuvor generierte Dateien nicht.
324
-
325
- ## KI-seitige Workflows
326
-
327
- Diese Workflows werden in unterstützte KI-Coding-Hosts installiert.
328
-
329
- Sie werden von Agenten oder Agenten-Hosts während der Repository-Arbeit genutzt. Sie sind keine Top-Level-Shell-Befehle.
330
-
331
- | Workflow | Richtung | Nutze ihn, wenn | Schreibgrenze |
332
- | --- | --- | --- | --- |
333
- | Truth Structure | topology-first | Die Standardroute zu breit ist, Ownership mehrere Bereiche umfasst oder Routendateien noch auf Platzhalter zeigen. | Erstellt oder repariert Routing und Starter-Truth-Dokumente. |
334
- | Truth Document | implementation-first | Verhalten bereits im Code existiert, aber kanonische Truth-Dokumente fehlen oder schwach sind. | Schreibt nur Truth-Dokumente und Routing. Funktionaler Code darf nicht geändert werden. |
335
- | Truth Sync | code-first | Funktionaler Code geändert wurde und zugeordnete Truth-Dokumente vor der Übergabe aktualisiert werden müssen könnten. | Aktualisiert Truth-Dokumente. Funktionaler Code darf von Truth Sync nicht umgeschrieben werden. |
336
- | Truth Realize | doc-first | Produkt- oder Architektur-Truth-Dokumente führen und Code daran angepasst werden soll. | Aktualisiert nur Code. Der Agent darf die Truth-Dokumente, die er realisiert, nicht bearbeiten. |
337
- | Truth Check | audit-first | Ein Reviewer oder Agent die Gesundheit der Repository-Truth auditieren muss. | Auditiert und berichtet. |
338
- | Truthmark Portal | presentation-only | Ein Mensch ausdrücklich eine durchsuchbare statische HTML-Portalansicht über Repository-Truth-Dokumente anfordert. | Schreibt generierte nicht-kanonische statische Dateien nur unter dem konfigurierten Portal-Ausgabeverzeichnis. |
339
-
340
- ### Wichtige Unterscheidung
341
-
342
- Verwechsle diese zwei Schnittstellen nicht:
343
-
344
- | Schnittstelle | Genutzt von | Beispiel | Bedeutung |
345
- | --- | --- | --- | --- |
346
- | CLI für Menschen | Menschen, Skripte, CI-ähnliche Checks | `truthmark check` | Truth-Artefakte des Repositorys im Terminal validieren. |
347
- | KI-seitiger Workflow | Coding-Agenten und Agenten-Hosts | `/truthmark-check` | Einen Agenten bitten, den installierten Audit-Workflow auszuführen. |
348
-
349
- Die Namen sind absichtlich verwandt, aber die Schnittstellen sind unterschiedlich.
350
-
351
- ## Normale KI-gestützte Codeänderung
352
-
353
- Die meisten Nutzer sollten Truth Sync nicht jedes Mal manuell aufrufen müssen.
354
-
355
- Truth Sync ist die installierte Abschlusskontrolle für funktionale Codeänderungen.
356
-
357
- ```text
358
- agent ändert funktionalen Code
359
- agent führt relevante Tests aus oder fordert sie an
360
- installierter Workflow erkennt, dass funktionaler Code geändert wurde
361
- Truth Sync prüft zugeordnete Truth-Dokumente
362
- agent aktualisiert Truth-Dokumente bei Bedarf
363
- Mensch prüft Code-Diff + Truth-Diff
364
- ```
365
-
366
- Der direkte Aufruf ist trotzdem nützlich für Fehlersuche, frühes Synchronisieren oder eine explizite Übergabe:
367
-
368
- ```text
369
- /truthmark-sync die Repository-Truth jetzt vor der Übergabe synchronisieren
370
- ```
371
-
372
- ## Bestehendes Verhalten ohne Doku
373
-
374
- Nutze Truth Document, wenn die Implementierung bereits existiert, aber die Repository-Truth unvollständig ist. Das ist der normale Weg für etablierte Repositories, die Truthmark übernehmen, nachdem die Codebasis bereits existiert.
375
-
376
- ```text
377
- /truthmark-document dokumentiere das implementierte session-timeout-verhalten über src/auth/session.ts, src/auth/middleware.ts und tests/auth/session.test.ts
378
- ```
379
-
380
- Gib den Feature-Namen, Codepfade, Testpfade oder den gewünschten Truth-Doc-Bereich an. In OpenCode-ähnlichen Hosts rufst du denselben Workflow als `/skill truthmark-document ...` auf; in Gemini CLI nutzt du `/truthmark:doc ...`.
381
-
382
- Bei einem großen Repo, das noch eine breite Platzhalterroute hat, führe zuerst Truth Structure aus und rufe danach Truth Document für jeweils ein abgegrenztes Feature oder einen Bereich auf.
383
-
384
- Truth Document prüft Implementierung, Tests, Routendateien und vorhandene Dokumente als Evidenz.
385
-
386
- Es schreibt nur Truth-Dokumente und Routing.
387
-
388
- Es darf keinen funktionalen Code ändern.
389
-
390
- ## Doc-first-Änderungen
391
-
392
- Nutze Truth Realize, wenn eine Produkt- oder Architekturentscheidung in Dokumenten beginnt und Code daran angepasst werden soll.
393
-
394
- ```text
395
- /truthmark-realize docs/truthmark/product/capabilities/session-timeout.md in Code realisieren
396
- ```
397
-
398
- Truth Realize ist doc-first.
399
-
400
- Die Truth-Dokumente führen. Der Code folgt.
401
-
402
- Der Agent darf die Truth-Dokumente, die er realisiert, nicht bearbeiten.
403
-
404
- ## Read-only-Routing-Preview
405
-
406
- Nutze Truth Preview vor einer Änderung, wenn der Agent wahrscheinliches Routing verstehen muss.
407
-
408
- ```text
409
- /truthmark-preview das wahrscheinliche Truth-Routing für Änderungen an der Billing-API prüfen (GitHub Copilot)
410
- /truthmark:preview das wahrscheinliche Truth-Routing für Änderungen an der Billing-API prüfen (Gemini CLI)
411
- ```
412
-
413
- Truth Preview ist read-only.
414
-
415
- Es ist Auswahl- und Planungshilfe, keine Schreibautorisierung und kein Ersatz für Truth Check.
416
-
417
- ## Repository-Truth-Audit
418
-
419
- Nutze Truth Check, wenn du einen agentenorientierten Audit-Workflow möchtest.
420
-
421
- ```text
422
- /truthmark-check Routing und Truth-Coverage vor dem Review auditieren
423
- ```
424
-
425
- Nutze die CLI für Menschen, wenn du Terminalvalidierung möchtest:
426
-
427
- ```bash
428
- truthmark check
429
- ```
430
-
431
- Beides ist nützlich. Es ist nicht dieselbe Oberfläche.
432
-
433
- ## CLI-Befehle für Menschen
434
-
435
- Die meisten Maintainer beginnen mit drei Befehlen.
436
-
437
- | Befehl | Zweck |
438
- | --- | --- |
439
- | `truthmark config` | Erstellt `.truthmark/config.yml`. Schreibt nur diese Datei, außer `--stdout` wird verwendet. |
440
- | `truthmark init` | Installiert oder aktualisiert konfigurierte Workflow-Schnittstellen aus der geprüften Config. |
441
- | `truthmark check` | Validiert Config, Autorität, Routing, entscheidungstragende Dokumente, Frontmatter, interne Links, Branch-Scope, generierte Oberflächen, Freshness und Coverage-Diagnostik. |
442
-
443
- Optionale Repository-Intelligence-Helfer erzeugen abgeleitetes Review-Material für den aktiven Checkout, etwa RepoIndex-, RouteMap-, ImpactSet- und kompaktes WorkflowState/action-context-JSON. Generierte Workflow-Skill-Pakete können außerdem Helper-Manifeste und Helper-Policies bereitstellen, die installierte `truthmark validate ... --json` CLI-Validatoren aufrufen; diese Helpers sind Beschleuniger, keine im Repository gebündelten lokalen Skripte und keine Quellen der Wahrheit. Eigenständige Copilot-Prompts und Gemini-Commands verwenden denselben CLI-Validator-Vertrag, wenn der installierte Runner verfügbar ist; andernfalls melden sie einen sichtbaren übersprungenen Helper-Status und führen eine manuelle Validierung durch.
444
-
445
- Sie sind keine Quellen der Wahrheit.
446
-
447
- | Befehl | Zweck |
448
- | --- | --- |
449
- | `truthmark index` | Baut RepoIndex- und RouteMap-JSON für den aktiven Checkout. |
450
- | `truthmark impact --base <ref>` | Ordnet geänderte Dateien gerouteten Truth-Dokumenten, besitzenden Routen, nahen Tests und öffentlichen Symbolen zu. |
451
- | `truthmark workflow status --workflow <workflow> [--base <ref>] --json` | Liefert Workflow-Anwendbarkeit, Schreibgrenzen, Ziel-Truth-Dokumente, Checks, Helper-Commands und kompakte Hinweise zu betroffenen Tests. |
452
-
453
- Strukturierte Ausgabe ist mit `--json` verfügbar, wo sie unterstützt wird.
454
-
455
- ## Truthmark Portal
456
-
457
- Truthmark Portal ist ein optionaler Präsentations-Workflow für Teams, die eine menschenlesbare Site über ihren versionierten Truth-Dokumenten möchten.
458
-
459
- Er ist bewusst vom Kern-Truth-Workflow getrennt:
460
-
461
- - Markdown-Truth-Dokumente bleiben kanonisch.
462
- - Generiertes Portal-HTML dient nur der Präsentation.
463
- - Portal wird nur manuell ausgeführt; es läuft nicht als Completion-Gate, Truth-Sync-Schritt, `truthmark check`-Schritt oder automatischer Post-Change-Hook.
464
- - Portal-Schreibzugriffe bleiben im konfigurierten Ausgabeverzeichnis, sofern der Nutzer den Scope nicht ausdrücklich ändert.
465
- - Generierte Seiten sollten lokale Assets, Quellen-Provenance und einen sichtbaren Markdown-ist-kanonisch-Hinweis verwenden.
466
-
467
- Aktiviere es mit dem namespaced Config-Block:
468
-
469
- ```yaml
470
- truthmark:
471
- generated:
472
- portal:
473
- enabled: true
474
- ```
475
-
476
- Dann erneut ausführen:
477
-
478
- ```bash
479
- truthmark init
480
- ```
481
-
482
- Wenn aktiviert, installiert Truthmark host-native Portal-Workflow-Schnittstellen für die konfigurierten Plattformen, etwa `/truthmark-portal` oder `/truthmark:portal` je nach Agenten-Host.
483
-
484
- ## Konfiguration
485
-
486
- Truthmark ist config-first.
487
-
488
- Die wichtigste Config-Datei ist:
489
-
490
- ```text
491
- .truthmark/config.yml
492
- ```
493
-
494
- Neue Repositories sollten ausführen:
495
-
496
- ```bash
497
- truthmark config
498
- ```
499
-
500
- Prüfe danach die generierte Config, bevor du ausführst:
501
-
502
- ```bash
503
- truthmark init
504
- ```
505
-
506
- Wichtige Config-Bereiche sind:
507
-
508
- | Config-Bereich | Zweck |
509
- | --- | --- |
510
- | `version` | Version des Config-Vertrags. |
511
- | `platforms` | Agenten-Hosts, die plattformspezifische generierte Oberflächen erhalten sollen. |
512
- | `truthmark.workspace` | Truthmark-eigener Workspace für Routen, Truth-Dokumente, Vorlagen und generierte Präsentationsausgabe. |
513
- | Feste Routen | Routen liegen unter `routes/areas.md` und `routes/areas/` innerhalb von `truthmark.workspace`; die Standard-Area ist `repository`, die Delegationstiefe ist `1`. |
514
- | Feste Truth-Lanes | Product-Truth liegt unter `product/` und Engineering-Truth unter `engineering/` innerhalb von `truthmark.workspace`. |
515
- | Feste Vorlagen | Truth-Dokumentvorlagen liegen unter `templates/` innerhalb von `truthmark.workspace`. |
516
- | `truthmark.generated.portal` | Optionale manuelle Präsentations-Workflow-Aktivierung: `enabled`. |
517
- | `instruction_targets` | Dateien, die gemeinsam verwaltete Instruktionsblöcke erhalten, etwa `AGENTS.md`. |
518
- | `frontmatter.required` | Metadatenfelder, die bei Fehlen Error-Diagnostik erzeugen. |
519
- | `frontmatter.recommended` | Metadatenfelder, die bei Fehlen Review-Diagnostik erzeugen. |
520
- | `ignore` | Glob-Muster, die von relevanten Checks und Routing-Logik ausgeschlossen sind. |
521
-
522
- ## Repository-Truth-Routing
523
-
524
- Truthmark ordnet Codeoberflächen Truth-Dokumenten zu.
525
-
526
- Die wichtigsten Routendateien sind:
527
-
528
- ```text
529
- docs/truthmark/routes/areas.md
530
- docs/truthmark/routes/areas/**/*.md
531
- ```
532
-
533
- Eine Route sagt dem Agenten:
534
-
535
- - welche Codeoberfläche zu einem Bereich gehört
536
- - welche Truth-Dokumente diesen Bereich besitzen
537
- - wann Truth aktualisiert werden sollte
538
- - welche Art von Truth-Dokument beteiligt ist
539
-
540
- Das Standard-Scaffold beginnt mit einer vorläufigen breiten Bootstrap-Route, damit ein neues Repository routbar ist. Wenn echter Code berührt wird, teile diese Bootstrap-Route vor normalem Truth Sync in echte Produkt-, Service-, Domänen- oder Ownership-Bereiche auf; mache den Bootstrap-Handoff nicht zu einem Catch-all-Verhaltensdokument.
541
-
542
- Beispiel:
543
-
544
- ```text
545
- /truthmark-structure die breite repository-area in frontend, backend, billing und deployment aufteilen
546
- ```
547
-
548
- Gutes Routing gibt Truth Sync präzise Ziele.
549
-
550
- Schlechtes Routing zwingt Agenten zum Raten.
551
-
552
- ## Was Truthmark installiert
553
-
554
- Truthmark installiert eine kompakte, repository-native Truth-Schicht.
555
-
556
- Das geschieht in vier Schichten:
557
-
558
- - Config und Routing für Ownership-Grenzen
559
- - kanonische Truth-Dokumente und Starter-Templates
560
- - kompakte verwaltete Instruction-Blöcke für repositoryweite Agent-Instruktionen
561
- - host-native Workflow-Pakete, Commands, Prompts und Verifier-Agents für die in der Config aktivierten Plattformen
562
-
563
- Truthmark bewahrt manuellen Inhalt außerhalb verwalteter Instruktionsblöcke.
564
-
565
- Generierte Workflow-Schnittstellen werden von Truthmark verwaltet und können durch erneutes Ausführen aktualisiert werden:
566
-
567
- ```bash
568
- truthmark init
569
- ```
570
-
571
- ## Subagents und begrenzte Evidenzprüfungen
572
-
573
- Wo der Host es unterstützt, kann Truthmark projektbezogene Prüf-Agenten und einen geleasten `truth-doc-writer` installieren.
574
-
575
- Diese helfen, große Truth-Aufgaben begrenzt zu halten:
576
-
577
- - Route Auditors prüfen Route-Ownership
578
- - Claim Verifiers prüfen, ob Dokumentclaims durch Evidenz gestützt sind
579
- - Doc Reviewers prüfen Truth-Doc-Qualität
580
- - geleaste Doc Writers bearbeiten begrenzte Truth-Doc-Schreib-Shards
581
-
582
- Der Parent-Workflow besitzt weiterhin finale Interpretation, Schreibgrenzen, Diff-Validierung und Abnahme.
583
-
584
- Das ist wichtig: Subagents helfen bei begrenzter Evidenzarbeit. Sie ersetzen den Haupt-Workflow-Vertrag nicht.
585
-
586
- ## Review-Schleife
587
-
588
- Truthmark ist für normalen Git-Review entworfen.
589
-
590
- Eine gute KI-gestützte Übergabe sollte Folgendes zeigen:
591
-
592
- ```text
593
- Code-Diff
594
- Test-Evidenz
595
- Truth-Doc-Diff, falls nötig
596
- Routing-Änderungen, falls nötig
597
- Agentenbericht
598
- ```
599
-
600
- Der Reviewer sollte beantworten können:
601
-
602
- - Welcher Code hat sich geändert?
603
- - Welche Truth-Dokumente besitzen diesen Code?
604
- - Mussten diese Dokumente aktualisiert werden?
605
- - Falls nicht, warum nicht?
606
- - Ist der Agent innerhalb der Workflow-Schreibgrenze geblieben?
607
- - Sind Test- oder Verifikationsevidenz enthalten?
608
-
609
- ## Beispiele
610
-
611
- ### Ein Repository initialisieren
612
-
613
- ```bash
614
- npm install -g truthmark
615
- truthmark config
616
- truthmark init
617
- truthmark check
618
- ```
619
-
620
- ### Unbenutzte Agentenplattformen entfernen
621
-
622
- Bearbeiten:
623
-
624
- ```text
625
- .truthmark/config.yml
626
- ```
627
-
628
- Danach erneut ausführen:
629
-
630
- ```bash
631
- truthmark init
632
- truthmark check
633
- ```
634
-
635
- ### Breites Routing aufteilen
636
-
637
- ```text
638
- /truthmark-structure die breite repository-area in auth, billing, notifications und deployment aufteilen
639
- ```
640
-
641
- ### Implementiertes Verhalten dokumentieren
642
-
643
- ```text
644
- /truthmark-document den implementierten Password-Reset-Flow unter docs/truthmark/engineering/behaviors/authentication dokumentieren
645
- ```
646
-
647
- ### Nach Codeänderungen synchronisieren
648
-
649
- ```text
650
- /truthmark-sync die Repository-Truth jetzt vor der Übergabe synchronisieren
651
- ```
652
-
653
- ### Eine doc-first Entscheidung realisieren
654
-
655
- ```text
656
- /truthmark-realize docs/truthmark/product/capabilities/invoice-retry-policy.md in Code realisieren
657
- ```
658
-
659
- ### Truth-Gesundheit im Terminal auditieren
660
-
661
- ```bash
662
- truthmark check
663
- ```
664
-
665
- ### Branch-Impact-Zusammenfassung erzeugen
666
-
667
- ```bash
668
- truthmark impact --base main
669
- ```
670
-
671
- ### Workflow-Status prüfen
672
-
673
- ```bash
674
- truthmark workflow status --workflow truthmark-sync --base main --json
675
- ```
676
-
677
- ### Optionalen Portal-Workflow aktivieren
678
-
679
- ```yaml
680
- truthmark:
681
- generated:
682
- portal:
683
- enabled: true
684
- ```
685
-
686
- ```bash
687
- truthmark init
688
- ```
689
-
690
- Bitte den Agenten-Host anschließend ausdrücklich, den installierten Portal-Workflow auszuführen, wenn die statische Präsentationssite erzeugt oder aktualisiert werden soll.
691
-
692
- ## Projektstatus
693
-
694
- Truthmark V1 bietet derzeit:
695
-
696
- - `truthmark config`
697
- - `truthmark init`
698
- - `truthmark check`
699
- - `truthmark index`
700
- - `truthmark impact`
701
- - `truthmark workflow status`
702
- - Branch-Scope-Metadaten
703
- - verwaltete Instruktionsblöcke
704
- - generierte Truth-Structure-Workflow-Schnittstellen
705
- - generierte Truth-Document-Workflow-Schnittstellen
706
- - generierte Truth-Sync-Workflow-Schnittstellen
707
- - generierte Truth-Preview-Workflow-Schnittstellen
708
- - generierte Truth-Realize-Workflow-Schnittstellen
709
- - generierte Truth-Check-Workflow-Schnittstellen
710
- - optionale generierte Truthmark-Portal-Workflow-Schnittstellen
711
- - Diagnostik für Route, Autorität, Entscheidungsstruktur, Frontmatter, Links, Freshness, generierte Schnittstellen und Coverage
712
- - abgeleitete RepoIndex-, RouteMap-, ImpactSet- und WorkflowState-Artefakte
713
- - host-spezifische Schnittstellen für Codex, Claude Code, GitHub Copilot, OpenCode und Gemini CLI
714
-
715
- ## Entwicklung
716
-
717
- Abhängigkeiten installieren:
718
-
719
- ```bash
720
- npm install
721
- ```
722
-
723
- Die lokale Entwicklungs-CLI ausführen:
724
-
725
- ```bash
726
- npm run dev -- init
727
- npm run dev -- check
728
- ```
729
-
730
- Den vollständigen Projektcheck ausführen:
731
-
732
- ```bash
733
- npm run check
734
- ```
735
-
736
- Nützliche Skripte:
737
-
738
- | Skript | Zweck |
739
- | --- | --- |
740
- | `npm run dev` | Führt den TypeScript-CLI-Einstiegspunkt mit `tsx` aus. |
741
- | `npm run build` | Baut das Paket. |
742
- | `npm run lint` | Führt ESLint aus. |
743
- | `npm run typecheck` | Führt TypeScript-Checks aus. |
744
- | `npm run test` | Führt Tests aus. |
745
- | `npm run check` | Führt Lint, Typecheck, Tests und Build aus. |
746
- | `npm run release:check` | Führt release-orientierte Validierung aus. |
747
-
748
- Wenn du Truthmark selbst änderst, siehe [CONTRIBUTING.md](CONTRIBUTING.md).
749
-
750
- ## Dokumentation
751
-
752
- Die README ist der schnelle Pfad für Evaluation und Setup.
753
-
754
- Aktuelles Verhalten im Detail lebt unter `docs/`:
755
-
756
- - [Dokumentationsindex](docs/README.md)
757
- - [Architekturüberblick](docs/truthmark/engineering/architecture/overview.md)
758
- - [API- und CLI-Verträge](docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
759
- - [Init- und Scaffold-Verhalten](docs/truthmark/engineering/behaviors/init-and-scaffold.md)
760
- - [Check-Diagnostik](docs/truthmark/engineering/behaviors/check-diagnostics.md)
761
- - [Installierte Workflows](docs/truthmark/engineering/workflows/installed-workflow-runtime.md)
762
- - [Leitfaden zur Pflege von Repository-Truth](docs/standards/maintaining-repository-truth.md)
763
-
764
- ## Designgrenzen
765
-
766
- Truthmark ist absichtlich klein.
767
-
768
- Es ist nicht:
769
-
770
- - ein gehosteter Dienst
771
- - ein MCP-Server
772
- - eine Vektordatenbank
773
- - ein kanonischer Dokumentations-Website-Generator oder eine gehostete Docs-Plattform
774
- - ein CI- oder PR-Enforcement-Produkt
775
- - ein Ersatz für Tests, Code Review oder technische Führung
776
- - eine autonome Code-Rewrite-Engine
777
- - ein Framework für Modelltraining oder Fine-Tuning
778
- - eine verborgene Memory-Schicht
779
-
780
- Diese Grenzen sind Teil des Produkts.
781
-
782
- Truthmark hält den Workflow lokal, versioniert, branch-gebunden und prüffähig.
783
-
784
- ## Sicherheit und Review-Disziplin
785
-
786
- Truthmark hilft dem Repository, ehrlich zu bleiben. Es beweist nicht, dass der Code korrekt ist.
787
-
788
- Teams sollten weiterhin:
789
-
790
- - relevante Tests ausführen
791
- - funktionale Codeänderungen prüfen
792
- - Truth-Doc-Änderungen prüfen
793
- - Secrets aus der Dokumentation heraushalten
794
- - repository-spezifische Instruktionen außerhalb verwalteter Blöcke halten
795
- - Diffs generierter Workflow-Schnittstellen nach Upgrades prüfen
796
- - menschliche Ownership über Produkt- und Architekturentscheidungen behalten
797
-
798
- Truthmark macht agentenseitige Repository-Truth sichtbar. Es ersetzt menschliches Urteil nicht.
799
-
800
- ## Roadmap-Richtung
801
-
802
- Die aktuelle Zukunftsrichtung betont:
803
-
804
- - stärkere Evidenzberichte in `truthmark check`
805
- - klarere Adoptionsbeispiele
806
- - Beispiel-Repositories mit echten Truth-Sync-Zyklen
807
- - Migrationsleitfäden für Teams, die bereits Agenten-Instruktionsdateien nutzen
808
- - Konformitätstests für generierte Host-Schnittstellen
809
- - route-aware Hinweise auf stale truth
810
- - begrenzte Implementierungschecklisten für doc-first Arbeit
811
-
812
- Der Schwerpunkt bleibt gleich:
813
-
814
- ```text
815
- Repository-Truth
816
- agent-native Workflows
817
- Git-Review
818
- branch-gebundene Dokumentation
819
- ```
820
-
821
- ## Lizenz
822
-
823
- MIT. Siehe [LICENSE](LICENSE).