truthmark 1.6.1 → 2.1.0
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 +118 -106
- package/README.es.md +135 -123
- package/README.md +57 -45
- package/README.ru.md +107 -95
- package/README.zh.md +106 -96
- package/dist/main.js +906 -528
- package/dist/main.js.map +1 -1
- package/package.json +1 -1
package/README.de.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Deine Agenten schreiben Code. Truthmark
|
|
3
|
+
**Deine Agenten schreiben Code. Truthmark hält menschenlesbare Dokumentation in Git überprüfbar.**
|
|
4
4
|
|
|
5
5
|
[English](README.md) | Deutsch | [中文](README.zh.md) | [Español](README.es.md) | [Русский](README.ru.md)
|
|
6
6
|
|
|
7
7
|

|
|
8
8
|
|
|
9
|
-
KI-Coding-Agenten können ein Repository schneller verändern, als Menschen
|
|
9
|
+
KI-Coding-Agenten können ein Repository schneller verändern, als Menschen die Dokumentation ausrichten können.
|
|
10
10
|
|
|
11
|
-
Truthmark repariert den Teil, der normalerweise nach dem Code-Schreiben bricht: die Repository-
|
|
11
|
+
Truthmark repariert den Teil, der normalerweise nach dem Code-Schreiben bricht: die Repository-Truth.
|
|
12
12
|
|
|
13
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
14
|
|
|
@@ -20,7 +20,7 @@ Keine verborgene Memory-Schicht.
|
|
|
20
20
|
|
|
21
21
|
Kein zusätzlicher Server im Betrieb.
|
|
22
22
|
|
|
23
|
-
Nur Repository-
|
|
23
|
+
Nur Repository-Truth, die mit dem Branch mitwandert.
|
|
24
24
|
|
|
25
25
|
## Das Problem
|
|
26
26
|
|
|
@@ -33,9 +33,9 @@ Die Implementierung ändert sich, aber die Repository-Erzählung driftet ab:
|
|
|
33
33
|
- Produktentscheidungen verschwinden nach der Übergabe
|
|
34
34
|
- Reviewer sehen Code-Diffs ohne die zugehörigen Truth-Diffs
|
|
35
35
|
- Branches entwickeln unbemerkt unterschiedliche Versionen davon, „was wahr ist“
|
|
36
|
-
- jede Agentensitzung muss
|
|
36
|
+
- jede Agentensitzung muss Repository-Truth neu entdecken
|
|
37
37
|
|
|
38
|
-
Truthmark verwandelt
|
|
38
|
+
Truthmark verwandelt diese fragile Repository-Truth in versionierte Repository-Infrastruktur.
|
|
39
39
|
|
|
40
40
|
Statt darauf zu vertrauen, dass jeder Mensch und jeder Agent die richtige Dokumentationsgewohnheit beibehält, installiert Truthmark diese Gewohnheit im Repository.
|
|
41
41
|
|
|
@@ -56,17 +56,17 @@ committen oder übergeben
|
|
|
56
56
|
|
|
57
57
|
Das ist der Kernwert: **KI-Arbeit wird leichter vertrauenswürdig, weil das Repository lesbar bleibt.**
|
|
58
58
|
|
|
59
|
-
## Zwei
|
|
59
|
+
## Zwei Schnittstellen, ein Truth-System
|
|
60
60
|
|
|
61
61
|
Truthmark ist nicht nur eine CLI.
|
|
62
62
|
|
|
63
|
-
Es hat zwei unterschiedliche
|
|
63
|
+
Es hat zwei unterschiedliche Schnittstellen, und diese Unterscheidung ist wichtig.
|
|
64
64
|
|
|
65
|
-
### 1.
|
|
65
|
+
### 1. CLI für Menschen
|
|
66
66
|
|
|
67
67
|
Die CLI ist für Maintainer, Reviewer und Automatisierung.
|
|
68
68
|
|
|
69
|
-
Nutze sie, um ein Repository zu konfigurieren, Workflow-Dateien zu installieren oder zu aktualisieren, Truth-Artefakte zu validieren und
|
|
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
70
|
|
|
71
71
|
```bash
|
|
72
72
|
truthmark config
|
|
@@ -78,11 +78,11 @@ Die CLI bereitet die Repository-Umgebung vor und validiert sie.
|
|
|
78
78
|
|
|
79
79
|
Sie ist nicht die Runtime für den KI-Workflow.
|
|
80
80
|
|
|
81
|
-
### 2. KI-
|
|
81
|
+
### 2. KI-seitige Workflow-Schnittstellen
|
|
82
82
|
|
|
83
|
-
Die KI-
|
|
83
|
+
Die KI-seitigen Schnittstellen sind für Coding-Agenten.
|
|
84
84
|
|
|
85
|
-
Truthmark installiert host-native Skills, Prompts, Commands, verwaltete Instruktionsblöcke und unterstützte Subagent-
|
|
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
86
|
|
|
87
87
|
Beispiele:
|
|
88
88
|
|
|
@@ -99,7 +99,7 @@ Sie sehen wie Befehle aus, weil Agenten-Hosts Workflows über Slash-Commands, Pr
|
|
|
99
99
|
|
|
100
100
|
Es sind keine Shell-Befehle.
|
|
101
101
|
|
|
102
|
-
Es sind KI-
|
|
102
|
+
Es sind KI-seitige Workflow-Einstiegspunkte.
|
|
103
103
|
|
|
104
104
|
Die Trennung ist das Produkt:
|
|
105
105
|
|
|
@@ -128,7 +128,7 @@ cd /path/to/your-repo
|
|
|
128
128
|
npm install -g truthmark
|
|
129
129
|
```
|
|
130
130
|
|
|
131
|
-
### Den Repository-
|
|
131
|
+
### Den Repository-Truth-Vertrag erstellen
|
|
132
132
|
|
|
133
133
|
```bash
|
|
134
134
|
truthmark config
|
|
@@ -140,9 +140,9 @@ Das erzeugt:
|
|
|
140
140
|
.truthmark/config.yml
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
Prüfe diese Datei, bevor du fortfährst. Sie definiert den
|
|
143
|
+
Prüfe diese Datei, bevor du fortfährst. Sie definiert den versionierten Hierarchievertrag für das Repository.
|
|
144
144
|
|
|
145
|
-
### Die Workflow-
|
|
145
|
+
### Die Workflow-Schnittstellen installieren
|
|
146
146
|
|
|
147
147
|
```bash
|
|
148
148
|
truthmark init
|
|
@@ -153,7 +153,7 @@ Das installiert oder aktualisiert:
|
|
|
153
153
|
- Routendateien
|
|
154
154
|
- Truth-Doc-Scaffolding
|
|
155
155
|
- verwaltete Instruktionsblöcke
|
|
156
|
-
- KI-
|
|
156
|
+
- KI-seitige Workflow-Schnittstellen für konfigurierte Plattformen
|
|
157
157
|
|
|
158
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
159
|
|
|
@@ -165,7 +165,7 @@ truthmark check
|
|
|
165
165
|
|
|
166
166
|
Prüfe danach die generierten Dateien, bevor du committest.
|
|
167
167
|
|
|
168
|
-
Die konkreten Dateien hängen von `.truthmark/config.yml` ab, aber die Installation hat immer dieselbe Form: Routing, Truth-Scaffolding, kompakte verwaltete
|
|
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
169
|
|
|
170
170
|
## Erste echte Nutzung
|
|
171
171
|
|
|
@@ -179,6 +179,14 @@ Bitte deinen Agenten, die breite Route in tatsächliche Produkt-, Service-, Dom
|
|
|
179
179
|
/truthmark-structure die breite repository-area in auth, billing und notifications aufteilen
|
|
180
180
|
```
|
|
181
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
|
+
|
|
182
190
|
Danach nutzt du deinen KI-Coding-Agenten normal.
|
|
183
191
|
|
|
184
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.
|
|
@@ -187,16 +195,16 @@ Wenn der Agent funktionalen Code ändert, wirkt Truth Sync als Abschlusskontroll
|
|
|
187
195
|
|
|
188
196
|
| Fähigkeit | Was sie tut |
|
|
189
197
|
| --- | --- |
|
|
190
|
-
| Git-native
|
|
191
|
-
| Branch-
|
|
192
|
-
|
|
|
193
|
-
| KI-
|
|
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. |
|
|
194
202
|
| Explizites Routing | Ordnet Codebereiche kanonischen Truth-Dokumenten zu. |
|
|
195
203
|
| Prüffähige Übergaben | Erzeugt normale Git-Diffs für Code und Truth-Dokumente. |
|
|
196
|
-
| Local-first-Betrieb | Benötigt keinen gehosteten Dienst, Daemon, keine Datenbank und keinen MCP-Server. |
|
|
204
|
+
| Local-first-Betrieb | Benötigt keinen gehosteten Dienst, keinen Daemon, keine Datenbank und keinen MCP-Server. |
|
|
197
205
|
| Sicherere Schreibgrenzen | Trennt code-first, doc-first, read-only und doc-only Workflows. |
|
|
198
|
-
| Validierung | Meldet Probleme bei Routing, Autorität, Frontmatter, Links, generierten
|
|
199
|
-
| Optionales Portal | Erzeugt eine
|
|
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. |
|
|
200
208
|
|
|
201
209
|
## Visueller Überblick
|
|
202
210
|
|
|
@@ -220,20 +228,20 @@ Das nächste Problem ist Governance.
|
|
|
220
228
|
|
|
221
229
|
Nicht Governance als Zeremonie. Governance als einfache Frage:
|
|
222
230
|
|
|
223
|
-
> Erzählt das Repository nach dieser KI-gestützten Änderung noch
|
|
231
|
+
> Erzählt das Repository nach dieser KI-gestützten Änderung noch den aktuellen Stand?
|
|
224
232
|
|
|
225
|
-
Truthmark hilft Teams, diese Frage mit
|
|
233
|
+
Truthmark hilft Teams, diese Frage mit versionierten Dateien, explizitem Routing und prüffähigen Diffs zu beantworten.
|
|
226
234
|
|
|
227
235
|
Es ist nützlich, wenn du Folgendes brauchst:
|
|
228
236
|
|
|
229
237
|
- weniger Dokumentationsdrift
|
|
230
238
|
- bessere Übergaben
|
|
231
239
|
- branch-spezifische Produktwahrheit
|
|
232
|
-
-
|
|
240
|
+
- dauerhafte Architektur- und API-Dokumentation
|
|
233
241
|
- explizite Ownership zwischen Dokumentation und Code
|
|
234
242
|
- sicherere Schreibgrenzen für Agenten
|
|
235
|
-
-
|
|
236
|
-
- KI-Workflows, die weiterhin aus
|
|
243
|
+
- prüffähige Dokumentation statt verborgener Memory
|
|
244
|
+
- KI-Workflows, die weiterhin aus versionierten Repo-Dateien funktionieren
|
|
237
245
|
|
|
238
246
|
## Wo Truthmark hineinpasst
|
|
239
247
|
|
|
@@ -246,14 +254,14 @@ Es gibt diesen Workflows einen dauerhaften Ort in Git.
|
|
|
246
254
|
| Bessere Ausgabe aus einer Agentensitzung | Besserer Prompt |
|
|
247
255
|
| Persönliche oder sitzungsbezogene Kontinuität | Memory-Tool |
|
|
248
256
|
| Plan-first Feature-Arbeit | Spec-Workflow |
|
|
249
|
-
| Branch-
|
|
257
|
+
| Branch-bezogene Repository-Truth, die mit dem Code mitwandert | Truthmark |
|
|
250
258
|
| Korrektheit von Verhalten validieren | Tests und Review |
|
|
251
|
-
| KI-gestützte
|
|
259
|
+
| KI-gestützte Dokumentationsänderungen prüfen | Truthmark plus Git-Review |
|
|
252
260
|
|
|
253
261
|
Truthmarks Spur ist absichtlich eng:
|
|
254
262
|
|
|
255
263
|
```text
|
|
256
|
-
Repository-
|
|
264
|
+
Repository-Truth explizit machen
|
|
257
265
|
sie zu Code routen
|
|
258
266
|
Agenten-Workflows darum installieren
|
|
259
267
|
das Ergebnis in Git prüffähig halten
|
|
@@ -263,9 +271,9 @@ das Ergebnis in Git prüffähig halten
|
|
|
263
271
|
|
|
264
272
|
Truthmark läuft lokal gegen den aktiven Git-Worktree.
|
|
265
273
|
|
|
266
|
-
Die
|
|
274
|
+
Die CLI für Menschen liest und schreibt Repository-Dateien und beendet sich danach.
|
|
267
275
|
|
|
268
|
-
Die KI-
|
|
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.
|
|
269
277
|
|
|
270
278
|
Die Schichten greifen so ineinander:
|
|
271
279
|
|
|
@@ -283,9 +291,9 @@ flowchart LR
|
|
|
283
291
|
|
|
284
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.
|
|
285
293
|
|
|
286
|
-
Truthmark besitzt die generierten Workflow-
|
|
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.
|
|
287
295
|
|
|
288
|
-
Generierte Workflow-
|
|
296
|
+
Generierte Workflow-Schnittstellen enthalten Truthmark-Versionsmarker. Nach einem Upgrade von Truthmark erneut ausführen:
|
|
289
297
|
|
|
290
298
|
```bash
|
|
291
299
|
truthmark init
|
|
@@ -305,7 +313,7 @@ truthmark init
|
|
|
305
313
|
|
|
306
314
|
| Plattform-Configname | Generierte Oberfläche | Aufrufform |
|
|
307
315
|
| --- | --- | --- |
|
|
308
|
-
| `codex` | `.
|
|
316
|
+
| `codex` | `.agents/skills/truthmark-*/`, `.codex/agents/` | `/truthmark-*` oder `$truthmark-*` |
|
|
309
317
|
| `claude-code` | `.claude/skills/truthmark-*/`, `.claude/agents/`, `CLAUDE.md` | `/truthmark-*` |
|
|
310
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 |
|
|
311
319
|
| `opencode` | `.opencode/skills/truthmark-*/`, `.opencode/agents/` | `/skill truthmark-*` |
|
|
@@ -315,7 +323,7 @@ Unbekannte Plattformnamen sind Config-Fehler.
|
|
|
315
323
|
|
|
316
324
|
Das Entfernen einer Plattform stoppt künftige Aktualisierungen für diese Plattform. Es löscht zuvor generierte Dateien nicht.
|
|
317
325
|
|
|
318
|
-
## KI-
|
|
326
|
+
## KI-seitige Workflows
|
|
319
327
|
|
|
320
328
|
Diese Workflows werden in unterstützte KI-Coding-Hosts installiert.
|
|
321
329
|
|
|
@@ -328,19 +336,19 @@ Sie werden von Agenten oder Agenten-Hosts während der Repository-Arbeit genutzt
|
|
|
328
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. |
|
|
329
337
|
| Truth Preview | read-only | Der Agent vor Änderungen wahrscheinliches Routing einschätzen muss. | Liest nur. Autorisiert keine Schreibzugriffe. |
|
|
330
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. |
|
|
331
|
-
| Truth Check | audit-first | Ein Reviewer oder Agent die Gesundheit der Repository-
|
|
339
|
+
| Truth Check | audit-first | Ein Reviewer oder Agent die Gesundheit der Repository-Truth auditieren muss. | Auditiert und berichtet. |
|
|
332
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. |
|
|
333
341
|
|
|
334
342
|
### Wichtige Unterscheidung
|
|
335
343
|
|
|
336
|
-
Verwechsle diese zwei
|
|
344
|
+
Verwechsle diese zwei Schnittstellen nicht:
|
|
337
345
|
|
|
338
|
-
|
|
|
346
|
+
| Schnittstelle | Genutzt von | Beispiel | Bedeutung |
|
|
339
347
|
| --- | --- | --- | --- |
|
|
340
|
-
|
|
|
341
|
-
| KI-
|
|
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. |
|
|
342
350
|
|
|
343
|
-
Die Namen sind absichtlich verwandt, aber die
|
|
351
|
+
Die Namen sind absichtlich verwandt, aber die Schnittstellen sind unterschiedlich.
|
|
344
352
|
|
|
345
353
|
## Normale KI-gestützte Codeänderung
|
|
346
354
|
|
|
@@ -360,17 +368,21 @@ Mensch prüft Code-Diff + Truth-Diff
|
|
|
360
368
|
Der direkte Aufruf ist trotzdem nützlich für Fehlersuche, frühes Synchronisieren oder eine explizite Übergabe:
|
|
361
369
|
|
|
362
370
|
```text
|
|
363
|
-
/truthmark-sync die Repository-
|
|
371
|
+
/truthmark-sync die Repository-Truth jetzt vor der Übergabe synchronisieren
|
|
364
372
|
```
|
|
365
373
|
|
|
366
374
|
## Bestehendes Verhalten ohne Doku
|
|
367
375
|
|
|
368
|
-
Nutze Truth Document, wenn die Implementierung bereits existiert, aber die Repository-
|
|
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.
|
|
369
377
|
|
|
370
378
|
```text
|
|
371
|
-
/truthmark-document das implementierte
|
|
379
|
+
/truthmark-document dokumentiere das implementierte session-timeout-verhalten über src/auth/session.ts, src/auth/middleware.ts und tests/auth/session.test.ts
|
|
372
380
|
```
|
|
373
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
|
+
|
|
374
386
|
Truth Document prüft Implementierung, Tests, Routendateien und vorhandene Dokumente als Evidenz.
|
|
375
387
|
|
|
376
388
|
Es schreibt nur Truth-Dokumente und Routing.
|
|
@@ -382,7 +394,7 @@ Es darf keinen funktionalen Code ändern.
|
|
|
382
394
|
Nutze Truth Realize, wenn eine Produkt- oder Architekturentscheidung in Dokumenten beginnt und Code daran angepasst werden soll.
|
|
383
395
|
|
|
384
396
|
```text
|
|
385
|
-
/truthmark-realize docs/truth/authentication/session-timeout.md in Code realisieren
|
|
397
|
+
/truthmark-realize docs/truthmark/truth/authentication/session-timeout.md in Code realisieren
|
|
386
398
|
```
|
|
387
399
|
|
|
388
400
|
Truth Realize ist doc-first.
|
|
@@ -411,7 +423,7 @@ Nutze Truth Check, wenn du einen agentenorientierten Audit-Workflow möchtest.
|
|
|
411
423
|
/truthmark-check Routing und Truth-Coverage vor dem Review auditieren
|
|
412
424
|
```
|
|
413
425
|
|
|
414
|
-
Nutze die
|
|
426
|
+
Nutze die CLI für Menschen, wenn du Terminalvalidierung möchtest:
|
|
415
427
|
|
|
416
428
|
```bash
|
|
417
429
|
truthmark check
|
|
@@ -419,17 +431,17 @@ truthmark check
|
|
|
419
431
|
|
|
420
432
|
Beides ist nützlich. Es ist nicht dieselbe Oberfläche.
|
|
421
433
|
|
|
422
|
-
##
|
|
434
|
+
## CLI-Befehle für Menschen
|
|
423
435
|
|
|
424
436
|
Die meisten Maintainer beginnen mit drei Befehlen.
|
|
425
437
|
|
|
426
438
|
| Befehl | Zweck |
|
|
427
439
|
| --- | --- |
|
|
428
440
|
| `truthmark config` | Erstellt `.truthmark/config.yml`. Schreibt nur diese Datei, außer `--stdout` wird verwendet. |
|
|
429
|
-
| `truthmark init` | Installiert oder aktualisiert konfigurierte Workflow-
|
|
441
|
+
| `truthmark init` | Installiert oder aktualisiert konfigurierte Workflow-Schnittstellen aus der geprüften Config. |
|
|
430
442
|
| `truthmark check` | Validiert Config, Autorität, Routing, entscheidungstragende Dokumente, Frontmatter, interne Links, Branch-Scope, generierte Oberflächen, Freshness und Coverage-Diagnostik. |
|
|
431
443
|
|
|
432
|
-
Optionale Repository-Intelligence-Helfer erzeugen
|
|
444
|
+
Optionale Repository-Intelligence-Helfer erzeugen abgeleitetes Review-Material für den aktiven Checkout, etwa RepoIndex-, RouteMap-, ImpactSet- und begrenzte ContextPack-Artefakte. 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.
|
|
433
445
|
|
|
434
446
|
Sie sind keine Quellen der Wahrheit.
|
|
435
447
|
|
|
@@ -437,13 +449,13 @@ Sie sind keine Quellen der Wahrheit.
|
|
|
437
449
|
| --- | --- |
|
|
438
450
|
| `truthmark index` | Baut RepoIndex- und RouteMap-JSON für den aktiven Checkout. |
|
|
439
451
|
| `truthmark impact --base <ref>` | Ordnet geänderte Dateien gerouteten Truth-Dokumenten, besitzenden Routen, nahen Tests und öffentlichen Symbolen zu. |
|
|
440
|
-
| `truthmark
|
|
452
|
+
| `truthmark ctx --workflow <workflow> [--base <ref>]` | Erzeugt ein begrenztes ContextPack für Truth Sync, Truth Document oder Truth Realize. Nutze `--format markdown` für eine menschenlesbare Fassung. |
|
|
441
453
|
|
|
442
454
|
Strukturierte Ausgabe ist mit `--json` verfügbar, wo sie unterstützt wird.
|
|
443
455
|
|
|
444
456
|
## Truthmark Portal
|
|
445
457
|
|
|
446
|
-
Truthmark Portal ist ein optionaler Präsentations-Workflow für Teams, die eine menschenlesbare Site über ihren
|
|
458
|
+
Truthmark Portal ist ein optionaler Präsentations-Workflow für Teams, die eine menschenlesbare Site über ihren versionierten Truth-Dokumenten möchten.
|
|
447
459
|
|
|
448
460
|
Er ist bewusst vom Kern-Truth-Workflow getrennt:
|
|
449
461
|
|
|
@@ -456,10 +468,10 @@ Er ist bewusst vom Kern-Truth-Workflow getrennt:
|
|
|
456
468
|
Aktiviere es mit dem namespaced Config-Block:
|
|
457
469
|
|
|
458
470
|
```yaml
|
|
459
|
-
truthmark
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
471
|
+
truthmark:
|
|
472
|
+
generated:
|
|
473
|
+
portal:
|
|
474
|
+
enabled: true
|
|
463
475
|
```
|
|
464
476
|
|
|
465
477
|
Dann erneut ausführen:
|
|
@@ -468,7 +480,7 @@ Dann erneut ausführen:
|
|
|
468
480
|
truthmark init
|
|
469
481
|
```
|
|
470
482
|
|
|
471
|
-
Wenn aktiviert, installiert Truthmark host-native Portal-Workflow-
|
|
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.
|
|
472
484
|
|
|
473
485
|
## Konfiguration
|
|
474
486
|
|
|
@@ -498,14 +510,14 @@ Wichtige Config-Bereiche sind:
|
|
|
498
510
|
| --- | --- |
|
|
499
511
|
| `version` | Version des Config-Vertrags. |
|
|
500
512
|
| `platforms` | Agenten-Hosts, die plattformspezifische generierte Oberflächen erhalten sollen. |
|
|
501
|
-
| `
|
|
502
|
-
| `
|
|
503
|
-
| `
|
|
504
|
-
| `
|
|
505
|
-
| `
|
|
506
|
-
| `
|
|
507
|
-
| `truthmark
|
|
508
|
-
| `
|
|
513
|
+
| `truthmark.workspace` | Truthmark-eigener Workspace für Routen, Truth-Dokumente, Vorlagen und generierte Präsentationsausgabe. |
|
|
514
|
+
| `truthmark.routes.index` | Root-Routenindex relativ zu `truthmark.workspace`. |
|
|
515
|
+
| `truthmark.routes.areas` | Verzeichnis für delegierte untergeordnete Routendateien relativ zu `truthmark.workspace`. |
|
|
516
|
+
| `truthmark.routes.default_area` | Dateiname des initial erzeugten untergeordneten Routings ohne Erweiterung. |
|
|
517
|
+
| `truthmark.routes.max_delegation_depth` | Aktuelle maximale Routing-Delegationstiefe. |
|
|
518
|
+
| `truthmark.truth.root` | Truth-Dokumentwurzel relativ zu `truthmark.workspace`. |
|
|
519
|
+
| `truthmark.templates.root` | Truth-Dokumentvorlagenwurzel relativ zu `truthmark.workspace`. |
|
|
520
|
+
| `truthmark.generated.portal` | Optionale manuelle Präsentations-Workflow-Aktivierung: `enabled`. |
|
|
509
521
|
| `instruction_targets` | Dateien, die gemeinsam verwaltete Instruktionsblöcke erhalten, etwa `AGENTS.md`. |
|
|
510
522
|
| `frontmatter.required` | Metadatenfelder, die bei Fehlen Error-Diagnostik erzeugen. |
|
|
511
523
|
| `frontmatter.recommended` | Metadatenfelder, die bei Fehlen Review-Diagnostik erzeugen. |
|
|
@@ -518,8 +530,8 @@ Truthmark ordnet Codeoberflächen Truth-Dokumenten zu.
|
|
|
518
530
|
Die wichtigsten Routendateien sind:
|
|
519
531
|
|
|
520
532
|
```text
|
|
521
|
-
docs/truthmark/areas.md
|
|
522
|
-
docs/truthmark/areas/**/*.md
|
|
533
|
+
docs/truthmark/routes/areas.md
|
|
534
|
+
docs/truthmark/routes/areas/**/*.md
|
|
523
535
|
```
|
|
524
536
|
|
|
525
537
|
Eine Route sagt dem Agenten:
|
|
@@ -549,12 +561,12 @@ Das geschieht in vier Schichten:
|
|
|
549
561
|
|
|
550
562
|
- Config und Routing für Ownership-Grenzen
|
|
551
563
|
- kanonische Truth-Dokumente und Starter-Templates
|
|
552
|
-
- kompakte verwaltete Instruction-Blöcke für
|
|
564
|
+
- kompakte verwaltete Instruction-Blöcke für repositoryweite Agent-Instruktionen
|
|
553
565
|
- host-native Workflow-Pakete, Commands, Prompts und Verifier-Agents für die in der Config aktivierten Plattformen
|
|
554
566
|
|
|
555
567
|
Truthmark bewahrt manuellen Inhalt außerhalb verwalteter Instruktionsblöcke.
|
|
556
568
|
|
|
557
|
-
Generierte Workflow-
|
|
569
|
+
Generierte Workflow-Schnittstellen werden von Truthmark verwaltet und können durch erneutes Ausführen aktualisiert werden:
|
|
558
570
|
|
|
559
571
|
```bash
|
|
560
572
|
truthmark init
|
|
@@ -562,7 +574,7 @@ truthmark init
|
|
|
562
574
|
|
|
563
575
|
## Subagents und begrenzte Evidenzprüfungen
|
|
564
576
|
|
|
565
|
-
Wo der Host es unterstützt, kann Truthmark projektbezogene
|
|
577
|
+
Wo der Host es unterstützt, kann Truthmark projektbezogene Prüf-Agenten und einen geleasten `truth-doc-writer` installieren.
|
|
566
578
|
|
|
567
579
|
Diese helfen, große Truth-Aufgaben begrenzt zu halten:
|
|
568
580
|
|
|
@@ -633,19 +645,19 @@ truthmark check
|
|
|
633
645
|
### Implementiertes Verhalten dokumentieren
|
|
634
646
|
|
|
635
647
|
```text
|
|
636
|
-
/truthmark-document den implementierten Password-Reset-Flow unter docs/truth/authentication dokumentieren
|
|
648
|
+
/truthmark-document den implementierten Password-Reset-Flow unter docs/truthmark/truth/authentication dokumentieren
|
|
637
649
|
```
|
|
638
650
|
|
|
639
651
|
### Nach Codeänderungen synchronisieren
|
|
640
652
|
|
|
641
653
|
```text
|
|
642
|
-
/truthmark-sync die Repository-
|
|
654
|
+
/truthmark-sync die Repository-Truth jetzt vor der Übergabe synchronisieren
|
|
643
655
|
```
|
|
644
656
|
|
|
645
657
|
### Eine doc-first Entscheidung realisieren
|
|
646
658
|
|
|
647
659
|
```text
|
|
648
|
-
/truthmark-realize docs/truth/billing/invoice-retry-policy.md in Code realisieren
|
|
660
|
+
/truthmark-realize docs/truthmark/truth/billing/invoice-retry-policy.md in Code realisieren
|
|
649
661
|
```
|
|
650
662
|
|
|
651
663
|
### Truth-Gesundheit im Terminal auditieren
|
|
@@ -654,25 +666,25 @@ truthmark check
|
|
|
654
666
|
truthmark check
|
|
655
667
|
```
|
|
656
668
|
|
|
657
|
-
### Branch-Impact-
|
|
669
|
+
### Branch-Impact-Zusammenfassung erzeugen
|
|
658
670
|
|
|
659
671
|
```bash
|
|
660
672
|
truthmark impact --base main
|
|
661
673
|
```
|
|
662
674
|
|
|
663
|
-
### Workflow-
|
|
675
|
+
### Workflow-ContextPack erzeugen
|
|
664
676
|
|
|
665
677
|
```bash
|
|
666
|
-
truthmark
|
|
678
|
+
truthmark ctx --workflow truth-sync --base main --format markdown
|
|
667
679
|
```
|
|
668
680
|
|
|
669
681
|
### Optionalen Portal-Workflow aktivieren
|
|
670
682
|
|
|
671
683
|
```yaml
|
|
672
|
-
truthmark
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
684
|
+
truthmark:
|
|
685
|
+
generated:
|
|
686
|
+
portal:
|
|
687
|
+
enabled: true
|
|
676
688
|
```
|
|
677
689
|
|
|
678
690
|
```bash
|
|
@@ -690,19 +702,19 @@ Truthmark V1 bietet derzeit:
|
|
|
690
702
|
- `truthmark check`
|
|
691
703
|
- `truthmark index`
|
|
692
704
|
- `truthmark impact`
|
|
693
|
-
- `truthmark
|
|
705
|
+
- `truthmark ctx`
|
|
694
706
|
- Branch-Scope-Metadaten
|
|
695
707
|
- verwaltete Instruktionsblöcke
|
|
696
|
-
- generierte Truth-Structure-Workflow-
|
|
697
|
-
- generierte Truth-Document-Workflow-
|
|
698
|
-
- generierte Truth-Sync-Workflow-
|
|
699
|
-
- generierte Truth-Preview-Workflow-
|
|
700
|
-
- generierte Truth-Realize-Workflow-
|
|
701
|
-
- generierte Truth-Check-Workflow-
|
|
702
|
-
- optionale generierte Truthmark-Portal-Workflow-
|
|
703
|
-
- Diagnostik für Route, Autorität, Entscheidungsstruktur, Frontmatter, Links, Freshness, generierte
|
|
708
|
+
- generierte Truth-Structure-Workflow-Schnittstellen
|
|
709
|
+
- generierte Truth-Document-Workflow-Schnittstellen
|
|
710
|
+
- generierte Truth-Sync-Workflow-Schnittstellen
|
|
711
|
+
- generierte Truth-Preview-Workflow-Schnittstellen
|
|
712
|
+
- generierte Truth-Realize-Workflow-Schnittstellen
|
|
713
|
+
- generierte Truth-Check-Workflow-Schnittstellen
|
|
714
|
+
- optionale generierte Truthmark-Portal-Workflow-Schnittstellen
|
|
715
|
+
- Diagnostik für Route, Autorität, Entscheidungsstruktur, Frontmatter, Links, Freshness, generierte Schnittstellen und Coverage
|
|
704
716
|
- abgeleitete RepoIndex-, RouteMap-, ImpactSet- und ContextPack-Artefakte
|
|
705
|
-
- host-spezifische
|
|
717
|
+
- host-spezifische Schnittstellen für Codex, Claude Code, GitHub Copilot, OpenCode und Gemini CLI
|
|
706
718
|
|
|
707
719
|
## Entwicklung
|
|
708
720
|
|
|
@@ -746,12 +758,12 @@ Die README ist der schnelle Pfad für Evaluation und Setup.
|
|
|
746
758
|
Aktuelles Verhalten im Detail lebt unter `docs/`:
|
|
747
759
|
|
|
748
760
|
- [Dokumentationsindex](docs/README.md)
|
|
749
|
-
- [Architekturüberblick](docs/architecture/overview.md)
|
|
750
|
-
- [API- und CLI-Verträge](docs/truth/contracts.md)
|
|
751
|
-
- [Init- und Scaffold-Verhalten](docs/truth/init-and-scaffold.md)
|
|
752
|
-
- [Check-Diagnostik](docs/truth/check-diagnostics.md)
|
|
753
|
-
- [Installierte Workflows](docs/truth/workflows/overview.md)
|
|
754
|
-
- [Leitfaden zur Pflege von Repository-
|
|
761
|
+
- [Architekturüberblick](docs/truthmark/truth/architecture/overview.md)
|
|
762
|
+
- [API- und CLI-Verträge](docs/truthmark/truth/contracts.md)
|
|
763
|
+
- [Init- und Scaffold-Verhalten](docs/truthmark/truth/init-and-scaffold.md)
|
|
764
|
+
- [Check-Diagnostik](docs/truthmark/truth/check-diagnostics.md)
|
|
765
|
+
- [Installierte Workflows](docs/truthmark/truth/workflows/overview.md)
|
|
766
|
+
- [Leitfaden zur Pflege von Repository-Truth](docs/standards/maintaining-repository-truth.md)
|
|
755
767
|
|
|
756
768
|
## Designgrenzen
|
|
757
769
|
|
|
@@ -771,7 +783,7 @@ Es ist nicht:
|
|
|
771
783
|
|
|
772
784
|
Diese Grenzen sind Teil des Produkts.
|
|
773
785
|
|
|
774
|
-
Truthmark hält den Workflow lokal,
|
|
786
|
+
Truthmark hält den Workflow lokal, versioniert, branch-gebunden und prüffähig.
|
|
775
787
|
|
|
776
788
|
## Sicherheit und Review-Disziplin
|
|
777
789
|
|
|
@@ -784,10 +796,10 @@ Teams sollten weiterhin:
|
|
|
784
796
|
- Truth-Doc-Änderungen prüfen
|
|
785
797
|
- Secrets aus der Dokumentation heraushalten
|
|
786
798
|
- repository-spezifische Instruktionen außerhalb verwalteter Blöcke halten
|
|
787
|
-
- Diffs generierter Workflow-
|
|
799
|
+
- Diffs generierter Workflow-Schnittstellen nach Upgrades prüfen
|
|
788
800
|
- menschliche Ownership über Produkt- und Architekturentscheidungen behalten
|
|
789
801
|
|
|
790
|
-
Truthmark macht
|
|
802
|
+
Truthmark macht agentenseitige Repository-Truth sichtbar. Es ersetzt menschliches Urteil nicht.
|
|
791
803
|
|
|
792
804
|
## Roadmap-Richtung
|
|
793
805
|
|
|
@@ -797,17 +809,17 @@ Die aktuelle Zukunftsrichtung betont:
|
|
|
797
809
|
- klarere Adoptionsbeispiele
|
|
798
810
|
- Beispiel-Repositories mit echten Truth-Sync-Zyklen
|
|
799
811
|
- Migrationsleitfäden für Teams, die bereits Agenten-Instruktionsdateien nutzen
|
|
800
|
-
- Konformitätstests für generierte Host-
|
|
812
|
+
- Konformitätstests für generierte Host-Schnittstellen
|
|
801
813
|
- route-aware Hinweise auf stale truth
|
|
802
814
|
- begrenzte Implementierungschecklisten für doc-first Arbeit
|
|
803
815
|
|
|
804
816
|
Der Schwerpunkt bleibt gleich:
|
|
805
817
|
|
|
806
818
|
```text
|
|
807
|
-
Repository-
|
|
819
|
+
Repository-Truth
|
|
808
820
|
agent-native Workflows
|
|
809
821
|
Git-Review
|
|
810
|
-
branch-
|
|
822
|
+
branch-gebundene Dokumentation
|
|
811
823
|
```
|
|
812
824
|
|
|
813
825
|
## Lizenz
|