truthmark 1.2.3 → 1.4.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 +104 -48
- package/README.es.md +98 -42
- package/README.md +54 -39
- package/README.ru.md +97 -41
- package/README.zh.md +95 -39
- package/dist/main.js +3960 -962
- package/dist/main.js.map +1 -1
- package/package.json +2 -2
package/README.de.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Truthmark
|
|
3
|
+
**Truthmark installiert Repository-Wahrheits-Workflows für KI-Softwareentwicklung.**
|
|
4
4
|
|
|
5
5
|
[English](README.md) | Deutsch | [中文](README.zh.md) | [Español](README.es.md) | [Русский](README.ru.md)
|
|
6
6
|
|
|
@@ -8,14 +8,14 @@
|
|
|
8
8
|
|
|
9
9
|
KI-Coding-Agenten schreiben bereits schnell Code. Der teure Teil ist, die Repository-Wahrheit mit den tatsächlichen Änderungen im Gleichschritt zu halten.
|
|
10
10
|
|
|
11
|
-
Truthmark fügt diesem Ablauf eine
|
|
11
|
+
Truthmark fügt diesem Ablauf eine Abschlusskontrolle als Workflow hinzu. Der normale Pfad ist einfach:
|
|
12
12
|
|
|
13
13
|
- Agent ändert funktionalen Code
|
|
14
14
|
- relevante Tests laufen
|
|
15
|
-
- Truth
|
|
15
|
+
- der installierte Truth-Sync-Workflow aktualisiert zugeordnete Wahrheitsdokumente, bevor der Agent fertig ist
|
|
16
16
|
- Truth-Doc-Diff prüfen, wenn einer erzeugt wurde
|
|
17
17
|
|
|
18
|
-
Die meisten Tools bitten Teams darum, sich eine Gewohnheit anzueignen. Truthmark
|
|
18
|
+
Die meisten Tools bitten Teams darum, sich eine Gewohnheit anzueignen. Truthmark macht daraus Repository-Workflow-Infrastruktur.
|
|
19
19
|
|
|
20
20
|
Truthmark macht aus einem KI-Workflow Repository-Infrastruktur statt persönlichem Tooling. Es installiert eine Git-native, branch-gebundene Wahrheitsschicht im Repository, gibt Agenten explizites Routing und begrenzte Workflow-Flächen und hält diese Wahrheit in Git prüfbar, statt sie über Prompt-Verlauf, veraltete Dokumentation oder privaten Tool-Zustand zu verstreuen.
|
|
21
21
|
|
|
@@ -51,12 +51,12 @@ Für Teams, die bereits wissen, dass Agenten Code erzeugen können, beantwortet
|
|
|
51
51
|
|
|
52
52
|
Truthmark versucht nicht, Agenten klüger wirken zu lassen. Es soll KI-gestützte Repository-Änderungen vertrauenswürdiger machen.
|
|
53
53
|
|
|
54
|
-
-
|
|
54
|
+
- Installierte Truth-Sync-Läufe nach Codeänderungen machen Dokumentationspflege zu einer Workflow-Schutzschicht statt zu einer Teamgewohnheit.
|
|
55
55
|
- Branch-gebundene Wahrheit bewegt sich mit dem Code, sodass Reviewer aktuelle Wahrheit in normalen Git-Diffs prüfen können.
|
|
56
56
|
- Repository-native Workflow-Flächen machen Rollout leichter und Übergaben robuster als reine Pro-User-Konfiguration.
|
|
57
57
|
- Explizites Routing in `docs/truthmark/areas.md` und delegierten untergeordneten Routendateien gibt Agenten Zuständigkeitsgrenzen und sicherere Schreibpfade.
|
|
58
58
|
- Local-first-Betrieb vermeidet einen Daemon, eine Datenbank, einen Remote-Dienst oder eine MCP-Abhängigkeit.
|
|
59
|
-
- Das Modell
|
|
59
|
+
- Das Routing-Modell ist sprachunabhängig, mit Coverage-Diagnostik für gängige JavaScript-, TypeScript-, Go-, Python-, C#- und Java-Codeflächen.
|
|
60
60
|
|
|
61
61
|
Für Tech Leads liegt der Wert in Governance ohne Zusatzinfrastruktur: Tests, Code Review und Ownership leisten weiterhin die eigentliche Arbeit; Truthmark macht den Kontext des Agenten dauerhaft, prüfbar und branch-gebunden.
|
|
62
62
|
|
|
@@ -96,6 +96,7 @@ Truthmark macht Repository-Wahrheit zu einer expliziten Workflow-Fläche für Ag
|
|
|
96
96
|
- `docs/truthmark/areas.md` und delegierte untergeordnete Routendateien ordnen Codebereiche den Dokumenten zu, die sie verantworten.
|
|
97
97
|
- Truth Document erstellt oder repariert kanonische Wahrheitsdokumente für bereits implementiertes Verhalten, wenn keine Codeänderung nötig ist.
|
|
98
98
|
- Truth Sync hält zugeordnete Wahrheitsdokumente bei funktionalen Änderungen synchron.
|
|
99
|
+
- Truth Preview zeigt wahrscheinliches Workflow-Routing vor Änderungen an, ohne Schreibzugriffe zu autorisieren.
|
|
99
100
|
- Truth Realize gibt doc-first Änderungen einen begrenzten Pfad für Code-Updates.
|
|
100
101
|
- `truthmark check` validiert die daraus entstehenden Wahrheitsartefakte.
|
|
101
102
|
- Das gesamte Modell bleibt local-first und Git-nativ.
|
|
@@ -132,17 +133,17 @@ Prüfe `.truthmark/config.yml` vor `init`; es ist der in Git festgeschriebene Hi
|
|
|
132
133
|
.truthmark/config.yml
|
|
133
134
|
docs/truthmark/areas.md
|
|
134
135
|
docs/truthmark/areas/repository.md
|
|
135
|
-
docs/templates/
|
|
136
|
-
docs/
|
|
137
|
-
docs/
|
|
138
|
-
docs/
|
|
136
|
+
docs/templates/behavior-doc.md
|
|
137
|
+
docs/truth/README.md
|
|
138
|
+
docs/truth/repository/README.md
|
|
139
|
+
docs/truth/repository/overview.md
|
|
139
140
|
AGENTS.md
|
|
140
141
|
CLAUDE.md
|
|
141
142
|
GEMINI.md
|
|
142
143
|
```
|
|
143
144
|
|
|
144
145
|
Unterstützte Plattformen sind `codex`, `opencode`, `claude-code`, `github-copilot` und `gemini-cli`. Die Standardkonfiguration enthält alle davon; entferne Plattformen, die du nicht nutzt, aus `.truthmark/config.yml`, bevor du `truthmark init` erneut ausführst.
|
|
145
|
-
Die standardmäßig erzeugte Struktur verwendet
|
|
146
|
+
Die standardmäßig erzeugte Struktur verwendet Truth-`README.md`-Dateien als Indizes und beginnt die Wahrheit über aktuelles Verhalten in begrenzten Blattdokumenten wie `docs/truth/repository/overview.md`.
|
|
146
147
|
|
|
147
148
|
Bestehende Repositories brauchen nach `init` meist einen Aufräumschritt: Führe den installierten Truth-Structure-Workflow aus, wenn die erzeugte `repository`-Route zu breit ist, Ownership mehrere Produkte oder Services umfasst oder Routendateien noch auf Platzhalterdokumente zeigen. Truth Structure teilt breite Routings auf, erstellt oder repariert erste kanonische Wahrheitsdokumente und gibt Truth Sync präzise Ziele, bevor funktionale Codearbeit beginnt. Codex, Claude Code und unterstützte Copilot-IDEs können ihn mit `/truthmark-structure` aufrufen; Hosts im OpenCode-Stil können `/skill truthmark-structure` verwenden.
|
|
148
149
|
|
|
@@ -150,51 +151,88 @@ Bestehende Repositories brauchen nach `init` meist einen Aufräumschritt: Führe
|
|
|
150
151
|
|
|
151
152
|
Truthmark ist am stärksten auf dem Standardpfad, nicht als Sammlung manueller Befehle. Der handelnde Agent und die Host-Umgebung entscheiden, ob delegiert oder der installierte Workflow inline ausgeführt wird.
|
|
152
153
|
|
|
153
|
-
|
|
154
|
+
### Vorhandenes Verhalten ohne Doku
|
|
154
155
|
|
|
155
|
-
|
|
156
|
+
Nutze das, wenn die Implementierung bereits existiert, aber die kanonischen Wahrheitsdokumente fehlen oder schwach sind:
|
|
156
157
|
|
|
157
158
|
```text
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
159
|
+
benutzer identifiziert ein implementiertes verhalten oder einen api-endpunkt
|
|
160
|
+
benutzer ruft truth document ausdrücklich auf
|
|
161
|
+
agent liest implementierung, tests, routing und vorhandene docs
|
|
162
|
+
agent schreibt nur truth docs und routing
|
|
163
|
+
truth-doc-diff prüfen
|
|
163
164
|
```
|
|
164
165
|
|
|
165
|
-
Truth
|
|
166
|
+
Truth Document ist manuell und implementation-first: Code dient als Beleg, Wahrheitsdokumente werden erstellt oder repariert, und funktionaler Code darf nicht geändert werden. Codex, Claude Code und unterstützte Copilot-IDEs können es mit `/truthmark-document` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-document` verwenden.
|
|
167
|
+
|
|
168
|
+
```text
|
|
169
|
+
/truthmark-document dokumentiere das implementierte session-timeout-verhalten unter docs/truth/authentication
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Normale Codeänderungen
|
|
173
|
+
|
|
174
|
+
Die meisten Nutzer sollten Truth Sync nicht direkt aufrufen müssen. Entscheidend ist, dass der installierte Agenten-Workflow Truth Sync als Abschlusskontrolle behandelt, wenn funktionaler Code geändert wurde. Der normale Ablauf ist:
|
|
175
|
+
|
|
176
|
+
```text
|
|
177
|
+
agent ändert funktionalen code
|
|
178
|
+
relevante tests laufen
|
|
179
|
+
der installierte truth-sync-workflow läuft, bevor der agent fertig ist
|
|
180
|
+
truth-doc-diff prüfen, falls einer erzeugt wurde
|
|
181
|
+
arbeit committen oder übergeben
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
Truth Sync ist code-first: Code führt, Wahrheitsdokumente folgen, und Truth Sync darf funktionalen Code nicht umschreiben. Seine Hauptaufgabe ist, über den installierten Agenten-Workflow als Abschlusskontrolle zu laufen, wenn funktionaler Code geändert wurde. Direkte Aufrufe sind vor allem für Fehlersuche, frühe Synchronisierung vor einer Übergabe oder bewusstes Ausführen des Workflows gedacht.
|
|
185
|
+
|
|
166
186
|
Codex, Claude Code und unterstützte Copilot-IDEs können es mit `/truthmark-sync` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-sync` verwenden.
|
|
167
|
-
Nutze diesen Ablauf, wenn eine Produkt- oder Architekturentscheidung in der Dokumentation beginnt:
|
|
168
187
|
|
|
169
188
|
```text
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
189
|
+
/truthmark-sync die repository-wahrheit jetzt vor der übergabe synchronisieren
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Doc-first-Änderungen
|
|
193
|
+
|
|
194
|
+
Nutze das, wenn eine Produkt- oder Architekturentscheidung in der Doku beginnt:
|
|
195
|
+
|
|
196
|
+
```text
|
|
197
|
+
benutzer bearbeitet wahrheitsdokumente
|
|
198
|
+
benutzer ruft truth realize ausdrücklich auf
|
|
199
|
+
agent liest wahrheitsdokumente und relevanten code
|
|
200
|
+
agent aktualisiert nur code
|
|
201
|
+
relevante tests laufen
|
|
202
|
+
arbeit committen oder übergeben
|
|
176
203
|
```
|
|
177
204
|
|
|
178
205
|
Truth Realize ist manuell und doc-first: Wahrheitsdokumente führen, Code folgt, und der Agent darf die Wahrheitsdokumente, die er realisiert, nicht bearbeiten.
|
|
206
|
+
|
|
179
207
|
Codex, Claude Code und unterstützte Copilot-IDEs können es mit `/truthmark-realize` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-realize` verwenden.
|
|
180
208
|
|
|
209
|
+
```text
|
|
210
|
+
/truthmark-realize docs/truth/authentication/session-timeout.md in code umsetzen
|
|
211
|
+
```
|
|
212
|
+
|
|
181
213
|
## Was es installiert
|
|
182
214
|
|
|
183
215
|
Truthmark hält die dauerhafte Workflow-Fläche klein und repository-nativ. Nach `truthmark init` trägt das Repository selbst Routing, Regeln und installierte Workflow-Flächen, sodass Teams nicht nur auf die lokale Konfiguration einer einzelnen Person angewiesen sind.
|
|
184
216
|
|
|
185
|
-
|
|
186
|
-
|
|
217
|
+
Truthmark installiert zwei getrennte Oberflächen:
|
|
218
|
+
|
|
219
|
+
- menschenorientierte CLI-Befehle, die Menschen oder CI ausführen, um das Repository zu konfigurieren, installierte Dateien zu aktualisieren, Truth-Artefakte zu validieren und optional abgeleiteten Review-Kontext zu erzeugen
|
|
220
|
+
- Agenten-Workflow-Flächen, die Coding-Agenten oder Agenten-Hosts während Implementierungsworkflows aufrufen; sie sind keine zusätzlichen täglichen Terminalbefehle für Menschen
|
|
221
|
+
|
|
222
|
+
- `.truthmark/config.yml` für den maschinenlesbaren, festgeschriebenen Hierarchievertrag
|
|
187
223
|
- `docs/truthmark/areas.md` für den Root-Routenindex
|
|
188
224
|
- `docs/truthmark/areas/**/*.md` für delegierte untergeordnete Routendateien
|
|
189
|
-
- `docs/templates/
|
|
225
|
+
- `docs/templates/behavior-doc.md` sowie die weiteren typspezifischen Vorlagen unter `docs/templates/` für die editierbaren Truth-Doc-Standards der generierten Workflows
|
|
190
226
|
- verwaltete Instruktionsblöcke für konfigurierte Plattformen wie `AGENTS.md`, `CLAUDE.md`, Copilot-Anweisungen und `GEMINI.md`
|
|
191
|
-
- host-native Skills, Prompts oder Commands für Truth Structure, Truth Document, Truth Sync, Truth Realize und Truth Check
|
|
227
|
+
- host-native Skills, Prompts oder Commands für Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize und Truth Check
|
|
228
|
+
- projektbezogene schreibgeschützte Codex-, Claude-Code-, GitHub-Copilot- und OpenCode-Prüfer plus geleaste `truth-doc-writer`-Agenten, wo Hosts Agenten unterstützen, unter `.codex/agents/`, `.claude/agents/`, `.github/agents/` und `.opencode/agents/` für workflow-eigene Audits und vom Parent geleaste Dokument-Shards
|
|
192
229
|
|
|
193
230
|
Die installierten Workflow-Flächen sind die Runtime:
|
|
194
231
|
|
|
195
232
|
- Truth Structure erstellt oder repariert Area-Routing und erste Wahrheitsdokumente.
|
|
196
233
|
- Truth Document erstellt oder repariert Wahrheitsdokumente für bereits implementiertes Verhalten.
|
|
197
234
|
- Truth Sync hält zugeordnete Wahrheitsdokumente bei funktionalen Änderungen synchron.
|
|
235
|
+
- Truth Preview zeigt wahrscheinliches Workflow-Routing vor Änderungen an, ohne Dateien zu schreiben.
|
|
198
236
|
- Truth Realize aktualisiert Code so, dass er zu den Wahrheitsdokumenten passt.
|
|
199
237
|
- Truth Check auditiert die Gesundheit der Repository-Wahrheit.
|
|
200
238
|
|
|
@@ -204,20 +242,33 @@ Generierte Flächen werden von Truthmark verwaltet, enthalten einen Versionsmark
|
|
|
204
242
|
|
|
205
243
|
## Befehle
|
|
206
244
|
|
|
207
|
-
Truthmark V1 hält die CLI
|
|
245
|
+
Truthmark V1 hält die Terminal-CLI fokussiert. Die meisten menschlichen Nutzer brauchen nur Einrichtung, Aktualisierung und Validierung:
|
|
208
246
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
truthmark
|
|
212
|
-
truthmark
|
|
213
|
-
truthmark
|
|
214
|
-
|
|
215
|
-
|
|
247
|
+
| Menschenorientierter CLI-Befehl | Zweck |
|
|
248
|
+
| -------------------------------- | ----- |
|
|
249
|
+
| `truthmark config` | Erstellt `.truthmark/config.yml`; schreibt nur diese Datei, außer `--stdout` wird verwendet. |
|
|
250
|
+
| `truthmark init` | Installiert oder aktualisiert lokale Workflow-Dateien aus der geprüften Konfiguration. |
|
|
251
|
+
| `truthmark check` | Validiert Konfiguration, Autorität, Routing, entscheidungstragende Dokumente, Frontmatter, interne Links, Branch-Scope und Coverage-Diagnostik. |
|
|
252
|
+
|
|
253
|
+
Die übrigen CLI-Befehle sind optionale Repository-Intelligence-Helfer. Sie erzeugen abgeleiteten Review-Kontext für den aktiven Checkout; sie sind keine Quellen der Wahrheit:
|
|
216
254
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
`
|
|
220
|
-
|
|
255
|
+
| Optionaler CLI-Befehl | Zweck |
|
|
256
|
+
| --------------------- | ----- |
|
|
257
|
+
| `truthmark index` | Baut RepoIndex- und RouteMap-JSON für den aktiven Checkout. |
|
|
258
|
+
| `truthmark impact --base <ref>` | Ordnet geänderte Dateien den gerouteten Truth-Dokumenten, zuständigen Routen, nahen Tests und öffentlichen Symbolen zu. |
|
|
259
|
+
| `truthmark context --workflow <workflow> [--base <ref>]` | Erzeugt ein begrenztes ContextPack für Truth Sync, Truth Document oder Truth Realize. `--format markdown` rendert eine menschenlesbare Fassung. |
|
|
260
|
+
|
|
261
|
+
Alle oben genannten CLI-Befehle unterstützen `--json`, wenn strukturierte Ausgabe für Automatisierung nützlich ist.
|
|
262
|
+
|
|
263
|
+
Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize und Truth Check sind installierte Agenten-Workflows, keine täglichen Top-Level-CLI-Befehle.
|
|
264
|
+
|
|
265
|
+
Sie laufen über die konfigurierten Agenten-Host-Flächen, zum Beispiel Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*` oder Gemini `/truthmark:*`.
|
|
266
|
+
|
|
267
|
+
Diese Aufrufe wirken befehlsartig, weil Agenten-Hosts Skills über Slash-Commands bereitstellen. Behandle sie als Anweisungen an einen Agenten, nicht als Terminalbefehle, die Menschen ausführen sollen.
|
|
268
|
+
|
|
269
|
+
```text
|
|
270
|
+
/truthmark-check routing und truth-abdeckung vor der review prüfen
|
|
271
|
+
```
|
|
221
272
|
|
|
222
273
|
## Warum es existiert
|
|
223
274
|
|
|
@@ -236,15 +287,20 @@ Es geht davon aus, dass ernsthafte Teams Folgendes brauchen:
|
|
|
236
287
|
## Projektstatus
|
|
237
288
|
|
|
238
289
|
Truthmark ist kein Memory-Server und kein MCP-Server. Es ist eine Repository-Praxis, verpackt als kleiner CLI-Installer plus agent-native Workflow-Flächen, die KI-Workflow-Regeln in Repository-Infrastruktur verwandeln.
|
|
290
|
+
|
|
239
291
|
V1 bietet derzeit:
|
|
240
292
|
|
|
241
293
|
- `truthmark config`
|
|
242
294
|
- `truthmark init`
|
|
243
295
|
- `truthmark check`
|
|
296
|
+
- `truthmark index`
|
|
297
|
+
- `truthmark impact`
|
|
298
|
+
- `truthmark context`
|
|
244
299
|
- verwaltete `AGENTS.md`-Workflow-Anweisungen
|
|
245
|
-
- generierte
|
|
300
|
+
- generierte Truth Structure-, Truth Document-, Truth Sync-, Truth Preview-, Truth Realize- und Truth Check-Skill-Flächen für konfigurierte Agenten-Hosts
|
|
246
301
|
- Branch-Scope-Metadaten
|
|
247
|
-
- Diagnostik für Konfiguration, Autorität, Routing, Entscheidungsstruktur, Frontmatter, Links und polyglotte Abdeckung
|
|
302
|
+
- Diagnostik für Konfiguration, Autorität, Routing, Entscheidungsstruktur, Frontmatter, Links, Freshness und polyglotte Abdeckung
|
|
303
|
+
- abgeleitete RepoIndex-, RouteMap-, ImpactSet- und ContextPack-Artefakte für schnellere lokale Prüfung, wenn die CLI verfügbar ist
|
|
248
304
|
|
|
249
305
|
## Dokumentation
|
|
250
306
|
|
|
@@ -252,10 +308,10 @@ Die Root-README ist für Menschen gedacht, die das Paket evaluieren und ausprobi
|
|
|
252
308
|
|
|
253
309
|
- [Dokumentationsindex](docs/README.md)
|
|
254
310
|
- [Architekturüberblick](docs/architecture/overview.md)
|
|
255
|
-
- [API- und CLI-Verträge](docs/
|
|
256
|
-
- [Init- und Scaffold-Verhalten](docs/
|
|
257
|
-
- [Check-Diagnostik](docs/
|
|
258
|
-
- [Installierte Workflows](docs/
|
|
311
|
+
- [API- und CLI-Verträge](docs/truth/contracts.md)
|
|
312
|
+
- [Init- und Scaffold-Verhalten](docs/truth/init-and-scaffold.md)
|
|
313
|
+
- [Check-Diagnostik](docs/truth/check-diagnostics.md)
|
|
314
|
+
- [Installierte Workflows](docs/truth/workflows/overview.md)
|
|
259
315
|
- [Leitfaden zur Pflege von Repository-Wahrheit](docs/standards/maintaining-repository-truth.md)
|
|
260
316
|
|
|
261
317
|
Aktuelles Verhalten gehört in den oben genannten kanonischen Dokumentationsbaum.
|
package/README.es.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Truthmark
|
|
3
|
+
**Truthmark instala flujos de verdad del repositorio para el desarrollo de software con IA.**
|
|
4
4
|
|
|
5
5
|
[English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | Español | [Русский](README.ru.md)
|
|
6
6
|
|
|
@@ -8,14 +8,14 @@
|
|
|
8
8
|
|
|
9
9
|
Los agentes de programación con IA ya escriben código rápido. La parte costosa es mantener alineada la verdad del repositorio con lo que realmente cambió.
|
|
10
10
|
|
|
11
|
-
Truthmark añade una
|
|
11
|
+
Truthmark añade una guarda de cierre basada en flujo de trabajo. El camino normal es simple:
|
|
12
12
|
|
|
13
13
|
- el agente cambia código funcional
|
|
14
14
|
- se ejecutan las pruebas relevantes
|
|
15
|
-
- Truth Sync actualiza los documentos de verdad asignados antes de que el agente termine
|
|
15
|
+
- el flujo instalado Truth Sync actualiza los documentos de verdad asignados antes de que el agente termine
|
|
16
16
|
- se revisa el diff de documentos de verdad si se produjo uno
|
|
17
17
|
|
|
18
|
-
La mayoría de las herramientas pide al equipo adoptar un hábito. Truthmark
|
|
18
|
+
La mayoría de las herramientas pide al equipo adoptar un hábito. Truthmark convierte ese hábito en infraestructura de flujo del repositorio.
|
|
19
19
|
|
|
20
20
|
Truthmark convierte un flujo de trabajo con IA en infraestructura del repositorio, no en tooling personal. Instala una capa de verdad nativa de Git y acotada a la rama dentro del propio repositorio, da a los agentes rutas explícitas y superficies de trabajo acotadas, y mantiene esa verdad revisable en Git en lugar de dispersarla por el historial de prompts, documentación obsoleta o estado privado de herramientas.
|
|
21
21
|
|
|
@@ -51,12 +51,12 @@ Para equipos que ya saben que los agentes pueden generar código, Truthmark resp
|
|
|
51
51
|
|
|
52
52
|
Truthmark no intenta hacer que los agentes suenen más inteligentes. Intenta que los cambios de repositorio asistidos por IA sean más confiables.
|
|
53
53
|
|
|
54
|
-
-
|
|
54
|
+
- El flujo instalado Truth Sync tras cambios de código convierte el mantenimiento de documentación en una salvaguarda del flujo, no en un hábito del equipo.
|
|
55
55
|
- La verdad acotada a la rama viaja con el código, de modo que quienes revisan pueden inspeccionar la verdad actual en diffs normales de Git.
|
|
56
56
|
- Las superficies de flujo nativas del repositorio hacen el despliegue más ligero y los traspasos más resistentes que una simple configuración por usuario.
|
|
57
57
|
- El enrutamiento explícito en `docs/truthmark/areas.md` y en archivos de rutas secundarias delegadas da a los agentes límites de responsabilidad y rutas de escritura más seguras.
|
|
58
58
|
- La operación local-first evita depender de un demonio, una base de datos, un servicio remoto o MCP.
|
|
59
|
-
- El modelo
|
|
59
|
+
- El modelo de enrutamiento es independiente del lenguaje, con diagnósticos de cobertura para superficies comunes de código JavaScript, TypeScript, Go, Python, C# y Java.
|
|
60
60
|
|
|
61
61
|
Para responsables técnicos, el valor es gobernanza sin infraestructura extra: las pruebas, la revisión de código y la propiedad siguen haciendo el trabajo real; Truthmark vuelve el contexto del agente duradero, inspeccionable y acotado a la rama.
|
|
62
62
|
|
|
@@ -96,6 +96,7 @@ Truthmark convierte la verdad del repositorio en una superficie explícita de fl
|
|
|
96
96
|
- `docs/truthmark/areas.md` y los archivos de rutas secundarias delegadas asignan áreas de código a los documentos que las gobiernan.
|
|
97
97
|
- Truth Document genera o repara documentos de verdad canónica para comportamiento ya implementado cuando no hace falta cambiar código.
|
|
98
98
|
- Truth Sync mantiene alineados los documentos de verdad asignados cuando hay cambios funcionales.
|
|
99
|
+
- Truth Preview previsualiza el enrutamiento de flujo probable antes de editar, sin autorizar escrituras.
|
|
99
100
|
- Truth Realize ofrece a los cambios que empiezan en documentación una ruta acotada para actualizar código.
|
|
100
101
|
- `truthmark check` valida los artefactos de verdad resultantes.
|
|
101
102
|
- Todo el modelo se mantiene local-first y nativo de Git.
|
|
@@ -132,17 +133,17 @@ Revisa `.truthmark/config.yml` antes de `init`; es el contrato de jerarquía con
|
|
|
132
133
|
.truthmark/config.yml
|
|
133
134
|
docs/truthmark/areas.md
|
|
134
135
|
docs/truthmark/areas/repository.md
|
|
135
|
-
docs/templates/
|
|
136
|
-
docs/
|
|
137
|
-
docs/
|
|
138
|
-
docs/
|
|
136
|
+
docs/templates/behavior-doc.md
|
|
137
|
+
docs/truth/README.md
|
|
138
|
+
docs/truth/repository/README.md
|
|
139
|
+
docs/truth/repository/overview.md
|
|
139
140
|
AGENTS.md
|
|
140
141
|
CLAUDE.md
|
|
141
142
|
GEMINI.md
|
|
142
143
|
```
|
|
143
144
|
|
|
144
145
|
Las plataformas compatibles son `codex`, `opencode`, `claude-code`, `github-copilot` y `gemini-cli`. La configuración predeterminada las incluye todas; elimina de `.truthmark/config.yml` las plataformas que no uses antes de volver a ejecutar `truthmark init`.
|
|
145
|
-
La estructura generada por defecto usa los `README.md` de
|
|
146
|
+
La estructura generada por defecto usa los `README.md` de verdad como índices y empieza la verdad sobre el comportamiento actual en documentos hoja acotados, como `docs/truth/repository/overview.md`.
|
|
146
147
|
|
|
147
148
|
Los repositorios existentes suelen necesitar una pasada de limpieza después de `init`: ejecuta el flujo instalado Truth Structure cuando la ruta `repository` generada sea demasiado amplia, la propiedad abarque varios productos o servicios, o los archivos de rutas sigan apuntando a documentos de marcador de posición. Truth Structure divide rutas amplias, crea o repara documentos de verdad canónica iniciales y da a Truth Sync destinos precisos antes de que empiece el trabajo de código funcional. Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-structure`; los hosts de estilo OpenCode pueden usar `/skill truthmark-structure`.
|
|
148
149
|
|
|
@@ -150,51 +151,88 @@ Los repositorios existentes suelen necesitar una pasada de limpieza después de
|
|
|
150
151
|
|
|
151
152
|
Truthmark es más fuerte en el camino por defecto, no como un conjunto de comandos manuales. El agente que actúa y el entorno anfitrión deciden si delegan o ejecutan el flujo instalado en línea.
|
|
152
153
|
|
|
153
|
-
|
|
154
|
+
### Comportamiento existente sin docs
|
|
154
155
|
|
|
155
|
-
|
|
156
|
+
Usa esto cuando la implementación ya existe pero faltan o son débiles los documentos de verdad canónica:
|
|
157
|
+
|
|
158
|
+
```text
|
|
159
|
+
el usuario identifica un comportamiento implementado o un endpoint de api
|
|
160
|
+
el usuario invoca explícitamente truth document
|
|
161
|
+
el agente lee implementación, pruebas, rutas y docs existentes
|
|
162
|
+
el agente solo escribe truth docs y rutas
|
|
163
|
+
revisar el diff de truth docs
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Truth Document es manual y con prioridad de implementación: el código sirve como evidencia, los documentos de verdad se crean o reparan, y no se debe cambiar código funcional. Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-document`; los hosts de estilo OpenCode pueden usar `/skill truthmark-document`.
|
|
167
|
+
|
|
168
|
+
```text
|
|
169
|
+
/truthmark-document documenta el comportamiento implementado del timeout de sesión en docs/truth/authentication
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Cambios de código normales
|
|
173
|
+
|
|
174
|
+
La mayoría de los usuarios no debería invocar Truth Sync directamente. Lo importante es que el flujo instalado del agente trate Truth Sync como una guarda de cierre cuando cambió código funcional. El flujo normal es:
|
|
156
175
|
|
|
157
176
|
```text
|
|
158
177
|
el agente cambia código funcional
|
|
159
178
|
se ejecutan las pruebas relevantes
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
179
|
+
el flujo instalado truth sync se ejecuta antes de que el agente termine
|
|
180
|
+
revisar el diff de truth docs si se produjo uno
|
|
181
|
+
confirmar o entregar el trabajo
|
|
163
182
|
```
|
|
164
183
|
|
|
165
|
-
Truth Sync es code-first: el código lidera, los documentos de verdad siguen, y Truth Sync no debe reescribir código funcional. Su tarea principal es
|
|
184
|
+
Truth Sync es code-first: el código lidera, los documentos de verdad siguen, y Truth Sync no debe reescribir código funcional. Su tarea principal es ejecutarse mediante el flujo instalado del agente como guarda de cierre cuando cambió código funcional. La invocación directa se usa sobre todo para depurar, forzar una sincronización temprana antes de entregar el trabajo o ejecutar el flujo de forma intencional.
|
|
185
|
+
|
|
166
186
|
Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-sync`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-sync`.
|
|
187
|
+
|
|
188
|
+
```text
|
|
189
|
+
/truthmark-sync sincroniza ahora la verdad del repositorio antes de la entrega
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Cambios doc-first
|
|
193
|
+
|
|
167
194
|
Usa este flujo cuando una decisión de producto o arquitectura empieza en la documentación:
|
|
168
195
|
|
|
169
196
|
```text
|
|
170
|
-
el usuario edita
|
|
171
|
-
el usuario invoca explícitamente
|
|
172
|
-
el agente lee
|
|
197
|
+
el usuario edita truth docs
|
|
198
|
+
el usuario invoca explícitamente truth realize
|
|
199
|
+
el agente lee truth docs y el código relevante
|
|
173
200
|
el agente actualiza solo el código
|
|
174
201
|
se ejecutan las pruebas relevantes
|
|
175
|
-
|
|
202
|
+
confirmar o entregar el trabajo
|
|
176
203
|
```
|
|
177
204
|
|
|
178
205
|
Truth Realize es manual y doc-first: los documentos de verdad lideran, el código sigue, y el agente no debe editar los documentos de verdad que está realizando.
|
|
206
|
+
|
|
179
207
|
Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-realize`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-realize`.
|
|
180
208
|
|
|
209
|
+
```text
|
|
210
|
+
/truthmark-realize realiza docs/truth/authentication/session-timeout.md como código
|
|
211
|
+
```
|
|
212
|
+
|
|
181
213
|
## Qué instala
|
|
182
214
|
|
|
183
215
|
Truthmark mantiene pequeña y nativa del repositorio la superficie duradera de flujo de trabajo. Después de `truthmark init`, el propio repositorio lleva el enrutamiento, las reglas y las superficies instaladas, así que el equipo no depende solo de la configuración local de una persona.
|
|
184
216
|
|
|
185
|
-
|
|
186
|
-
|
|
217
|
+
Truthmark instala dos superficies distintas:
|
|
218
|
+
|
|
219
|
+
- comandos CLI orientados a personas, ejecutados por personas o CI para configurar el repositorio, refrescar archivos instalados, validar artefactos de verdad y generar opcionalmente contexto derivado para revisión
|
|
220
|
+
- superficies de flujo de trabajo para agentes, invocadas por agentes de código u hosts de agentes durante flujos de implementación; no son comandos de terminal diarios adicionales para personas
|
|
221
|
+
|
|
222
|
+
- `.truthmark/config.yml` para el contrato de jerarquía confirmado y legible por máquina
|
|
187
223
|
- `docs/truthmark/areas.md` para el índice raíz de rutas
|
|
188
224
|
- `docs/truthmark/areas/**/*.md` para archivos de rutas secundarias delegadas
|
|
189
|
-
- `docs/templates/
|
|
225
|
+
- `docs/templates/behavior-doc.md` y las demás plantillas específicas por tipo bajo `docs/templates/` para los estándares editables de truth docs usados por los flujos generados
|
|
190
226
|
- bloques de instrucciones administrados para plataformas configuradas como `AGENTS.md`, `CLAUDE.md`, instrucciones de Copilot y `GEMINI.md`
|
|
191
|
-
- skills, prompts o comandos nativos del host para Truth Structure, Truth Document, Truth Sync, Truth Realize y Truth Check
|
|
227
|
+
- skills, prompts o comandos nativos del host para Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize y Truth Check
|
|
228
|
+
- verificadores de solo lectura de Codex, Claude Code, GitHub Copilot y OpenCode con alcance de proyecto, más agentes `truth-doc-writer` con lease donde el host admite agentes, bajo `.codex/agents/`, `.claude/agents/`, `.github/agents/` y `.opencode/agents/` para auditorías propias del flujo y shards de documentación concedidos por el padre
|
|
192
229
|
|
|
193
230
|
Las superficies de flujo de trabajo instaladas son el entorno de ejecución:
|
|
194
231
|
|
|
195
232
|
- Truth Structure crea o repara el enrutamiento de áreas y documentos de verdad iniciales.
|
|
196
233
|
- Truth Document crea o repara documentos de verdad para comportamiento ya implementado.
|
|
197
234
|
- Truth Sync mantiene alineados los documentos de verdad asignados con los cambios funcionales.
|
|
235
|
+
- Truth Preview previsualiza el enrutamiento de flujo probable antes de editar sin escribir archivos.
|
|
198
236
|
- Truth Realize actualiza el código para que coincida con los documentos de verdad.
|
|
199
237
|
- Truth Check audita la salud de la verdad del repositorio.
|
|
200
238
|
|
|
@@ -204,20 +242,33 @@ Las superficies generadas son administradas por Truthmark, incluyen un marcador
|
|
|
204
242
|
|
|
205
243
|
## Comandos
|
|
206
244
|
|
|
207
|
-
Truthmark V1 mantiene la CLI
|
|
245
|
+
Truthmark V1 mantiene enfocada la CLI de terminal. La mayoría de los usuarios humanos solo necesita configuración, actualización y validación:
|
|
208
246
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
truthmark
|
|
212
|
-
truthmark
|
|
213
|
-
truthmark
|
|
214
|
-
|
|
215
|
-
|
|
247
|
+
| CLI orientada a personas | Uso |
|
|
248
|
+
| ------------------------ | --- |
|
|
249
|
+
| `truthmark config` | Crea `.truthmark/config.yml`; solo escribe ese archivo, salvo que se use `--stdout`. |
|
|
250
|
+
| `truthmark init` | Instala o refresca los archivos locales de flujo de trabajo desde la configuración revisada. |
|
|
251
|
+
| `truthmark check` | Valida configuración, autoridad, enrutamiento, documentos que contienen decisiones, frontmatter, enlaces internos, alcance de rama y diagnósticos de cobertura. |
|
|
252
|
+
|
|
253
|
+
Los demás comandos CLI son ayudantes opcionales de inteligencia del repositorio. Generan contexto derivado para revisión sobre el checkout activo; no son fuentes de verdad:
|
|
216
254
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
`
|
|
220
|
-
|
|
255
|
+
| CLI opcional | Uso |
|
|
256
|
+
| ------------ | --- |
|
|
257
|
+
| `truthmark index` | Construye JSON de RepoIndex y RouteMap para el checkout activo. |
|
|
258
|
+
| `truthmark impact --base <ref>` | Mapea los archivos cambiados a truth docs enrutados, rutas propietarias, pruebas cercanas y símbolos públicos. |
|
|
259
|
+
| `truthmark context --workflow <workflow> [--base <ref>]` | Genera un ContextPack acotado para Truth Sync, Truth Document o Truth Realize. `--format markdown` lo renderiza en un formato legible para personas. |
|
|
260
|
+
|
|
261
|
+
Todos los comandos CLI anteriores admiten `--json` cuando la salida estructurada es útil para automatización.
|
|
262
|
+
|
|
263
|
+
Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize y Truth Check son flujos de trabajo instalados para agentes, no comandos CLI principales de uso diario.
|
|
264
|
+
|
|
265
|
+
Se ejecutan a través de las superficies configuradas del host agente, por ejemplo Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*` o Gemini `/truthmark:*`.
|
|
266
|
+
|
|
267
|
+
Estas invocaciones parecen comandos porque los hosts de agentes exponen skills mediante slash commands. Trátalas como instrucciones para un agente, no como comandos de terminal que una persona deba ejecutar.
|
|
268
|
+
|
|
269
|
+
```text
|
|
270
|
+
/truthmark-check audita el enrutamiento y la cobertura de verdad antes de la revisión
|
|
271
|
+
```
|
|
221
272
|
|
|
222
273
|
## Por qué existe
|
|
223
274
|
|
|
@@ -236,15 +287,20 @@ Asume que los equipos serios necesitan:
|
|
|
236
287
|
## Estado del proyecto
|
|
237
288
|
|
|
238
289
|
Truthmark no es un servidor de memoria ni un servidor MCP. Es una práctica de repositorio empaquetada como un pequeño instalador CLI más superficies de flujo de trabajo nativas para agentes que convierten las reglas del flujo de IA en infraestructura del repositorio.
|
|
290
|
+
|
|
239
291
|
V1 actualmente ofrece:
|
|
240
292
|
|
|
241
293
|
- `truthmark config`
|
|
242
294
|
- `truthmark init`
|
|
243
295
|
- `truthmark check`
|
|
296
|
+
- `truthmark index`
|
|
297
|
+
- `truthmark impact`
|
|
298
|
+
- `truthmark context`
|
|
244
299
|
- instrucciones de flujo de trabajo administradas en `AGENTS.md`
|
|
245
|
-
- superficies de skill generadas para Truth Structure, Truth Document, Truth Sync, Truth Realize y Truth Check en los anfitriones de agentes configurados
|
|
300
|
+
- superficies de skill generadas para Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize y Truth Check en los anfitriones de agentes configurados
|
|
246
301
|
- metadatos de alcance de rama
|
|
247
302
|
- diagnósticos de configuración, autoridad, enrutamiento, estructura de decisiones, frontmatter, enlaces y cobertura políglota
|
|
303
|
+
- artefactos derivados de RepoIndex, RouteMap, ImpactSet y ContextPack para una revisión local más rápida cuando la CLI está disponible
|
|
248
304
|
|
|
249
305
|
## Documentación
|
|
250
306
|
|
|
@@ -252,10 +308,10 @@ El README raíz es para personas que evalúan y prueban el paquete. Las especifi
|
|
|
252
308
|
|
|
253
309
|
- [Índice de documentación](docs/README.md)
|
|
254
310
|
- [Resumen de arquitectura](docs/architecture/overview.md)
|
|
255
|
-
- [Contratos de API y CLI](docs/
|
|
256
|
-
- [Comportamiento de init y scaffold](docs/
|
|
257
|
-
- [Diagnósticos de check](docs/
|
|
258
|
-
- [Flujos de trabajo instalados](docs/
|
|
311
|
+
- [Contratos de API y CLI](docs/truth/contracts.md)
|
|
312
|
+
- [Comportamiento de init y scaffold](docs/truth/init-and-scaffold.md)
|
|
313
|
+
- [Diagnósticos de check](docs/truth/check-diagnostics.md)
|
|
314
|
+
- [Flujos de trabajo instalados](docs/truth/workflows/overview.md)
|
|
259
315
|
- [Guía para mantener la verdad del repositorio](docs/standards/maintaining-repository-truth.md)
|
|
260
316
|
|
|
261
317
|
El comportamiento actual pertenece al árbol canónico de documentación anterior.
|