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