truthmark 1.2.3 → 1.3.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 +92 -36
- package/README.es.md +85 -29
- package/README.md +41 -26
- package/README.ru.md +84 -28
- package/README.zh.md +82 -26
- package/dist/main.js +2865 -1012
- 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
|
|
|
@@ -132,17 +132,17 @@ Prüfe `.truthmark/config.yml` vor `init`; es ist der in Git festgeschriebene Hi
|
|
|
132
132
|
.truthmark/config.yml
|
|
133
133
|
docs/truthmark/areas.md
|
|
134
134
|
docs/truthmark/areas/repository.md
|
|
135
|
-
docs/templates/
|
|
136
|
-
docs/
|
|
137
|
-
docs/
|
|
138
|
-
docs/
|
|
135
|
+
docs/templates/behavior-doc.md
|
|
136
|
+
docs/truth/README.md
|
|
137
|
+
docs/truth/repository/README.md
|
|
138
|
+
docs/truth/repository/overview.md
|
|
139
139
|
AGENTS.md
|
|
140
140
|
CLAUDE.md
|
|
141
141
|
GEMINI.md
|
|
142
142
|
```
|
|
143
143
|
|
|
144
144
|
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
|
|
145
|
+
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
146
|
|
|
147
147
|
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
148
|
|
|
@@ -150,43 +150,73 @@ Bestehende Repositories brauchen nach `init` meist einen Aufräumschritt: Führe
|
|
|
150
150
|
|
|
151
151
|
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
152
|
|
|
153
|
-
|
|
153
|
+
### Vorhandenes Verhalten ohne Doku
|
|
154
154
|
|
|
155
|
-
|
|
155
|
+
Nutze das, wenn die Implementierung bereits existiert, aber die kanonischen Wahrheitsdokumente fehlen oder schwach sind:
|
|
156
156
|
|
|
157
157
|
```text
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
158
|
+
benutzer identifiziert ein implementiertes verhalten oder einen api-endpunkt
|
|
159
|
+
benutzer ruft truth document ausdrücklich auf
|
|
160
|
+
agent liest implementierung, tests, routing und vorhandene docs
|
|
161
|
+
agent schreibt nur truth docs und routing
|
|
162
|
+
truth-doc-diff prüfen
|
|
163
163
|
```
|
|
164
164
|
|
|
165
|
-
Truth
|
|
165
|
+
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.
|
|
166
|
+
|
|
167
|
+
```text
|
|
168
|
+
/truthmark-document dokumentiere das implementierte session-timeout-verhalten unter docs/truth/authentication
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Normale Codeänderungen
|
|
172
|
+
|
|
173
|
+
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:
|
|
174
|
+
|
|
175
|
+
```text
|
|
176
|
+
agent ändert funktionalen code
|
|
177
|
+
relevante tests laufen
|
|
178
|
+
der installierte truth-sync-workflow läuft, bevor der agent fertig ist
|
|
179
|
+
truth-doc-diff prüfen, falls einer erzeugt wurde
|
|
180
|
+
arbeit committen oder übergeben
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
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.
|
|
184
|
+
|
|
166
185
|
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
186
|
|
|
169
187
|
```text
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
188
|
+
/truthmark-sync die repository-wahrheit jetzt vor der übergabe synchronisieren
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### Doc-first-Änderungen
|
|
192
|
+
|
|
193
|
+
Nutze das, wenn eine Produkt- oder Architekturentscheidung in der Doku beginnt:
|
|
194
|
+
|
|
195
|
+
```text
|
|
196
|
+
benutzer bearbeitet wahrheitsdokumente
|
|
197
|
+
benutzer ruft truth realize ausdrücklich auf
|
|
198
|
+
agent liest wahrheitsdokumente und relevanten code
|
|
199
|
+
agent aktualisiert nur code
|
|
200
|
+
relevante tests laufen
|
|
201
|
+
arbeit committen oder übergeben
|
|
176
202
|
```
|
|
177
203
|
|
|
178
204
|
Truth Realize ist manuell und doc-first: Wahrheitsdokumente führen, Code folgt, und der Agent darf die Wahrheitsdokumente, die er realisiert, nicht bearbeiten.
|
|
205
|
+
|
|
179
206
|
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
207
|
|
|
208
|
+
```text
|
|
209
|
+
/truthmark-realize docs/truth/authentication/session-timeout.md in code umsetzen
|
|
210
|
+
```
|
|
211
|
+
|
|
181
212
|
## Was es installiert
|
|
182
213
|
|
|
183
214
|
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
215
|
|
|
185
|
-
- `.truthmark/config.yml` für
|
|
186
|
-
- `.truthmark/config.yml` für den festgeschriebenen Hierarchievertrag
|
|
216
|
+
- `.truthmark/config.yml` für den maschinenlesbaren, festgeschriebenen Hierarchievertrag
|
|
187
217
|
- `docs/truthmark/areas.md` für den Root-Routenindex
|
|
188
218
|
- `docs/truthmark/areas/**/*.md` für delegierte untergeordnete Routendateien
|
|
189
|
-
- `docs/templates/
|
|
219
|
+
- `docs/templates/behavior-doc.md` sowie die weiteren typspezifischen Vorlagen unter `docs/templates/` für die editierbaren Truth-Doc-Standards der generierten Workflows
|
|
190
220
|
- verwaltete Instruktionsblöcke für konfigurierte Plattformen wie `AGENTS.md`, `CLAUDE.md`, Copilot-Anweisungen und `GEMINI.md`
|
|
191
221
|
- host-native Skills, Prompts oder Commands für Truth Structure, Truth Document, Truth Sync, Truth Realize und Truth Check
|
|
192
222
|
|
|
@@ -204,21 +234,42 @@ Generierte Flächen werden von Truthmark verwaltet, enthalten einen Versionsmark
|
|
|
204
234
|
|
|
205
235
|
## Befehle
|
|
206
236
|
|
|
207
|
-
Truthmark V1 hält die CLI
|
|
237
|
+
Truthmark V1 hält die CLI fokussiert, weil der laufende Workflow in den installierten Agenten-Flächen leben soll und nicht in einer langen Liste täglicher manueller Befehle. In nachgelagerten Repositories erzeugt `truthmark config` den in Git festgeschriebenen Hierarchievertrag, `truthmark init` installiert und aktualisiert Workflow-Flächen aus dieser geprüften Konfiguration, `truthmark check` validiert Wahrheitsartefakte für manuelle Audits, CI oder Fehlersuche, und die Repository-Intelligence-Befehle erzeugen abgeleitete Prüfarbeitsstände, wenn lokale Werkzeuge verfügbar sind.
|
|
208
238
|
|
|
209
239
|
```bash
|
|
210
240
|
truthmark config
|
|
211
241
|
truthmark init
|
|
212
242
|
truthmark check
|
|
243
|
+
truthmark index
|
|
244
|
+
truthmark impact --base main
|
|
245
|
+
truthmark context --workflow truth-sync --base main
|
|
213
246
|
truthmark config --json
|
|
214
247
|
truthmark check --json
|
|
248
|
+
truthmark index --json
|
|
249
|
+
truthmark impact --base main --json
|
|
250
|
+
truthmark context --workflow truth-sync --base main --json
|
|
215
251
|
```
|
|
216
252
|
|
|
217
253
|
`config` schreibt nur `.truthmark/config.yml`, außer `--stdout` wird verwendet.
|
|
254
|
+
|
|
218
255
|
`init` benötigt `.truthmark/config.yml` und installiert oder aktualisiert anschließend die lokalen Workflow-Dateien.
|
|
256
|
+
|
|
219
257
|
`check` validiert Konfiguration, Autorität, Routing, entscheidungstragende Dokumente, Frontmatter, interne Links, Branch-Scope und Coverage-Diagnostik.
|
|
258
|
+
|
|
259
|
+
`index` baut RepoIndex- und RouteMap-JSON für den aktiven Checkout.
|
|
260
|
+
|
|
261
|
+
`impact --base <ref>` ordnet geänderte Dateien den gerouteten Truth-Dokumenten, Routen, nahen Tests und öffentlichen Symbolen zu.
|
|
262
|
+
|
|
263
|
+
`context --workflow <workflow> [--base <ref>]` erzeugt ein begrenztes ContextPack für Truth Sync, Truth Document oder Truth Realize. `--format markdown` rendert eine menschenlesbare Fassung.
|
|
264
|
+
|
|
220
265
|
Truth Structure, Truth Document, Truth Sync, Truth Realize und Truth Check sind installierte Agenten-Workflows, keine täglichen Top-Level-CLI-Befehle.
|
|
221
266
|
|
|
267
|
+
Sie laufen über die konfigurierten Agenten-Host-Flächen, zum Beispiel Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*` oder Gemini `/truthmark:*`.
|
|
268
|
+
|
|
269
|
+
```text
|
|
270
|
+
/truthmark-check routing und truth-abdeckung vor der review prüfen
|
|
271
|
+
```
|
|
272
|
+
|
|
222
273
|
## Warum es existiert
|
|
223
274
|
|
|
224
275
|
Die meisten KI-Coding-Workflows optimieren für die nächste Antwort. Truthmark optimiert für die nächste Übergabe.
|
|
@@ -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 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
|
|
|
@@ -132,17 +132,17 @@ Revisa `.truthmark/config.yml` antes de `init`; es el contrato de jerarquía con
|
|
|
132
132
|
.truthmark/config.yml
|
|
133
133
|
docs/truthmark/areas.md
|
|
134
134
|
docs/truthmark/areas/repository.md
|
|
135
|
-
docs/templates/
|
|
136
|
-
docs/
|
|
137
|
-
docs/
|
|
138
|
-
docs/
|
|
135
|
+
docs/templates/behavior-doc.md
|
|
136
|
+
docs/truth/README.md
|
|
137
|
+
docs/truth/repository/README.md
|
|
138
|
+
docs/truth/repository/overview.md
|
|
139
139
|
AGENTS.md
|
|
140
140
|
CLAUDE.md
|
|
141
141
|
GEMINI.md
|
|
142
142
|
```
|
|
143
143
|
|
|
144
144
|
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
|
|
145
|
+
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
146
|
|
|
147
147
|
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
148
|
|
|
@@ -150,43 +150,73 @@ Los repositorios existentes suelen necesitar una pasada de limpieza después de
|
|
|
150
150
|
|
|
151
151
|
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
152
|
|
|
153
|
-
|
|
153
|
+
### Comportamiento existente sin docs
|
|
154
154
|
|
|
155
|
-
|
|
155
|
+
Usa esto cuando la implementación ya existe pero faltan o son débiles los documentos de verdad canónica:
|
|
156
|
+
|
|
157
|
+
```text
|
|
158
|
+
el usuario identifica un comportamiento implementado o un endpoint de api
|
|
159
|
+
el usuario invoca explícitamente truth document
|
|
160
|
+
el agente lee implementación, pruebas, rutas y docs existentes
|
|
161
|
+
el agente solo escribe truth docs y rutas
|
|
162
|
+
revisar el diff de truth docs
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
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`.
|
|
166
|
+
|
|
167
|
+
```text
|
|
168
|
+
/truthmark-document documenta el comportamiento implementado del timeout de sesión en docs/truth/authentication
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Cambios de código normales
|
|
172
|
+
|
|
173
|
+
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
174
|
|
|
157
175
|
```text
|
|
158
176
|
el agente cambia código funcional
|
|
159
177
|
se ejecutan las pruebas relevantes
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
178
|
+
el flujo instalado truth sync se ejecuta antes de que el agente termine
|
|
179
|
+
revisar el diff de truth docs si se produjo uno
|
|
180
|
+
confirmar o entregar el trabajo
|
|
163
181
|
```
|
|
164
182
|
|
|
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
|
|
183
|
+
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.
|
|
184
|
+
|
|
166
185
|
Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-sync`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-sync`.
|
|
186
|
+
|
|
187
|
+
```text
|
|
188
|
+
/truthmark-sync sincroniza ahora la verdad del repositorio antes de la entrega
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### Cambios doc-first
|
|
192
|
+
|
|
167
193
|
Usa este flujo cuando una decisión de producto o arquitectura empieza en la documentación:
|
|
168
194
|
|
|
169
195
|
```text
|
|
170
|
-
el usuario edita
|
|
171
|
-
el usuario invoca explícitamente
|
|
172
|
-
el agente lee
|
|
196
|
+
el usuario edita truth docs
|
|
197
|
+
el usuario invoca explícitamente truth realize
|
|
198
|
+
el agente lee truth docs y el código relevante
|
|
173
199
|
el agente actualiza solo el código
|
|
174
200
|
se ejecutan las pruebas relevantes
|
|
175
|
-
|
|
201
|
+
confirmar o entregar el trabajo
|
|
176
202
|
```
|
|
177
203
|
|
|
178
204
|
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.
|
|
205
|
+
|
|
179
206
|
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
207
|
|
|
208
|
+
```text
|
|
209
|
+
/truthmark-realize realiza docs/truth/authentication/session-timeout.md como código
|
|
210
|
+
```
|
|
211
|
+
|
|
181
212
|
## Qué instala
|
|
182
213
|
|
|
183
214
|
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
215
|
|
|
185
|
-
- `.truthmark/config.yml` para
|
|
186
|
-
- `.truthmark/config.yml` para el contrato de jerarquía confirmado
|
|
216
|
+
- `.truthmark/config.yml` para el contrato de jerarquía confirmado y legible por máquina
|
|
187
217
|
- `docs/truthmark/areas.md` para el índice raíz de rutas
|
|
188
218
|
- `docs/truthmark/areas/**/*.md` para archivos de rutas secundarias delegadas
|
|
189
|
-
- `docs/templates/
|
|
219
|
+
- `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
220
|
- bloques de instrucciones administrados para plataformas configuradas como `AGENTS.md`, `CLAUDE.md`, instrucciones de Copilot y `GEMINI.md`
|
|
191
221
|
- skills, prompts o comandos nativos del host para Truth Structure, Truth Document, Truth Sync, Truth Realize y Truth Check
|
|
192
222
|
|
|
@@ -204,21 +234,42 @@ Las superficies generadas son administradas por Truthmark, incluyen un marcador
|
|
|
204
234
|
|
|
205
235
|
## Comandos
|
|
206
236
|
|
|
207
|
-
Truthmark V1 mantiene la CLI pequeña a propósito porque el flujo continuo debe vivir en las superficies instaladas del agente, no en una lista larga de comandos manuales de uso diario. En repositorios derivados, `truthmark config` crea el contrato de jerarquía confirmado en Git, `truthmark init` instala y refresca superficies de flujo de trabajo a partir de esa configuración revisada,
|
|
237
|
+
Truthmark V1 mantiene la CLI pequeña a propósito porque el flujo continuo debe vivir en las superficies instaladas del agente, no en una lista larga de comandos manuales de uso diario. En repositorios derivados, `truthmark config` crea el contrato de jerarquía confirmado en Git, `truthmark init` instala y refresca superficies de flujo de trabajo a partir de esa configuración revisada, `truthmark check` valida los artefactos de verdad para auditorías manuales, CI o depuración, y los comandos de inteligencia del repositorio generan artefactos derivados de revisión cuando hay herramientas locales disponibles.
|
|
208
238
|
|
|
209
239
|
```bash
|
|
210
240
|
truthmark config
|
|
211
241
|
truthmark init
|
|
212
242
|
truthmark check
|
|
243
|
+
truthmark index
|
|
244
|
+
truthmark impact --base main
|
|
245
|
+
truthmark context --workflow truth-sync --base main
|
|
213
246
|
truthmark config --json
|
|
214
247
|
truthmark check --json
|
|
248
|
+
truthmark index --json
|
|
249
|
+
truthmark impact --base main --json
|
|
250
|
+
truthmark context --workflow truth-sync --base main --json
|
|
215
251
|
```
|
|
216
252
|
|
|
217
253
|
`config` solo escribe `.truthmark/config.yml`, salvo que se use `--stdout`.
|
|
254
|
+
|
|
218
255
|
`init` requiere `.truthmark/config.yml` y luego instala o refresca los archivos locales de flujo de trabajo.
|
|
256
|
+
|
|
219
257
|
`check` valida configuración, autoridad, enrutamiento, documentos que contienen decisiones, frontmatter, enlaces internos, alcance de rama y diagnósticos de cobertura.
|
|
258
|
+
|
|
259
|
+
`index` construye JSON de RepoIndex y RouteMap para el checkout activo.
|
|
260
|
+
|
|
261
|
+
`impact --base <ref>` mapea los archivos cambiados a los truth docs enrutados, rutas propietarias, pruebas cercanas y símbolos públicos.
|
|
262
|
+
|
|
263
|
+
`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.
|
|
264
|
+
|
|
220
265
|
Truth Structure, Truth Document, Truth Sync, Truth Realize y Truth Check son flujos de trabajo instalados para agentes, no comandos CLI principales de uso diario.
|
|
221
266
|
|
|
267
|
+
Se ejecutan a través de las superficies configuradas del host agente, por ejemplo Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*` o Gemini `/truthmark:*`.
|
|
268
|
+
|
|
269
|
+
```text
|
|
270
|
+
/truthmark-check audita el enrutamiento y la cobertura de verdad antes de la revisión
|
|
271
|
+
```
|
|
272
|
+
|
|
222
273
|
## Por qué existe
|
|
223
274
|
|
|
224
275
|
La mayoría de los flujos de programación con IA optimizan la siguiente respuesta. Truthmark optimiza el siguiente traspaso.
|
|
@@ -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
300
|
- superficies de skill generadas para Truth Structure, Truth Document, Truth Sync, 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.
|