truthmark 1.2.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/LICENSE +21 -0
- package/README.de.md +229 -0
- package/README.es.md +229 -0
- package/README.md +248 -0
- package/README.ru.md +229 -0
- package/README.zh.md +229 -0
- package/dist/main.js +3158 -0
- package/dist/main.js.map +1 -0
- package/package.json +69 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 MerlinH
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.de.md
ADDED
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
# Truthmark ist die Wahrheitsschicht für KI-Softwareentwicklung.
|
|
2
|
+
|
|
3
|
+
[English](README.md) | Deutsch | [中文](README.zh.md) | [Español](README.es.md) | [Русский](README.ru.md)
|
|
4
|
+
|
|
5
|
+
KI-Coding-Agenten können bereits gut Code schreiben. Womit sie weiterhin Schwierigkeiten haben: Produktabsicht, Architekturgrenzen und Zuständigkeiten im Repository zuverlässig aus veralteter Dokumentation, verstreuten Chats und flüchtigem Tool-Gedächtnis zu rekonstruieren.
|
|
6
|
+
Truthmark löst das, indem es branch-lokale Repository-Wahrheit zu einer erstklassigen Laufzeitfläche für Agenten macht. Es installiert eine Git-native, branch-gebundene Wahrheitsschicht direkt im Repository, gibt Agenten explizite Routing- und Workflow-Grenzen und sorgt dafür, dass diese Wahrheit mit dem Code mitwandert, der tatsächlich ausgeliefert wird.
|
|
7
|
+
Das ist kein besseres Prompt-Engineering. Es ist eine besser steuerbare Art, KI in einer echten Codebasis einzusetzen: weniger wiederholte Entscheidungen, weniger veraltete Dokumentation, sauberere Übergaben und KI-Coding-Sitzungen, die prüfbare Engineering-Aufzeichnungen hinterlassen, statt im Prompt-Verlauf oder in undurchsichtigen Tool-Zuständen zu verschwinden.
|
|
8
|
+
Für Teams, die bereits wissen, dass Agenten Code erzeugen können, und jetzt wollen, dass das Repository selbst lesbar, prüfbar und steuerbar bleibt.
|
|
9
|
+
|
|
10
|
+
## Was Truthmark löst
|
|
11
|
+
|
|
12
|
+
KI-Coding ist heute leicht zu starten, aber teuer zu beherrschen. Sobald Agenten schnell Code schreiben können, wird Repository-Wahrheit zur Steuerfläche.
|
|
13
|
+
Dieses Fehlermuster zeigt sich vorhersehbar: Anforderungen bleiben im Chat, Architekturentscheidungen werden wiederholt, Agenten bearbeiten die falschen Bereiche, und Branches erben Kontext, den Reviewer nicht zuverlässig prüfen können. Der Code kommt vielleicht schnell voran, aber dem Repository wird schwerer zu vertrauen.
|
|
14
|
+
Truthmark verändert das Arbeitsmodell:
|
|
15
|
+
|
|
16
|
+
- Branch-lokale Wahrheit wandert mit dem Branch, statt in einem privaten Tool-Speicher zu liegen.
|
|
17
|
+
- Git macht diese Wahrheit prüfbar, diffbar und im Team teilbar.
|
|
18
|
+
- Dokumentation folgt dem Code, statt still in Fiktion abzudriften.
|
|
19
|
+
- Routing bleibt in `docs/truthmark/areas.md` und delegierten untergeordneten Routendateien explizit, damit Agenten wissen, welche Dokumentation welchen Code verantwortet.
|
|
20
|
+
- Aktive Produkt- und Architekturentscheidungen stehen in den kanonischen Dokumenten, die sie betreffen, nicht in zeitgestempelten Planungsprotokollen.
|
|
21
|
+
- Local-first-Workflows vermeiden die Abhängigkeit von Daemon, Datenbank, Remote-Dienst oder MCP.
|
|
22
|
+
- Das Modell funktioniert in Codebasen mit JavaScript, TypeScript, Go, Python, C# und Java.
|
|
23
|
+
|
|
24
|
+
Für Tech Leads liegt der Wert in Governance ohne Theater: Tests, Code Review und Ownership leisten weiterhin die eigentliche Arbeit; Truthmark macht den Kontext des Agenten dauerhaft, prüfbar und branch-gebunden.
|
|
25
|
+
|
|
26
|
+
## Wo Truthmark hineinpasst
|
|
27
|
+
|
|
28
|
+
Truthmark versucht nicht, jedes andere KI-Workflow-Tool zu ersetzen. Es sitzt in einer bestimmten Schicht des Stacks:
|
|
29
|
+
|
|
30
|
+
| Wenn du brauchst | Beste Wahl |
|
|
31
|
+
| --------------------------------------------------------------------------- | ------------------------------------------- |
|
|
32
|
+
| Bessere Ergebnisse aus einer einzelnen Coding-Sitzung | Bessere Prompts und enger gefasste Aufgaben |
|
|
33
|
+
| Bequemlichkeit über Sitzungen hinweg für einen Agenten oder eine Person | Speicherwerkzeuge |
|
|
34
|
+
| Spec-first-Planung für neue Features | Spezifikations-Tools wie Spec Kit |
|
|
35
|
+
| Branch-gebundene, prüfbare Repository-Wahrheit, die mit dem Code mitwandert | Truthmark |
|
|
36
|
+
|
|
37
|
+
Der Punkt ist nicht, dass Prompts, Memory oder Specs nutzlos wären. Der Punkt ist, dass keines davon allein Repository-Wahrheit in ein in Git festgeschriebenes, prüfbares Asset verwandelt, das Übergaben, Reviews und auseinanderlaufende Branches übersteht.
|
|
38
|
+
|
|
39
|
+
## Inhalt
|
|
40
|
+
|
|
41
|
+
- [Was Truthmark löst](#was-truthmark-löst)
|
|
42
|
+
- [Wo Truthmark hineinpasst](#wo-truthmark-hineinpasst)
|
|
43
|
+
- [Workflow-Fläche](#workflow-fläche)
|
|
44
|
+
- [Erste Schritte](#erste-schritte)
|
|
45
|
+
- [Wie es läuft](#wie-es-läuft)
|
|
46
|
+
- [Was es installiert](#was-es-installiert)
|
|
47
|
+
- [Befehle](#befehle)
|
|
48
|
+
- [Warum es existiert](#warum-es-existiert)
|
|
49
|
+
- [Projektstatus](#projektstatus)
|
|
50
|
+
- [Dokumentation](#dokumentation)
|
|
51
|
+
- [Nicht-Ziele](#nicht-ziele)
|
|
52
|
+
- [Lizenz](#lizenz)
|
|
53
|
+
|
|
54
|
+
## Workflow-Fläche
|
|
55
|
+
|
|
56
|
+
Truthmark macht Repository-Wahrheit zu einer expliziten Workflow-Fläche für Agenten:
|
|
57
|
+
|
|
58
|
+
- `TRUTHMARK.md` definiert den branch-lokalen Workflow-Vertrag.
|
|
59
|
+
- `docs/truthmark/areas.md` und delegierte untergeordnete Routendateien ordnen Codebereiche den Dokumenten zu, die sie verantworten.
|
|
60
|
+
- Truth Sync hält zugeordnete Wahrheitsdokumente bei funktionalen Änderungen synchron.
|
|
61
|
+
- Truth Realize gibt doc-first Änderungen einen begrenzten Pfad für Code-Updates.
|
|
62
|
+
- `truthmark check` validiert die daraus entstehenden Wahrheitsartefakte.
|
|
63
|
+
- Das gesamte Modell bleibt local-first und Git-nativ.
|
|
64
|
+
|
|
65
|
+
Das ist das Kernversprechen: Agentenkontext wird zu festgeschriebenem Repository-Zustand statt zu einem privaten Sitzungsartefakt.
|
|
66
|
+
|
|
67
|
+
## Erste Schritte
|
|
68
|
+
|
|
69
|
+
Wenn du Truthmark zunächst gegen ein anderes lokales Repository ausprobieren willst, bevor das Paket anderswo veröffentlicht ist:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
cd /path/to/truthmark
|
|
73
|
+
npm install
|
|
74
|
+
npm run build
|
|
75
|
+
cd /path/to/your-repo
|
|
76
|
+
node /path/to/truthmark/dist/main.js config
|
|
77
|
+
node /path/to/truthmark/dist/main.js init
|
|
78
|
+
node /path/to/truthmark/dist/main.js check
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Prüfe `.truthmark/config.yml` vor `init`; es ist der in Git festgeschriebene Hierarchievertrag. Nach `init` solltest du die generierte Workflow-Fläche und die Routendateien prüfen, damit die gerouteten Dokumente zu den Dokumenten passen, die deinen Code tatsächlich verantworten:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
.truthmark/config.yml
|
|
85
|
+
TRUTHMARK.md
|
|
86
|
+
docs/truthmark/areas.md
|
|
87
|
+
docs/truthmark/areas/repository.md
|
|
88
|
+
docs/features/README.md
|
|
89
|
+
docs/features/repository/README.md
|
|
90
|
+
docs/features/repository/overview.md
|
|
91
|
+
AGENTS.md
|
|
92
|
+
CLAUDE.md
|
|
93
|
+
skills/truthmark-structure/SKILL.md
|
|
94
|
+
skills/truthmark-sync/SKILL.md
|
|
95
|
+
skills/truthmark-realize/SKILL.md
|
|
96
|
+
skills/truthmark-check/SKILL.md
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Wenn du zusätzliche Plattformen in `.truthmark/config.yml` aktivierst, aktualisiert Truthmark die entsprechenden verwalteten Flächen beim nächsten `init`.
|
|
100
|
+
Die standardmäßig erzeugte Struktur verwendet `README.md`-Dateien von Features als Indizes und beginnt die Wahrheit über aktuelles Verhalten in begrenzten Blattdokumenten wie `docs/features/repository/overview.md`.
|
|
101
|
+
|
|
102
|
+
## Wie es läuft
|
|
103
|
+
|
|
104
|
+
Truthmark legt nicht fest, welcher Subagent Truth Sync ausführen soll. Der handelnde Agent und die Host-Umgebung entscheiden, ob delegiert oder der Workflow inline ausgeführt wird.
|
|
105
|
+
Die meisten Nutzer sollten Truth Sync nicht direkt aufrufen müssen. Der normale Ablauf ist:
|
|
106
|
+
|
|
107
|
+
```text
|
|
108
|
+
Agent ändert funktionalen Code
|
|
109
|
+
relevante Tests laufen
|
|
110
|
+
Truth Sync wird vor dem Abschluss des Agenten ausgelöst
|
|
111
|
+
Truth-Doc-Diff prüfen, falls einer erzeugt wurde
|
|
112
|
+
Arbeit committen oder übergeben
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Truth Sync ist code-first: Code führt, Wahrheitsdokumente folgen, und Truth Sync darf funktionalen Code nicht umschreiben. Seine Hauptaufgabe ist eine automatische Abschlusskontrolle, 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.
|
|
116
|
+
Codex-Nutzer können es mit `/truthmark-sync` oder `$truthmark-sync` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-sync` verwenden.
|
|
117
|
+
Nutze diesen Ablauf, wenn eine Produkt- oder Architekturentscheidung in der Dokumentation beginnt:
|
|
118
|
+
|
|
119
|
+
```text
|
|
120
|
+
Benutzer bearbeitet Wahrheitsdokumente
|
|
121
|
+
Benutzer ruft Truth Realize ausdrücklich auf
|
|
122
|
+
Agent liest Wahrheitsdokumente und relevanten Code
|
|
123
|
+
Agent aktualisiert nur Code
|
|
124
|
+
relevante Tests laufen
|
|
125
|
+
Arbeit committen oder übergeben
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Truth Realize ist manuell und doc-first: Wahrheitsdokumente führen, Code folgt, und der Agent darf die Wahrheitsdokumente, die er realisiert, nicht bearbeiten.
|
|
129
|
+
Codex-Nutzer können es mit `/truthmark-realize` oder `$truthmark-realize` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-realize` verwenden.
|
|
130
|
+
|
|
131
|
+
## Was es installiert
|
|
132
|
+
|
|
133
|
+
Truthmark hält die dauerhafte Workflow-Fläche klein:
|
|
134
|
+
|
|
135
|
+
- `.truthmark/config.yml` für maschinenlesbare Konfiguration
|
|
136
|
+
- `TRUTHMARK.md` für den branch-lokalen Workflow-Vertrag
|
|
137
|
+
- `docs/truthmark/areas.md` für den Root-Routenindex
|
|
138
|
+
- `docs/truthmark/areas/**/*.md` für delegierte untergeordnete Routendateien
|
|
139
|
+
- verwaltete Instruktionsblöcke für konfigurierte Plattformen wie `AGENTS.md`, `CLAUDE.md`, Cursor-Regeln, Copilot-Anweisungen und `GEMINI.md`
|
|
140
|
+
- Codex- und repo-lokale Skills für Truth Structure, Truth Sync, Truth Realize und Truth Check
|
|
141
|
+
|
|
142
|
+
Die installierten Workflow-Flächen sind die Runtime:
|
|
143
|
+
|
|
144
|
+
- Truth Structure erstellt oder repariert Area-Routing und erste Wahrheitsdokumente.
|
|
145
|
+
- Truth Sync hält zugeordnete Wahrheitsdokumente bei funktionalen Änderungen synchron.
|
|
146
|
+
- Truth Realize aktualisiert Code so, dass er zu den Wahrheitsdokumenten passt.
|
|
147
|
+
- Truth Check auditiert die Gesundheit der Repository-Wahrheit.
|
|
148
|
+
|
|
149
|
+
`README.md`-Dateien von Features sind Indizes. Truth Sync soll begrenzte Blattdokumente für aktuelles Verhalten lesen und aktualisieren.
|
|
150
|
+
|
|
151
|
+
Generierte Flächen werden von Truthmark verwaltet, enthalten einen Versionsmarker und können mit `truthmark init` aktualisiert werden.
|
|
152
|
+
|
|
153
|
+
## Befehle
|
|
154
|
+
|
|
155
|
+
Truthmark V1 hält die CLI absichtlich klein. In nachgelagerten Repositories erzeugt `truthmark config` den in Git festgeschriebenen Hierarchievertrag, `truthmark init` installiert und aktualisiert Workflow-Flächen aus dieser geprüften Konfiguration, und `truthmark check` validiert Wahrheitsartefakte für manuelle Audits, CI oder Fehlersuche.
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
truthmark config
|
|
159
|
+
truthmark init
|
|
160
|
+
truthmark check
|
|
161
|
+
truthmark config --json
|
|
162
|
+
truthmark check --json
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
`config` schreibt nur `.truthmark/config.yml`, außer `--stdout` wird verwendet.
|
|
166
|
+
`init` benötigt `.truthmark/config.yml` und installiert oder aktualisiert anschließend die lokalen Workflow-Dateien.
|
|
167
|
+
`check` validiert Konfiguration, Autorität, Routing, entscheidungstragende Dokumente, Frontmatter, interne Links, Branch-Scope und Coverage-Diagnostik.
|
|
168
|
+
Truth Structure, Truth Sync, Truth Realize und Truth Check sind installierte Agenten-Workflows, keine täglichen Top-Level-CLI-Befehle.
|
|
169
|
+
|
|
170
|
+
## Warum es existiert
|
|
171
|
+
|
|
172
|
+
Die meisten KI-Coding-Workflows optimieren für die nächste Antwort. Truthmark optimiert für die nächste Übergabe.
|
|
173
|
+
Es geht davon aus, dass ernsthafte Teams Folgendes brauchen:
|
|
174
|
+
|
|
175
|
+
- branch-spezifische Produktwahrheit
|
|
176
|
+
- dauerhafte Architektur- und API-Entscheidungen
|
|
177
|
+
- explizite Zuständigkeit zwischen Dokumentation und Code
|
|
178
|
+
- sichere Schreibgrenzen für Agenten
|
|
179
|
+
- normale Git-Diffs, die Menschen prüfen können
|
|
180
|
+
- lesbares Markdown, das Teammitglieder ohne Spezialwerkzeuge inspizieren können
|
|
181
|
+
- Wahrheit, die mit dem Branch mitwandert, statt in verborgenem Sitzungszustand zu leben
|
|
182
|
+
- Workflows, die auch funktionieren, wenn das Paket nicht global installiert ist
|
|
183
|
+
|
|
184
|
+
## Projektstatus
|
|
185
|
+
|
|
186
|
+
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.
|
|
187
|
+
V1 bietet derzeit:
|
|
188
|
+
|
|
189
|
+
- `truthmark config`
|
|
190
|
+
- `truthmark init`
|
|
191
|
+
- `truthmark check`
|
|
192
|
+
- verwaltete `AGENTS.md`-Workflow-Anweisungen
|
|
193
|
+
- generierte Skill-Flächen für Truth Structure, Truth Sync, Truth Realize und Truth Check für konfigurierte Agenten-Hosts
|
|
194
|
+
- Branch-Scope-Metadaten
|
|
195
|
+
- Diagnostik für Konfiguration, Autorität, Routing, Entscheidungsstruktur, Frontmatter, Links und polyglotte Abdeckung
|
|
196
|
+
|
|
197
|
+
Es wird nicht angenommen, dass das ungescopte Paket `truthmark` bereits veröffentlicht ist.
|
|
198
|
+
|
|
199
|
+
## Dokumentation
|
|
200
|
+
|
|
201
|
+
Die Root-README ist für Menschen gedacht, die das Paket evaluieren und ausprobieren. Detaillierte funktionale und geschäftliche Spezifikationen liegen unter `docs/`:
|
|
202
|
+
|
|
203
|
+
- [Dokumentationsindex](docs/README.md)
|
|
204
|
+
- [Architekturüberblick](docs/architecture/overview.md)
|
|
205
|
+
- [API- und CLI-Verträge](docs/features/contracts.md)
|
|
206
|
+
- [Init- und Scaffold-Verhalten](docs/features/init-and-scaffold.md)
|
|
207
|
+
- [Check-Diagnostik](docs/features/check-diagnostics.md)
|
|
208
|
+
- [Installierte Workflows](docs/features/installed-workflows.md)
|
|
209
|
+
- [Leitfaden zur Pflege von Repository-Wahrheit](docs/standards/maintaining-repository-truth.md)
|
|
210
|
+
|
|
211
|
+
Aktuelles Verhalten gehört in den oben genannten kanonischen Dokumentationsbaum.
|
|
212
|
+
|
|
213
|
+
## Nicht-Ziele
|
|
214
|
+
|
|
215
|
+
Truthmark V1 ist nicht:
|
|
216
|
+
|
|
217
|
+
- ein gehosteter Dienst
|
|
218
|
+
- ein MCP-Server
|
|
219
|
+
- eine Vektordatenbank
|
|
220
|
+
- ein Generator für Dokumentations-Websites
|
|
221
|
+
- ein CI- oder PR-Enforcement-Produkt
|
|
222
|
+
- ein Ersatz für Tests, Code Review oder technische Führung
|
|
223
|
+
- eine autonome Code-Rewrite-Engine
|
|
224
|
+
|
|
225
|
+
Es ist ein leichtgewichtiger Weg, lokale KI-Coding-Agenten dazu zu bringen, die Wahrheit zu respektieren, die dein Team in Git pflegt.
|
|
226
|
+
|
|
227
|
+
## Lizenz
|
|
228
|
+
|
|
229
|
+
MIT. Siehe [LICENSE](LICENSE).
|
package/README.es.md
ADDED
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
# Truthmark es la capa de verdad para el desarrollo de software con IA.
|
|
2
|
+
|
|
3
|
+
[English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | Español | [Русский](README.ru.md)
|
|
4
|
+
|
|
5
|
+
Los agentes de programación con IA ya escriben código bastante bien. Lo que todavía hacen mal es reconstruir de forma fiable la intención del producto, los límites de arquitectura y la responsabilidad sobre cada parte del repositorio a partir de documentación obsoleta, conversaciones dispersas y memoria temporal de herramientas.
|
|
6
|
+
|
|
7
|
+
## Qué resuelve Truthmark
|
|
8
|
+
|
|
9
|
+
Truthmark lo resuelve convirtiendo la verdad local de cada rama en una superficie de ejecución de primera clase para los agentes. Instala una capa de verdad nativa de Git, acotada a la rama, directamente dentro del repositorio; da a los agentes rutas y límites de flujo de trabajo explícitos; y hace que esa verdad viaje con el código que realmente se entrega.
|
|
10
|
+
Esto no es mejor ingeniería de prompts. Es una forma más gobernable de usar IA en una base de código real: menos decisiones repetidas, menos documentación obsoleta, traspasos más limpios y sesiones de programación con IA que dejan registros de ingeniería revisables en lugar de desaparecer en el historial de prompts o en estados opacos de herramientas.
|
|
11
|
+
Está pensado para equipos que ya saben que los agentes pueden generar código y ahora necesitan que el repositorio siga siendo legible, revisable y gobernable.
|
|
12
|
+
Empezar a programar con IA ya es fácil; gobernarlo es lo costoso. Cuando los agentes pueden escribir código rápido, la verdad del repositorio se convierte en la superficie de control.
|
|
13
|
+
Ese fallo aparece de forma predecible: los requisitos se quedan en chats, las decisiones de arquitectura se repiten, los agentes tocan las zonas equivocadas y las ramas heredan contexto que los revisores no pueden inspeccionar con confianza. El código puede avanzar rápido, pero el repositorio se vuelve más difícil de confiar.
|
|
14
|
+
Truthmark cambia el modelo de trabajo:
|
|
15
|
+
|
|
16
|
+
- La verdad local de la rama viaja con la rama, en lugar de vivir en un almacén privado de herramientas.
|
|
17
|
+
- Git hace que esa verdad sea revisable, comparable y compartible con el equipo.
|
|
18
|
+
- La documentación sigue al código en lugar de derivar silenciosamente hacia la ficción.
|
|
19
|
+
- El enrutamiento permanece explícito en `docs/truthmark/areas.md` y en archivos de rutas secundarias delegadas, para que los agentes sepan qué documentación gobierna qué código.
|
|
20
|
+
- Las decisiones activas de producto y arquitectura viven en los documentos canónicos que gobiernan, no en registros de planificación con marca de tiempo.
|
|
21
|
+
- Los flujos de trabajo locales evitan depender de un demonio, una base de datos, un servicio remoto o MCP.
|
|
22
|
+
- El modelo funciona en bases de código JavaScript, TypeScript, Go, Python, C# y Java.
|
|
23
|
+
|
|
24
|
+
Para responsables técnicos, el valor es gobernanza sin teatro: 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.
|
|
25
|
+
|
|
26
|
+
## Dónde encaja Truthmark
|
|
27
|
+
|
|
28
|
+
Truthmark no intenta reemplazar todas las demás herramientas de flujo de trabajo con IA. Ocupa una capa concreta de la pila:
|
|
29
|
+
|
|
30
|
+
| Si necesitas | Mejor opción |
|
|
31
|
+
| ------------------------------------------------------------------------------ | -------------------------------------------- |
|
|
32
|
+
| Mejores resultados en una sola sesión de programación | Mejores prompts y una tarea mejor delimitada |
|
|
33
|
+
| Continuidad cómoda entre sesiones para un agente o una persona | Herramientas de memoria |
|
|
34
|
+
| Planificación spec-first para nuevas funciones | Herramientas de especificación como Spec Kit |
|
|
35
|
+
| Verdad del repositorio, revisable y acotada a la rama, que viaja con el código | Truthmark |
|
|
36
|
+
|
|
37
|
+
La idea no es que los prompts, la memoria o las especificaciones no sirvan. La idea es que ninguno de ellos, por sí solo, convierte la verdad del repositorio en un activo confirmado en Git, inspeccionable y capaz de sobrevivir a traspasos, revisiones y divergencias entre ramas.
|
|
38
|
+
|
|
39
|
+
## Contenido
|
|
40
|
+
|
|
41
|
+
- [Qué resuelve Truthmark](#qué-resuelve-truthmark)
|
|
42
|
+
- [Dónde encaja Truthmark](#dónde-encaja-truthmark)
|
|
43
|
+
- [Superficie de flujo](#superficie-de-flujo)
|
|
44
|
+
- [Primeros pasos](#primeros-pasos)
|
|
45
|
+
- [Cómo se ejecuta](#cómo-se-ejecuta)
|
|
46
|
+
- [Qué instala](#qué-instala)
|
|
47
|
+
- [Comandos](#comandos)
|
|
48
|
+
- [Por qué existe](#por-qué-existe)
|
|
49
|
+
- [Estado del proyecto](#estado-del-proyecto)
|
|
50
|
+
- [Documentación](#documentación)
|
|
51
|
+
- [No objetivos](#no-objetivos)
|
|
52
|
+
- [Licencia](#licencia)
|
|
53
|
+
|
|
54
|
+
## Superficie de flujo
|
|
55
|
+
|
|
56
|
+
Truthmark convierte la verdad del repositorio en una superficie explícita de flujo de trabajo para agentes:
|
|
57
|
+
|
|
58
|
+
- `TRUTHMARK.md` define el contrato de flujo de trabajo local a la rama.
|
|
59
|
+
- `docs/truthmark/areas.md` y los archivos de rutas secundarias delegadas asignan áreas de código a los documentos que las gobiernan.
|
|
60
|
+
- Truth Sync mantiene alineados los documentos de verdad asignados cuando hay cambios funcionales.
|
|
61
|
+
- Truth Realize ofrece a los cambios que empiezan en documentación una ruta acotada para actualizar código.
|
|
62
|
+
- `truthmark check` valida los artefactos de verdad resultantes.
|
|
63
|
+
- Todo el modelo se mantiene local-first y nativo de Git.
|
|
64
|
+
|
|
65
|
+
Esta es la promesa central: el contexto del agente pasa a ser estado confirmado del repositorio, no un artefacto privado de una sesión.
|
|
66
|
+
|
|
67
|
+
## Primeros pasos
|
|
68
|
+
|
|
69
|
+
Para probar Truthmark contra otro repositorio local antes de que el paquete se publique en otro lugar:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
cd /path/to/truthmark
|
|
73
|
+
npm install
|
|
74
|
+
npm run build
|
|
75
|
+
cd /path/to/your-repo
|
|
76
|
+
node /path/to/truthmark/dist/main.js config
|
|
77
|
+
node /path/to/truthmark/dist/main.js init
|
|
78
|
+
node /path/to/truthmark/dist/main.js check
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Revisa `.truthmark/config.yml` antes de `init`; es el contrato de jerarquía confirmado en el repositorio. Después de `init`, revisa la superficie de flujo de trabajo generada y los archivos de rutas para que los documentos enrutados coincidan con los documentos que realmente gobiernan tu código:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
.truthmark/config.yml
|
|
85
|
+
TRUTHMARK.md
|
|
86
|
+
docs/truthmark/areas.md
|
|
87
|
+
docs/truthmark/areas/repository.md
|
|
88
|
+
docs/features/README.md
|
|
89
|
+
docs/features/repository/README.md
|
|
90
|
+
docs/features/repository/overview.md
|
|
91
|
+
AGENTS.md
|
|
92
|
+
CLAUDE.md
|
|
93
|
+
skills/truthmark-structure/SKILL.md
|
|
94
|
+
skills/truthmark-sync/SKILL.md
|
|
95
|
+
skills/truthmark-realize/SKILL.md
|
|
96
|
+
skills/truthmark-check/SKILL.md
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Si habilitas plataformas adicionales en `.truthmark/config.yml`, Truthmark actualizará las superficies administradas correspondientes en el siguiente `init`.
|
|
100
|
+
La estructura generada por defecto usa los `README.md` de funciones como índices y empieza la verdad sobre el comportamiento actual en documentos hoja acotados, como `docs/features/repository/overview.md`.
|
|
101
|
+
|
|
102
|
+
## Cómo se ejecuta
|
|
103
|
+
|
|
104
|
+
Truthmark no especifica qué subagente debe ejecutar Truth Sync. El agente que actúa y el entorno anfitrión deciden si delegan o ejecutan el flujo en línea.
|
|
105
|
+
La mayoría de los usuarios no debería invocar Truth Sync directamente. El flujo normal es:
|
|
106
|
+
|
|
107
|
+
```text
|
|
108
|
+
el agente cambia código funcional
|
|
109
|
+
se ejecutan las pruebas relevantes
|
|
110
|
+
Truth Sync se dispara antes de que el agente termine
|
|
111
|
+
se revisa el diff de documentos de verdad si se produjo uno
|
|
112
|
+
se confirma o se entrega el trabajo
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
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 actuar como salvaguarda automática al 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.
|
|
116
|
+
Los usuarios de Codex pueden invocarlo con `/truthmark-sync` o `$truthmark-sync`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-sync`.
|
|
117
|
+
Usa este flujo cuando una decisión de producto o arquitectura empieza en la documentación:
|
|
118
|
+
|
|
119
|
+
```text
|
|
120
|
+
el usuario edita los documentos de verdad
|
|
121
|
+
el usuario invoca explícitamente Truth Realize
|
|
122
|
+
el agente lee los documentos de verdad y el código relevante
|
|
123
|
+
el agente actualiza solo el código
|
|
124
|
+
se ejecutan las pruebas relevantes
|
|
125
|
+
se confirma o se entrega el trabajo
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
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.
|
|
129
|
+
Los usuarios de Codex pueden invocarlo con `/truthmark-realize` o `$truthmark-realize`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-realize`.
|
|
130
|
+
|
|
131
|
+
## Qué instala
|
|
132
|
+
|
|
133
|
+
Truthmark mantiene pequeña la superficie duradera de flujo de trabajo:
|
|
134
|
+
|
|
135
|
+
- `.truthmark/config.yml` para configuración legible por máquina
|
|
136
|
+
- `TRUTHMARK.md` para el contrato de flujo de trabajo local a la rama
|
|
137
|
+
- `docs/truthmark/areas.md` para el índice raíz de rutas
|
|
138
|
+
- `docs/truthmark/areas/**/*.md` para archivos de rutas secundarias delegadas
|
|
139
|
+
- bloques de instrucciones administrados para plataformas configuradas como `AGENTS.md`, `CLAUDE.md`, reglas de Cursor, instrucciones de Copilot y `GEMINI.md`
|
|
140
|
+
- skills locales del repositorio y de Codex para Truth Structure, Truth Sync, Truth Realize y Truth Check
|
|
141
|
+
|
|
142
|
+
Las superficies de flujo de trabajo instaladas son el entorno de ejecución:
|
|
143
|
+
|
|
144
|
+
- Truth Structure crea o repara el enrutamiento de áreas y documentos de verdad iniciales.
|
|
145
|
+
- Truth Sync mantiene alineados los documentos de verdad asignados con los cambios funcionales.
|
|
146
|
+
- Truth Realize actualiza el código para que coincida con los documentos de verdad.
|
|
147
|
+
- Truth Check audita la salud de la verdad del repositorio.
|
|
148
|
+
|
|
149
|
+
Los `README.md` de funciones son índices. Se espera que Truth Sync lea y actualice documentos hoja acotados para el comportamiento actual.
|
|
150
|
+
|
|
151
|
+
Las superficies generadas son administradas por Truthmark, incluyen un marcador de versión y pueden refrescarse con `truthmark init`.
|
|
152
|
+
|
|
153
|
+
## Comandos
|
|
154
|
+
|
|
155
|
+
Truthmark V1 mantiene la CLI pequeña a propósito. 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, y `truthmark check` valida los artefactos de verdad para auditorías manuales, CI o depuración.
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
truthmark config
|
|
159
|
+
truthmark init
|
|
160
|
+
truthmark check
|
|
161
|
+
truthmark config --json
|
|
162
|
+
truthmark check --json
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
`config` solo escribe `.truthmark/config.yml`, salvo que se use `--stdout`.
|
|
166
|
+
`init` requiere `.truthmark/config.yml` y luego instala o refresca los archivos locales de flujo de trabajo.
|
|
167
|
+
`check` valida configuración, autoridad, enrutamiento, documentos que contienen decisiones, frontmatter, enlaces internos, alcance de rama y diagnósticos de cobertura.
|
|
168
|
+
Truth Structure, Truth Sync, Truth Realize y Truth Check son flujos de trabajo instalados para agentes, no comandos CLI principales de uso diario.
|
|
169
|
+
|
|
170
|
+
## Por qué existe
|
|
171
|
+
|
|
172
|
+
La mayoría de los flujos de programación con IA optimizan la siguiente respuesta. Truthmark optimiza el siguiente traspaso.
|
|
173
|
+
Asume que los equipos serios necesitan:
|
|
174
|
+
|
|
175
|
+
- verdad de producto específica de cada rama
|
|
176
|
+
- decisiones duraderas de arquitectura y API
|
|
177
|
+
- propiedad explícita entre documentación y código
|
|
178
|
+
- límites seguros de escritura para agentes
|
|
179
|
+
- diffs normales de Git que humanos puedan revisar
|
|
180
|
+
- Markdown legible que el equipo pueda inspeccionar sin herramientas especiales
|
|
181
|
+
- verdad que viaje con la rama en lugar de vivir en estado oculto de sesión
|
|
182
|
+
- flujos que sigan funcionando aunque el paquete no esté instalado globalmente
|
|
183
|
+
|
|
184
|
+
## Estado del proyecto
|
|
185
|
+
|
|
186
|
+
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.
|
|
187
|
+
V1 actualmente ofrece:
|
|
188
|
+
|
|
189
|
+
- `truthmark config`
|
|
190
|
+
- `truthmark init`
|
|
191
|
+
- `truthmark check`
|
|
192
|
+
- instrucciones de flujo de trabajo administradas en `AGENTS.md`
|
|
193
|
+
- superficies de skill generadas para Truth Structure, Truth Sync, Truth Realize y Truth Check en los anfitriones de agentes configurados
|
|
194
|
+
- metadatos de alcance de rama
|
|
195
|
+
- diagnósticos de configuración, autoridad, enrutamiento, estructura de decisiones, frontmatter, enlaces y cobertura políglota
|
|
196
|
+
|
|
197
|
+
No se debe asumir que el paquete sin scope `truthmark` ya está publicado.
|
|
198
|
+
|
|
199
|
+
## Documentación
|
|
200
|
+
|
|
201
|
+
El README raíz es para personas que evalúan y prueban el paquete. Las especificaciones funcionales y de negocio detalladas viven en `docs/`:
|
|
202
|
+
|
|
203
|
+
- [Índice de documentación](docs/README.md)
|
|
204
|
+
- [Resumen de arquitectura](docs/architecture/overview.md)
|
|
205
|
+
- [Contratos de API y CLI](docs/features/contracts.md)
|
|
206
|
+
- [Comportamiento de init y scaffold](docs/features/init-and-scaffold.md)
|
|
207
|
+
- [Diagnósticos de check](docs/features/check-diagnostics.md)
|
|
208
|
+
- [Flujos de trabajo instalados](docs/features/installed-workflows.md)
|
|
209
|
+
- [Guía para mantener la verdad del repositorio](docs/standards/maintaining-repository-truth.md)
|
|
210
|
+
|
|
211
|
+
El comportamiento actual pertenece al árbol canónico de documentación anterior.
|
|
212
|
+
|
|
213
|
+
## No objetivos
|
|
214
|
+
|
|
215
|
+
Truthmark V1 no es:
|
|
216
|
+
|
|
217
|
+
- un servicio alojado
|
|
218
|
+
- un servidor MCP
|
|
219
|
+
- una base de datos vectorial
|
|
220
|
+
- un generador de sitios de documentación
|
|
221
|
+
- un producto de enforcement para CI o PR
|
|
222
|
+
- un sustituto de pruebas, revisión de código o liderazgo técnico
|
|
223
|
+
- un motor autónomo de reescritura de código
|
|
224
|
+
|
|
225
|
+
Es una forma ligera de hacer que los agentes locales de programación con IA respeten la verdad que tu equipo guarda en Git.
|
|
226
|
+
|
|
227
|
+
## Licencia
|
|
228
|
+
|
|
229
|
+
MIT. Consulta [LICENSE](LICENSE).
|