truthmark 1.2.2 → 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 +155 -55
- package/README.es.md +149 -49
- package/README.md +125 -43
- package/README.ru.md +148 -48
- package/README.zh.md +146 -46
- package/dist/main.js +2974 -863
- package/dist/main.js.map +1 -1
- package/package.json +2 -2
package/README.es.md
CHANGED
|
@@ -1,31 +1,68 @@
|
|
|
1
|
-
# Truthmark
|
|
1
|
+
# Truthmark
|
|
2
|
+
|
|
3
|
+
**Truthmark instala flujos de verdad del repositorio para el desarrollo de software con IA.**
|
|
2
4
|
|
|
3
5
|
[English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | Español | [Русский](README.ru.md)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
<img src="docs/assets/truthmark-banner.png" alt="Banner de Truthmark" width="100%" />
|
|
6
8
|
|
|
7
|
-
|
|
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
|
+
|
|
11
|
+
Truthmark añade una guarda de cierre basada en flujo de trabajo. El camino normal es simple:
|
|
12
|
+
|
|
13
|
+
- el agente cambia código funcional
|
|
14
|
+
- se ejecutan las pruebas relevantes
|
|
15
|
+
- el flujo instalado Truth Sync actualiza los documentos de verdad asignados antes de que el agente termine
|
|
16
|
+
- se revisa el diff de documentos de verdad si se produjo uno
|
|
17
|
+
|
|
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
|
+
|
|
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
|
+
|
|
22
|
+
Eso importa porque el flujo vive con la rama. Una vez inicializado un repositorio, las reglas, el enrutamiento y las superficies instaladas viajan dentro del repo, así que la colaboración y los traspasos dependen menos de la configuración local de una sola persona.
|
|
23
|
+
|
|
24
|
+
Para equipos que ya saben que los agentes pueden generar código, Truthmark responde al siguiente problema: cómo hacer que el repositorio siga siendo legible, revisable y gobernable a medida que crece el trabajo asistido por IA.
|
|
25
|
+
|
|
26
|
+
## Resumen visual
|
|
27
|
+
|
|
28
|
+
<table>
|
|
29
|
+
<tr>
|
|
30
|
+
<td align="center" width="50%">
|
|
31
|
+
<img src="docs/assets/truthmark-features.png" alt="Características de Truthmark" width="100%" />
|
|
32
|
+
<br><strong>Características</strong><br>
|
|
33
|
+
Lo que instala Truthmark y cómo se divide la superficie de trabajo.
|
|
34
|
+
</td>
|
|
35
|
+
<td align="center" width="50%">
|
|
36
|
+
<img src="docs/assets/truthmark-position.png" alt="Posicionamiento de Truthmark" width="100%" />
|
|
37
|
+
<br><strong>Posicionamiento</strong><br>
|
|
38
|
+
Dónde encaja Truthmark frente a prompts, memoria y flujos spec-first.
|
|
39
|
+
</td>
|
|
40
|
+
</tr>
|
|
41
|
+
<tr>
|
|
42
|
+
<td align="center" colspan="2">
|
|
43
|
+
<img src="docs/assets/truthmark-syncflow.png" alt="Flujo de sync de Truthmark" width="100%" />
|
|
44
|
+
<br><strong>Flujo de sync</strong><br>
|
|
45
|
+
Cómo Truth Sync cierra cambios normales de código antes del traspaso.
|
|
46
|
+
</td>
|
|
47
|
+
</tr>
|
|
48
|
+
</table>
|
|
49
|
+
|
|
50
|
+
## Por qué los equipos lo adoptan
|
|
8
51
|
|
|
9
|
-
Truthmark
|
|
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:
|
|
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.
|
|
15
53
|
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
- El enrutamiento
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
- El modelo funciona en bases de código JavaScript, TypeScript, Go, Python, C# y Java.
|
|
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
|
+
- 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
|
+
- 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
|
+
- 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
|
+
- La operación local-first evita depender de un demonio, una base de datos, un servicio remoto o MCP.
|
|
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.
|
|
23
60
|
|
|
24
|
-
Para responsables técnicos, el valor es gobernanza sin
|
|
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.
|
|
25
62
|
|
|
26
63
|
## Dónde encaja Truthmark
|
|
27
64
|
|
|
28
|
-
Truthmark no
|
|
65
|
+
Truthmark no es una suite general de productividad para IA. Ocupa una capa concreta de la pila: verdad de repositorio revisable, acotada a la rama y alineada con la implementación.
|
|
29
66
|
|
|
30
67
|
| Si necesitas | Mejor opción |
|
|
31
68
|
| ------------------------------------------------------------------------------ | -------------------------------------------- |
|
|
@@ -38,9 +75,9 @@ La idea no es que los prompts, la memoria o las especificaciones no sirvan. La i
|
|
|
38
75
|
|
|
39
76
|
## Contenido
|
|
40
77
|
|
|
78
|
+
- [Por qué los equipos lo adoptan](#por-qué-los-equipos-lo-adoptan)
|
|
41
79
|
- [Qué resuelve Truthmark](#qué-resuelve-truthmark)
|
|
42
80
|
- [Dónde encaja Truthmark](#dónde-encaja-truthmark)
|
|
43
|
-
- [Superficie de flujo](#superficie-de-flujo)
|
|
44
81
|
- [Primeros pasos](#primeros-pasos)
|
|
45
82
|
- [Cómo se ejecuta](#cómo-se-ejecuta)
|
|
46
83
|
- [Qué instala](#qué-instala)
|
|
@@ -51,12 +88,13 @@ La idea no es que los prompts, la memoria o las especificaciones no sirvan. La i
|
|
|
51
88
|
- [No objetivos](#no-objetivos)
|
|
52
89
|
- [Licencia](#licencia)
|
|
53
90
|
|
|
54
|
-
##
|
|
91
|
+
## Qué resuelve Truthmark
|
|
55
92
|
|
|
56
93
|
Truthmark convierte la verdad del repositorio en una superficie explícita de flujo de trabajo para agentes:
|
|
57
94
|
|
|
58
|
-
-
|
|
95
|
+
- `.truthmark/config.yml` define el contrato de jerarquía confirmado en el repositorio.
|
|
59
96
|
- `docs/truthmark/areas.md` y los archivos de rutas secundarias delegadas asignan áreas de código a los documentos que las gobiernan.
|
|
97
|
+
- Truth Document genera o repara documentos de verdad canónica para comportamiento ya implementado cuando no hace falta cambiar código.
|
|
60
98
|
- Truth Sync mantiene alineados los documentos de verdad asignados cuando hay cambios funcionales.
|
|
61
99
|
- Truth Realize ofrece a los cambios que empiezan en documentación una ruta acotada para actualizar código.
|
|
62
100
|
- `truthmark check` valida los artefactos de verdad resultantes.
|
|
@@ -92,88 +130,145 @@ Revisa `.truthmark/config.yml` antes de `init`; es el contrato de jerarquía con
|
|
|
92
130
|
|
|
93
131
|
```text
|
|
94
132
|
.truthmark/config.yml
|
|
95
|
-
TRUTHMARK.md
|
|
96
133
|
docs/truthmark/areas.md
|
|
97
134
|
docs/truthmark/areas/repository.md
|
|
98
|
-
docs/
|
|
99
|
-
docs/
|
|
100
|
-
docs/
|
|
135
|
+
docs/templates/behavior-doc.md
|
|
136
|
+
docs/truth/README.md
|
|
137
|
+
docs/truth/repository/README.md
|
|
138
|
+
docs/truth/repository/overview.md
|
|
101
139
|
AGENTS.md
|
|
102
140
|
CLAUDE.md
|
|
141
|
+
GEMINI.md
|
|
103
142
|
```
|
|
104
143
|
|
|
105
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`.
|
|
106
|
-
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`.
|
|
107
146
|
|
|
108
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`.
|
|
109
148
|
|
|
110
149
|
## Cómo se ejecuta
|
|
111
150
|
|
|
112
|
-
Truthmark no
|
|
113
|
-
|
|
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
|
+
|
|
153
|
+
### Comportamiento existente sin docs
|
|
154
|
+
|
|
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:
|
|
114
174
|
|
|
115
175
|
```text
|
|
116
176
|
el agente cambia código funcional
|
|
117
177
|
se ejecutan las pruebas relevantes
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
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
|
|
121
181
|
```
|
|
122
182
|
|
|
123
|
-
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
|
+
|
|
124
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
|
+
|
|
125
193
|
Usa este flujo cuando una decisión de producto o arquitectura empieza en la documentación:
|
|
126
194
|
|
|
127
195
|
```text
|
|
128
|
-
el usuario edita
|
|
129
|
-
el usuario invoca explícitamente
|
|
130
|
-
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
|
|
131
199
|
el agente actualiza solo el código
|
|
132
200
|
se ejecutan las pruebas relevantes
|
|
133
|
-
|
|
201
|
+
confirmar o entregar el trabajo
|
|
134
202
|
```
|
|
135
203
|
|
|
136
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
|
+
|
|
137
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`.
|
|
138
207
|
|
|
208
|
+
```text
|
|
209
|
+
/truthmark-realize realiza docs/truth/authentication/session-timeout.md como código
|
|
210
|
+
```
|
|
211
|
+
|
|
139
212
|
## Qué instala
|
|
140
213
|
|
|
141
|
-
Truthmark mantiene pequeña la superficie duradera de flujo de trabajo
|
|
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.
|
|
142
215
|
|
|
143
|
-
- `.truthmark/config.yml` para
|
|
144
|
-
- `TRUTHMARK.md` para el contrato de flujo de trabajo local a la rama
|
|
216
|
+
- `.truthmark/config.yml` para el contrato de jerarquía confirmado y legible por máquina
|
|
145
217
|
- `docs/truthmark/areas.md` para el índice raíz de rutas
|
|
146
218
|
- `docs/truthmark/areas/**/*.md` para archivos de rutas secundarias delegadas
|
|
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
|
|
147
220
|
- bloques de instrucciones administrados para plataformas configuradas como `AGENTS.md`, `CLAUDE.md`, instrucciones de Copilot y `GEMINI.md`
|
|
148
|
-
- skills, prompts o comandos nativos del host para Truth Structure, Truth Sync, Truth Realize y Truth Check
|
|
221
|
+
- skills, prompts o comandos nativos del host para Truth Structure, Truth Document, Truth Sync, Truth Realize y Truth Check
|
|
149
222
|
|
|
150
223
|
Las superficies de flujo de trabajo instaladas son el entorno de ejecución:
|
|
151
224
|
|
|
152
225
|
- Truth Structure crea o repara el enrutamiento de áreas y documentos de verdad iniciales.
|
|
226
|
+
- Truth Document crea o repara documentos de verdad para comportamiento ya implementado.
|
|
153
227
|
- Truth Sync mantiene alineados los documentos de verdad asignados con los cambios funcionales.
|
|
154
228
|
- Truth Realize actualiza el código para que coincida con los documentos de verdad.
|
|
155
229
|
- Truth Check audita la salud de la verdad del repositorio.
|
|
156
230
|
|
|
157
|
-
Los `README.md` de funciones son índices. Se espera que Truth Sync lea y actualice documentos hoja acotados para el comportamiento actual.
|
|
231
|
+
Los `README.md` de funciones son índices. Se espera que Truth Sync lea y actualice documentos hoja acotados para el comportamiento actual. Las superficies de flujo generadas preservan la autoridad de las reglas del repositorio mientras tratan el código de implementación y los documentos canónicos de verdad como evidencia del comportamiento actual.
|
|
158
232
|
|
|
159
233
|
Las superficies generadas son administradas por Truthmark, incluyen un marcador de versión y pueden refrescarse con `truthmark init`.
|
|
160
234
|
|
|
161
235
|
## Comandos
|
|
162
236
|
|
|
163
|
-
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,
|
|
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.
|
|
164
238
|
|
|
165
239
|
```bash
|
|
166
240
|
truthmark config
|
|
167
241
|
truthmark init
|
|
168
242
|
truthmark check
|
|
243
|
+
truthmark index
|
|
244
|
+
truthmark impact --base main
|
|
245
|
+
truthmark context --workflow truth-sync --base main
|
|
169
246
|
truthmark config --json
|
|
170
247
|
truthmark check --json
|
|
248
|
+
truthmark index --json
|
|
249
|
+
truthmark impact --base main --json
|
|
250
|
+
truthmark context --workflow truth-sync --base main --json
|
|
171
251
|
```
|
|
172
252
|
|
|
173
253
|
`config` solo escribe `.truthmark/config.yml`, salvo que se use `--stdout`.
|
|
254
|
+
|
|
174
255
|
`init` requiere `.truthmark/config.yml` y luego instala o refresca los archivos locales de flujo de trabajo.
|
|
256
|
+
|
|
175
257
|
`check` valida configuración, autoridad, enrutamiento, documentos que contienen decisiones, frontmatter, enlaces internos, alcance de rama y diagnósticos de cobertura.
|
|
176
|
-
|
|
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
|
+
|
|
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.
|
|
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
|
+
```
|
|
177
272
|
|
|
178
273
|
## Por qué existe
|
|
179
274
|
|
|
@@ -191,16 +286,21 @@ Asume que los equipos serios necesitan:
|
|
|
191
286
|
|
|
192
287
|
## Estado del proyecto
|
|
193
288
|
|
|
194
|
-
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.
|
|
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
|
+
|
|
195
291
|
V1 actualmente ofrece:
|
|
196
292
|
|
|
197
293
|
- `truthmark config`
|
|
198
294
|
- `truthmark init`
|
|
199
295
|
- `truthmark check`
|
|
296
|
+
- `truthmark index`
|
|
297
|
+
- `truthmark impact`
|
|
298
|
+
- `truthmark context`
|
|
200
299
|
- instrucciones de flujo de trabajo administradas en `AGENTS.md`
|
|
201
|
-
- superficies de skill generadas para Truth Structure, 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 Realize y Truth Check en los anfitriones de agentes configurados
|
|
202
301
|
- metadatos de alcance de rama
|
|
203
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
|
|
204
304
|
|
|
205
305
|
## Documentación
|
|
206
306
|
|
|
@@ -208,10 +308,10 @@ El README raíz es para personas que evalúan y prueban el paquete. Las especifi
|
|
|
208
308
|
|
|
209
309
|
- [Índice de documentación](docs/README.md)
|
|
210
310
|
- [Resumen de arquitectura](docs/architecture/overview.md)
|
|
211
|
-
- [Contratos de API y CLI](docs/
|
|
212
|
-
- [Comportamiento de init y scaffold](docs/
|
|
213
|
-
- [Diagnósticos de check](docs/
|
|
214
|
-
- [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)
|
|
215
315
|
- [Guía para mantener la verdad del repositorio](docs/standards/maintaining-repository-truth.md)
|
|
216
316
|
|
|
217
317
|
El comportamiento actual pertenece al árbol canónico de documentación anterior.
|
package/README.md
CHANGED
|
@@ -1,40 +1,68 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Truthmark
|
|
3
|
+
**Truthmark installs repository truth workflows for AI software development.**
|
|
4
4
|
|
|
5
5
|
English | [Deutsch](README.de.md) | [中文](README.zh.md) | [Español](README.es.md) | [Русский](README.ru.md)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
<img src="docs/assets/truthmark-banner.png" alt="Truthmark banner" width="100%" />
|
|
8
8
|
|
|
9
|
-
AI coding agents
|
|
9
|
+
AI coding agents already write code fast. The expensive part is keeping repository truth aligned with what changed.
|
|
10
10
|
|
|
11
|
-
Truthmark
|
|
11
|
+
Truthmark adds a finish-time workflow guard to that workflow. The normal path is simple:
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
- agent changes functional code
|
|
14
|
+
- run relevant tests
|
|
15
|
+
- the installed Truth Sync workflow updates mapped truth docs before the agent finishes
|
|
16
|
+
- review the truth-doc diff if one was produced
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
Most tools ask teams to adopt a habit. Truthmark turns the habit into repository workflow infrastructure.
|
|
16
19
|
|
|
17
|
-
|
|
20
|
+
Truthmark turns an AI workflow into repo infrastructure, not personal tooling. It installs a Git-native, branch-scoped truth layer inside the repository, gives agents explicit routing and bounded workflow surfaces, and keeps that truth reviewable in Git instead of scattering it across prompt history, stale docs, or private tool memory.
|
|
18
21
|
|
|
19
|
-
|
|
22
|
+
That matters because the workflow lives with the branch. Once a repository is initialized, the rules, routing, and installed workflow surfaces travel in-repo, so collaboration and handoffs are less dependent on one person's machine setup.
|
|
20
23
|
|
|
21
|
-
|
|
24
|
+
For teams who already know agents can generate code, Truthmark answers the next problem: how to keep the repository itself legible, reviewable, and governable as AI-assisted work scales.
|
|
22
25
|
|
|
23
|
-
|
|
26
|
+
## Visual overview
|
|
24
27
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
28
|
+
<table>
|
|
29
|
+
<tr>
|
|
30
|
+
<td align="center" width="50%">
|
|
31
|
+
<img src="docs/assets/truthmark-features.png" alt="Truthmark features" width="100%" />
|
|
32
|
+
<br><strong>Features</strong><br>
|
|
33
|
+
What Truthmark installs and how the workflow surface is split.
|
|
34
|
+
</td>
|
|
35
|
+
<td align="center" width="50%">
|
|
36
|
+
<img src="docs/assets/truthmark-position.png" alt="Truthmark position" width="100%" />
|
|
37
|
+
<br><strong>Position</strong><br>
|
|
38
|
+
Where Truthmark fits relative to prompts, memory, and spec workflows.
|
|
39
|
+
</td>
|
|
40
|
+
</tr>
|
|
41
|
+
<tr>
|
|
42
|
+
<td align="center" colspan="2">
|
|
43
|
+
<img src="docs/assets/truthmark-syncflow.png" alt="Truthmark sync flow" width="100%" />
|
|
44
|
+
<br><strong>Sync flow</strong><br>
|
|
45
|
+
How Truth Sync closes out normal code changes before handoff.
|
|
46
|
+
</td>
|
|
47
|
+
</tr>
|
|
48
|
+
</table>
|
|
32
49
|
|
|
33
|
-
|
|
50
|
+
## Why teams adopt it
|
|
51
|
+
|
|
52
|
+
Truthmark is not trying to make agents sound smarter. It is trying to make AI-assisted repository change easier to trust.
|
|
53
|
+
|
|
54
|
+
- Installed Truth Sync after code changes turns documentation maintenance into a workflow safeguard instead of a team habit.
|
|
55
|
+
- Branch-scoped truth moves with the code, so reviewers can inspect current truth in ordinary Git diffs.
|
|
56
|
+
- Repository-native workflow surfaces make rollout lighter and handoffs more resilient than per-user setup alone.
|
|
57
|
+
- Explicit routing in `docs/truthmark/areas.md` and delegated child route files gives agents ownership boundaries and safer write paths.
|
|
58
|
+
- Local-first operation avoids a daemon, database, remote service, or MCP dependency.
|
|
59
|
+
- The routing model is language-agnostic, with coverage diagnostics for common JavaScript, TypeScript, Go, Python, C#, and Java code surfaces.
|
|
60
|
+
|
|
61
|
+
For tech leads, the value is governance without extra infrastructure: tests, code review, and ownership still do the real work; Truthmark makes the agent's context durable, inspectable, and branch-scoped.
|
|
34
62
|
|
|
35
63
|
## Where Truthmark fits
|
|
36
64
|
|
|
37
|
-
Truthmark is not
|
|
65
|
+
Truthmark is not a general AI productivity suite. It occupies a specific layer of the stack: branch-scoped, reviewable repository truth that stays aligned with implementation.
|
|
38
66
|
|
|
39
67
|
| If you need | Best fit |
|
|
40
68
|
| --------------------------------------------------------------------- | --------------------------------------- |
|
|
@@ -47,6 +75,7 @@ The point is not that prompts, memory, or specs are useless. The point is that n
|
|
|
47
75
|
|
|
48
76
|
## Table of Contents
|
|
49
77
|
|
|
78
|
+
- [Why teams adopt it](#why-teams-adopt-it)
|
|
50
79
|
- [What Truthmark solves](#what-truthmark-solves)
|
|
51
80
|
- [Where Truthmark fits](#where-truthmark-fits)
|
|
52
81
|
- [Get started](#get-started)
|
|
@@ -63,8 +92,9 @@ The point is not that prompts, memory, or specs are useless. The point is that n
|
|
|
63
92
|
|
|
64
93
|
Truthmark turns repository truth into an explicit workflow surface for agents:
|
|
65
94
|
|
|
66
|
-
-
|
|
95
|
+
- `.truthmark/config.yml` defines the committed hierarchy contract.
|
|
67
96
|
- `docs/truthmark/areas.md` and delegated child route files map code areas to the docs that own them.
|
|
97
|
+
- Truth Document generates or repairs canonical truth docs for existing implemented behavior when no code change is needed.
|
|
68
98
|
- Truth Sync keeps mapped truth docs aligned with functional changes.
|
|
69
99
|
- Truth Realize gives doc-first changes a bounded code-update path.
|
|
70
100
|
- `truthmark check` validates the resulting truth artifacts.
|
|
@@ -101,42 +131,69 @@ Review `.truthmark/config.yml` before `init`; it is the committed hierarchy cont
|
|
|
101
131
|
|
|
102
132
|
```text
|
|
103
133
|
.truthmark/config.yml
|
|
104
|
-
TRUTHMARK.md
|
|
105
134
|
docs/truthmark/areas.md
|
|
106
135
|
docs/truthmark/areas/repository.md
|
|
107
|
-
docs/
|
|
108
|
-
docs/
|
|
109
|
-
docs/
|
|
136
|
+
docs/templates/behavior-doc.md
|
|
137
|
+
docs/truth/README.md
|
|
138
|
+
docs/truth/repository/README.md
|
|
139
|
+
docs/truth/repository/overview.md
|
|
110
140
|
AGENTS.md
|
|
111
141
|
CLAUDE.md
|
|
142
|
+
GEMINI.md
|
|
112
143
|
```
|
|
113
144
|
|
|
114
145
|
Supported platforms are `codex`, `opencode`, `claude-code`, `github-copilot`, and `gemini-cli`. The default config includes all of them; remove platforms you do not use from `.truthmark/config.yml` before rerunning `truthmark init`.
|
|
115
146
|
|
|
116
|
-
The default scaffold keeps
|
|
147
|
+
The default scaffold keeps truth `README.md` files as indexes and starts current behavior truth in bounded leaf docs such as `docs/truth/repository/overview.md`.
|
|
117
148
|
|
|
118
149
|
Existing repositories usually need one cleanup pass after `init`: run the installed Truth Structure workflow when the generated `repository` route is too broad, ownership spans multiple products or services, or route files still point at placeholder docs. Truth Structure splits broad routing, creates or repairs starter canonical truth docs, and gives Truth Sync precise destinations before functional-code work begins. Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-structure`; OpenCode-style hosts can invoke `/skill truthmark-structure`.
|
|
119
150
|
|
|
151
|
+
```text
|
|
152
|
+
/truthmark-structure split the broad repository area into auth, billing, and notifications
|
|
153
|
+
```
|
|
154
|
+
|
|
120
155
|
## How it runs
|
|
121
156
|
|
|
122
|
-
Truthmark
|
|
157
|
+
Truthmark is strongest on the default path, not as a pile of manual commands. The acting agent and host environment decide whether to delegate or run the installed workflow inline.
|
|
158
|
+
|
|
159
|
+
### Existing behavior without docs
|
|
160
|
+
|
|
161
|
+
Use this when implementation already exists but the canonical truth docs are missing or weak:
|
|
162
|
+
|
|
163
|
+
```text
|
|
164
|
+
user identifies an implemented behavior or API endpoint
|
|
165
|
+
user explicitly invokes Truth Document
|
|
166
|
+
agent reads implementation, tests, routing, and existing docs
|
|
167
|
+
agent writes truth docs and routing only
|
|
168
|
+
review the truth-doc diff
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
Truth Document is manual and implementation-first: code is inspected as evidence, truth docs are created or repaired, and functional code must not be changed. Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-document`. OpenCode-style hosts can invoke `/skill truthmark-document`.
|
|
172
|
+
|
|
173
|
+
```text
|
|
174
|
+
/truthmark-document document the implemented session timeout behavior under docs/truth/authentication
|
|
175
|
+
```
|
|
123
176
|
|
|
124
177
|
### Normal code changes
|
|
125
178
|
|
|
126
|
-
Most users should not need to invoke Truth Sync directly. The normal path is:
|
|
179
|
+
Most users should not need to invoke Truth Sync directly. The important behavior is that the installed agent workflow treats Truth Sync as a finish-time guard when functional code changed. The normal path is:
|
|
127
180
|
|
|
128
181
|
```text
|
|
129
182
|
agent changes functional code
|
|
130
183
|
run relevant tests
|
|
131
|
-
Truth Sync
|
|
184
|
+
the installed Truth Sync workflow runs before the agent finishes
|
|
132
185
|
review the truth-doc diff if one was produced
|
|
133
186
|
commit or hand off the work
|
|
134
187
|
```
|
|
135
188
|
|
|
136
|
-
Truth Sync is code-first: code leads, truth docs follow, and Truth Sync must not rewrite functional code. Its main job is to
|
|
189
|
+
Truth Sync is code-first: code leads, truth docs follow, and Truth Sync must not rewrite functional code. Its main job is to run through the installed agent workflow as a finish-time guard when functional code changed. Direct invocation is mainly for troubleshooting, forcing an early sync before handoff, or running the workflow intentionally.
|
|
137
190
|
|
|
138
191
|
Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-sync`. OpenCode-style hosts can invoke `/skill truthmark-sync`.
|
|
139
192
|
|
|
193
|
+
```text
|
|
194
|
+
/truthmark-sync sync the repository truth now before handoff
|
|
195
|
+
```
|
|
196
|
+
|
|
140
197
|
### Doc-first changes
|
|
141
198
|
|
|
142
199
|
Use this when a product or architecture decision starts in docs:
|
|
@@ -154,38 +211,49 @@ Truth Realize is manual and doc-first: truth docs lead, code follows, and the ag
|
|
|
154
211
|
|
|
155
212
|
Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-realize`. OpenCode-style hosts can invoke `/skill truthmark-realize`.
|
|
156
213
|
|
|
214
|
+
```text
|
|
215
|
+
/truthmark-realize realize docs/truth/authentication/session-timeout.md into code
|
|
216
|
+
```
|
|
217
|
+
|
|
157
218
|
## What it installs
|
|
158
219
|
|
|
159
|
-
Truthmark keeps the durable workflow surface small
|
|
220
|
+
Truthmark keeps the durable workflow surface small and repository-native. After `truthmark init`, the repo itself carries the routing, rules, and installed workflow surfaces, so teams are not relying only on one operator's local setup.
|
|
160
221
|
|
|
161
|
-
- `.truthmark/config.yml` for machine-readable
|
|
162
|
-
- `TRUTHMARK.md` for the branch-local workflow contract
|
|
222
|
+
- `.truthmark/config.yml` for the machine-readable committed hierarchy contract
|
|
163
223
|
- `docs/truthmark/areas.md` for the root route index
|
|
164
224
|
- `docs/truthmark/areas/**/*.md` for delegated child route files
|
|
225
|
+
- `docs/templates/behavior-doc.md` plus the other kind-specific templates under `docs/templates/` for the editable truth-doc standards used by generated workflows
|
|
165
226
|
- managed instruction blocks for configured platforms such as `AGENTS.md`, `CLAUDE.md`, Copilot instructions, and `GEMINI.md`
|
|
166
|
-
- host-native skills, prompts, or commands for Truth Structure, Truth Sync, Truth Realize, and Truth Check
|
|
227
|
+
- host-native skills, prompts, or commands for Truth Structure, Truth Document, Truth Sync, Truth Realize, and Truth Check
|
|
167
228
|
|
|
168
229
|
The installed workflow surfaces are the runtime:
|
|
169
230
|
|
|
170
231
|
- Truth Structure creates or repairs area routing and starter truth docs.
|
|
232
|
+
- Truth Document creates or repairs truth docs for existing implemented behavior.
|
|
171
233
|
- Truth Sync keeps mapped truth docs aligned with functional changes.
|
|
172
234
|
- Truth Realize updates code to match truth docs.
|
|
173
235
|
- Truth Check audits repository truth health.
|
|
174
236
|
|
|
175
|
-
|
|
237
|
+
Truth `README.md` files are indexes. Truth Sync is expected to read and update bounded leaf docs for current behavior. Generated workflow surfaces preserve repository-rule authority while treating implementation code and canonical truth docs as evidence for current behavior.
|
|
176
238
|
|
|
177
239
|
Generated surfaces are managed by Truthmark, include a version marker, and may be refreshed by `truthmark init`.
|
|
178
240
|
|
|
179
241
|
## Commands
|
|
180
242
|
|
|
181
|
-
Truthmark V1
|
|
243
|
+
Truthmark V1 keeps the CLI focused because the ongoing workflow is meant to live in the installed agent surfaces, not in a long list of daily manual commands. In downstream repositories, `truthmark config` creates the committed hierarchy contract, `truthmark init` installs and refreshes workflow surfaces from that reviewed config, `truthmark check` validates truth artifacts for manual audits, CI, or troubleshooting, and the repository-intelligence commands generate derived review artifacts when local tooling is available.
|
|
182
244
|
|
|
183
245
|
```bash
|
|
184
246
|
truthmark config
|
|
185
247
|
truthmark init
|
|
186
248
|
truthmark check
|
|
249
|
+
truthmark index
|
|
250
|
+
truthmark impact --base main
|
|
251
|
+
truthmark context --workflow truth-sync --base main
|
|
187
252
|
truthmark config --json
|
|
188
253
|
truthmark check --json
|
|
254
|
+
truthmark index --json
|
|
255
|
+
truthmark impact --base main --json
|
|
256
|
+
truthmark context --workflow truth-sync --base main --json
|
|
189
257
|
```
|
|
190
258
|
|
|
191
259
|
`config` writes only `.truthmark/config.yml` unless `--stdout` is used.
|
|
@@ -194,10 +262,20 @@ truthmark check --json
|
|
|
194
262
|
|
|
195
263
|
`check` validates configuration, authority, routing, decision-bearing docs, frontmatter, internal links, branch scope, and coverage diagnostics.
|
|
196
264
|
|
|
197
|
-
|
|
265
|
+
`index` builds RepoIndex and RouteMap JSON for the active checkout.
|
|
266
|
+
|
|
267
|
+
`impact --base <ref>` maps changed files to routed truth docs, owning routes, nearby tests, and public symbols.
|
|
268
|
+
|
|
269
|
+
`context --workflow <workflow> [--base <ref>]` generates a bounded ContextPack for Truth Sync, Truth Document, or Truth Realize. `--format markdown` renders a human-readable pack.
|
|
270
|
+
|
|
271
|
+
Truth Structure, Truth Document, Truth Sync, Truth Realize, and Truth Check are installed agent workflows, not top-level daily CLI commands.
|
|
198
272
|
|
|
199
273
|
They run through the configured agent host surfaces, for example Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*`, or Gemini `/truthmark:*`.
|
|
200
274
|
|
|
275
|
+
```text
|
|
276
|
+
/truthmark-check audit routing and truth coverage before review
|
|
277
|
+
```
|
|
278
|
+
|
|
201
279
|
## Why it exists
|
|
202
280
|
|
|
203
281
|
Most AI coding workflows optimize for the next answer. Truthmark optimizes for the next handoff.
|
|
@@ -213,7 +291,7 @@ It assumes serious teams need:
|
|
|
213
291
|
- truth that travels with the branch instead of living in hidden session state
|
|
214
292
|
- workflows that still work when the package is not installed globally
|
|
215
293
|
|
|
216
|
-
Truthmark is not a memory server and it is not an MCP server. It is a repository practice packaged as a small CLI installer plus agent-native workflow surfaces.
|
|
294
|
+
Truthmark is not a memory server and it is not an MCP server. It is a repository practice packaged as a small CLI installer plus agent-native workflow surfaces that turn AI workflow rules into repo infrastructure.
|
|
217
295
|
|
|
218
296
|
## Project status
|
|
219
297
|
|
|
@@ -222,10 +300,14 @@ V1 currently provides:
|
|
|
222
300
|
- `truthmark config`
|
|
223
301
|
- `truthmark init`
|
|
224
302
|
- `truthmark check`
|
|
303
|
+
- `truthmark index`
|
|
304
|
+
- `truthmark impact`
|
|
305
|
+
- `truthmark context`
|
|
225
306
|
- managed `AGENTS.md` workflow instructions
|
|
226
|
-
- generated Truth Structure, Truth Sync, Truth Realize, and Truth Check skill surfaces for configured agent hosts
|
|
307
|
+
- generated Truth Structure, Truth Document, Truth Sync, Truth Realize, and Truth Check skill surfaces for configured agent hosts
|
|
227
308
|
- branch-scope metadata
|
|
228
|
-
- config, authority, routing, decision-structure, frontmatter, link, and polyglot coverage diagnostics
|
|
309
|
+
- config, authority, routing, decision-structure, frontmatter, link, freshness, and polyglot coverage diagnostics
|
|
310
|
+
- derived RepoIndex, RouteMap, ImpactSet, and ContextPack artifacts for faster local review when the CLI is available
|
|
229
311
|
|
|
230
312
|
## Documentation
|
|
231
313
|
|
|
@@ -233,10 +315,10 @@ The root README is for people evaluating and trying the package. Detailed functi
|
|
|
233
315
|
|
|
234
316
|
- [Docs index](docs/README.md)
|
|
235
317
|
- [Architecture overview](docs/architecture/overview.md)
|
|
236
|
-
- [API and CLI contracts](docs/
|
|
237
|
-
- [Init and scaffold behavior](docs/
|
|
238
|
-
- [Check diagnostics](docs/
|
|
239
|
-
- [Installed workflows](docs/
|
|
318
|
+
- [API and CLI contracts](docs/truth/contracts.md)
|
|
319
|
+
- [Init and scaffold behavior](docs/truth/init-and-scaffold.md)
|
|
320
|
+
- [Check diagnostics](docs/truth/check-diagnostics.md)
|
|
321
|
+
- [Installed workflows](docs/truth/workflows/overview.md)
|
|
240
322
|
- [Repository truth maintenance guide](docs/standards/maintaining-repository-truth.md)
|
|
241
323
|
|
|
242
324
|
Current behavior belongs in the canonical docs tree above.
|