truthmark 2.2.2 → 2.2.5

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.es.md DELETED
@@ -1,824 +0,0 @@
1
- # Truthmark
2
-
3
- **Tus agentes escriben código. Truthmark mantiene documentación para personas, versionada y revisable en Git.**
4
-
5
- [English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | Español | [Русский](README.ru.md)
6
-
7
- ![Banner de Truthmark](docs/assets/truthmark-banner.png)
8
-
9
- Los agentes de desarrollo con IA pueden cambiar un repositorio más rápido de lo que las personas pueden mantener alineada su documentación.
10
-
11
- Truthmark corrige la parte que normalmente se rompe después de escribir el código: la verdad del repositorio.
12
-
13
- Instala una capa de flujo de trabajo nativa de Git y acotada a la rama que ayuda a los agentes de desarrollo con IA a actualizar los documentos correctos, respetar los límites de propiedad y dejar a las personas diffs normales que puedan revisar.
14
-
15
- Sin servicio alojado.
16
-
17
- Sin base de datos.
18
-
19
- Sin capa oculta de memoria.
20
-
21
- Sin servidor adicional que operar.
22
-
23
- Solo verdad del repositorio que se mueve con la rama.
24
-
25
- ## El problema
26
-
27
- Los agentes de desarrollo con IA son buenos produciendo código. Eso crea un nuevo modo de fallo.
28
-
29
- La implementación cambia, pero la historia del repositorio se desvía:
30
-
31
- - el comportamiento vive en el historial de chat
32
- - los documentos de arquitectura quedan atrás
33
- - las decisiones de producto desaparecen después de la entrega
34
- - quienes revisan ven diffs de código sin los diffs de verdad relacionados
35
- - las ramas desarrollan silenciosamente distintas versiones de “lo que es verdad”
36
- - cada sesión de agente tiene que redescubrir la verdad del repositorio desde cero
37
-
38
- Truthmark convierte esa verdad frágil del repositorio en infraestructura versionada en Git.
39
-
40
- En lugar de depender de que cada persona y cada agente recuerden el hábito correcto de documentación, Truthmark instala ese hábito en el repositorio.
41
-
42
- ## La promesa
43
-
44
- Cuando un agente cambia código funcional, el trabajo no debería terminar con solo un diff de código.
45
-
46
- El camino normal de Truthmark es:
47
-
48
- ```text
49
- el agente cambia código funcional
50
- se ejecutan pruebas relevantes
51
- Truth Sync revisa los documentos de verdad asignados
52
- los documentos de verdad se actualizan cuando hace falta
53
- una persona revisa el diff de código + el diff de verdad
54
- confirmar o entregar
55
- ```
56
-
57
- Ese es el valor central: **el trabajo con IA es más fácil de confiar porque el repositorio sigue siendo legible.**
58
-
59
- ## Dos interfaces, un sistema de verdad
60
-
61
- Truthmark no es solo una CLI.
62
-
63
- Tiene dos interfaces distintas, y la distinción importa.
64
-
65
- ### 1. CLI para personas
66
-
67
- La CLI es para mantenedores, revisores y automatización.
68
-
69
- Úsala para configurar un repositorio, instalar o refrescar archivos de flujo de trabajo, validar artefactos de verdad y generar material opcional para revisión.
70
-
71
- ```bash
72
- truthmark config
73
- truthmark init
74
- truthmark check
75
- ```
76
-
77
- La CLI prepara y valida el entorno del repositorio.
78
-
79
- No es el entorno de ejecución del flujo de trabajo con IA.
80
-
81
- ### 2. Interfaces de flujo de trabajo para IA
82
-
83
- Las interfaces para IA son para agentes de desarrollo.
84
-
85
- Truthmark instala skills, prompts, comandos, bloques de instrucciones administrados e interfaces de subagentes nativas del host para que los agentes de IA puedan seguir flujos de verdad específicos del repositorio dentro de sus herramientas habituales de desarrollo.
86
-
87
- Ejemplos:
88
-
89
- ```text
90
- /truthmark-sync
91
- /truthmark-document
92
- /truthmark-structure
93
- /truthmark-realize
94
- /truthmark-preview
95
- /truthmark-check
96
- ```
97
-
98
- Parecen comandos porque los hosts de agentes exponen flujos mediante slash commands, prompts, skills o comandos de proyecto.
99
-
100
- No son comandos de shell.
101
-
102
- Son puntos de entrada de flujo para IA.
103
-
104
- La división es el producto:
105
-
106
- ```text
107
- las personas poseen el contrato del repositorio
108
- Truthmark instala el contrato en el repositorio
109
- los agentes operan dentro de ese contrato
110
- las actualizaciones de verdad aparecen como diffs de Git
111
- las personas revisan el resultado
112
- ```
113
-
114
- ## Inicio rápido
115
-
116
- ### Requisitos
117
-
118
- - Node.js `>=20`
119
- - npm
120
- - un repositorio Git
121
-
122
- ### Instalar Truthmark
123
-
124
- Ejecuta esto dentro del repositorio que quieres inicializar:
125
-
126
- ```bash
127
- cd /path/to/your-repo
128
- npm install -g truthmark
129
- ```
130
-
131
- ### Crear el contrato de verdad del repositorio
132
-
133
- ```bash
134
- truthmark config
135
- ```
136
-
137
- Esto crea:
138
-
139
- ```text
140
- .truthmark/config.yml
141
- ```
142
-
143
- Revisa este archivo antes de continuar. Define el contrato de jerarquía confirmado en el repositorio.
144
-
145
- ### Instalar las interfaces de flujo de trabajo
146
-
147
- ```bash
148
- truthmark init
149
- ```
150
-
151
- Esto instala o refresca:
152
-
153
- - archivos de rutas
154
- - scaffolding de documentos de verdad
155
- - bloques de instrucciones administrados
156
- - interfaces de flujo de trabajo para IA en las plataformas configuradas
157
-
158
- Las plantillas predeterminadas de documentos de verdad se justifican en [Template Standards](docs/standards/template-standards.md), que las mapea a referencias reconocidas de ingeniería de software como ISO/IEC/IEEE 42010, ISO/IEC/IEEE 29148, ISO/IEC/IEEE 12207, ISO/IEC 25010, C4, arc42, OpenAPI, SemVer, Google SRE y Diátaxis.
159
-
160
- ### Validar la configuración
161
-
162
- ```bash
163
- truthmark check
164
- ```
165
-
166
- Después revisa los archivos generados antes de confirmar.
167
-
168
- Los archivos exactos dependen de `.truthmark/config.yml`, pero la instalación siempre tiene la misma forma: rutas, scaffolding de documentos de verdad, instrucciones administradas compactas e interfaces de flujo de trabajo nativas del host para las plataformas habilitadas.
169
-
170
- ## Primer uso real
171
-
172
- La mayoría de los repositorios necesita una pasada de limpieza después de la inicialización.
173
-
174
- El scaffold predeterminado empieza con un área amplia provisional de arranque `repository`. Antes de sincronizar código real de forma normal, divide esa ruta de arranque en rutas precisas.
175
-
176
- Pide a tu agente que divida la ruta amplia en áreas reales de producto, servicio, dominio o propiedad:
177
-
178
- ```text
179
- /truthmark-structure divide el área amplia repository en auth, billing y notifications
180
- ```
181
-
182
- Si el proyecto ya tiene funcionalidades implementadas pero faltan documentos de verdad o son débiles, pide al flujo Truth Document instalado que documente un alcance enfocado:
183
-
184
- ```text
185
- /truthmark-document documenta el comportamiento implementado de payment retry en src/billing/retry.ts y sus tests relacionados
186
- ```
187
-
188
- Truth Document es el primer flujo más común para proyectos existentes. Inspecciona implementación, pruebas, rutas y documentación existente, y luego crea o repara documentos de verdad y rutas sin cambiar código funcional.
189
-
190
- Después usa tu agente de programación con IA normalmente.
191
-
192
- Cuando el agente cambia código funcional, Truth Sync actúa como guarda de cierre que revisa si los documentos de verdad asignados deben cambiar antes de la entrega.
193
-
194
- ## Qué obtienes
195
-
196
- | Capacidad | Qué hace |
197
- | --- | --- |
198
- | Verdad nativa de Git | Mantiene la verdad del repositorio en Markdown y config versionados. |
199
- | Documentación acotada a la rama | La verdad se mueve con la rama en lugar de vivir en una sesión privada. |
200
- | CLI para personas | Da a mantenedores comandos de configuración, refresco, validación e inspección. |
201
- | Flujos orientados a IA | Da a los agentes flujos nativos del host para sincronización, documentación, estructura, preview, realización y auditoría. |
202
- | Rutas explícitas | Mapea áreas de código a documentos de verdad canónicos. |
203
- | Entregas revisables | Produce diffs normales de Git para código y documentos de verdad. |
204
- | Operación local-first | No requiere servicio alojado, demonio, base de datos ni servidor MCP. |
205
- | Límites de escritura más seguros | Separa flujos code-first, doc-first, read-only y doc-only. |
206
- | Validación | Reporta problemas de rutas, autoridad, frontmatter, enlaces, interfaces generadas, alcance de rama, vigencia y cobertura. |
207
- | Portal opcional | Genera un sitio HTML estático versionado desde documentos de verdad Markdown cuando se habilita y solicita explícitamente. |
208
-
209
- ## Resumen visual
210
-
211
- ![Características de Truthmark](docs/assets/truthmark-features.png)
212
-
213
- **Características:** qué instala Truthmark y cómo se divide la interfaz de flujo de trabajo.
214
-
215
- ![Posición de Truthmark](docs/assets/truthmark-position.png)
216
-
217
- **Posición:** dónde encaja Truthmark frente a prompts, memoria y flujos de especificación.
218
-
219
- ![Flujo de sync de Truthmark](docs/assets/truthmark-syncflow.png)
220
-
221
- **Flujo de sync:** cómo Truth Sync cierra cambios normales de código antes de la entrega.
222
-
223
- ## Por qué los equipos lo adoptan
224
-
225
- Truthmark es para equipos que ya saben que los agentes de IA pueden generar código.
226
-
227
- El siguiente problema es la gobernanza.
228
-
229
- No gobernanza como ceremonia. Gobernanza como una pregunta simple:
230
-
231
- > Después de este cambio asistido por IA, ¿el repositorio todavía dice la verdad?
232
-
233
- Truthmark ayuda a los equipos a responder con archivos versionados, rutas explícitas y diffs revisables.
234
-
235
- Es útil cuando necesitas:
236
-
237
- - menos deriva de documentación
238
- - mejores entregas
239
- - verdad de producto específica de cada rama
240
- - documentación duradera de arquitectura y API
241
- - propiedad explícita entre documentos y código
242
- - límites de escritura más seguros para agentes
243
- - documentación revisable en lugar de memoria oculta
244
- - flujos de IA que sigan funcionando desde archivos versionados del repositorio
245
-
246
- ## Dónde encaja Truthmark
247
-
248
- Truthmark no reemplaza prompts, memoria, especificaciones, pruebas ni revisión de código.
249
-
250
- Les da a esos flujos un lugar duradero donde aterrizar en Git.
251
-
252
- | Necesidad | Mejor opción |
253
- | --- | --- |
254
- | Mejor salida de una sesión de agente | Mejor prompt |
255
- | Continuidad personal o por sesión | Herramienta de memoria |
256
- | Trabajo de funciones plan-first | Flujo de especificación |
257
- | Verdad acotada a la rama que viaja con el código | Truthmark |
258
- | Validar la corrección del comportamiento | Pruebas y revisión |
259
- | Revisar cambios de documentación asistidos por IA | Truthmark más revisión Git |
260
-
261
- El carril de Truthmark es estrecho por diseño:
262
-
263
- ```text
264
- hacer explícita la verdad del repositorio
265
- mapearla al código
266
- instalar flujos de agentes alrededor de ella
267
- mantener el resultado revisable en Git
268
- ```
269
-
270
- ## Cómo se ejecuta Truthmark
271
-
272
- Truthmark se ejecuta localmente contra el worktree Git activo.
273
-
274
- La CLI para personas lee y escribe archivos del repositorio, y luego termina.
275
-
276
- Las interfaces de flujo de trabajo para IA son archivos versionados que los hosts de agentes pueden cargar después. Eso permite que los agentes sigan el flujo instalado desde el estado del repositorio, sin depender de un proceso de Truthmark en segundo plano.
277
-
278
- Las capas encajan así:
279
-
280
- ```mermaid
281
- flowchart LR
282
- Human["Human / CI"] --> CLI["Truthmark CLI"]
283
- CLI --> Config["Config y rutas"]
284
- CLI --> Truth["Documentos truth canónicos"]
285
- CLI --> Surfaces["Workflows nativos del host generados"]
286
- Surfaces --> Hosts["Codex / Claude Code / Copilot / OpenCode / Gemini"]
287
- Hosts --> Worktree["Git worktree activo"]
288
- Hosts -->|"helper checks / validate / index"| CLI
289
- Worktree --> Truth
290
- ```
291
-
292
- Los agentes no hablan con un daemon de Truthmark, pero pueden ejecutar la CLI instalada de Truthmark cuando un workflow pide validación, indexación o comprobaciones auxiliares.
293
-
294
- Truthmark es dueño de las interfaces de flujo de trabajo que genera, pero el contrato importante es arquitectónico: la config y las rutas del repositorio apuntan a los agentes hacia los documentos de verdad canónicos, mientras que los workflows nativos del host dan a cada agente compatible una forma de ejecutar los mismos procedimientos de Truthmark.
295
-
296
- Las interfaces de flujo de trabajo generadas incluyen marcadores de versión de Truthmark. Después de actualizar Truthmark, vuelve a ejecutar:
297
-
298
- ```bash
299
- truthmark init
300
- ```
301
-
302
- Luego revisa los diffs generados.
303
-
304
- ## Plataformas de agentes compatibles
305
-
306
- La configuración predeterminada incluye todas las plataformas compatibles.
307
-
308
- Elimina de `.truthmark/config.yml` las plataformas que no uses, y luego vuelve a ejecutar:
309
-
310
- ```bash
311
- truthmark init
312
- ```
313
-
314
- | Nombre de plataforma en config | Interfaz generada | Forma de invocación |
315
- | --- | --- | --- |
316
- | `codex` | `.agents/skills/truthmark-*/`, `.codex/agents/` | `/truthmark-*` o `$truthmark-*` |
317
- | `claude-code` | `.claude/skills/truthmark-*/`, `.claude/agents/`, `CLAUDE.md` | `/truthmark-*` |
318
- | `github-copilot` | `.github/skills/truthmark-*/`, `.github/prompts/`, `.github/agents/`, `.github/copilot-instructions.md` | `/truthmark-*` en IDEs de Copilot compatibles; agentes personalizados `@truth-*` en Copilot CLI |
319
- | `opencode` | `.opencode/skills/truthmark-*/`, `.opencode/agents/` | `/skill truthmark-*` |
320
- | `gemini-cli` | `.gemini/skills/truthmark-*/`, `.gemini/commands/truthmark/`, `.gemini/agents/`, `GEMINI.md` | `/truthmark:*` |
321
-
322
- Los nombres de plataforma desconocidos son errores de configuración.
323
-
324
- Eliminar una plataforma detiene futuros refrescos para esa plataforma. No elimina archivos generados previamente.
325
-
326
- ## Flujos orientados a IA
327
-
328
- Estos flujos se instalan en hosts de programación con IA compatibles.
329
-
330
- Los usan agentes o hosts de agentes durante el trabajo en el repositorio. No son comandos de shell de nivel superior.
331
-
332
- | Flujo | Dirección | Úsalo cuando | Límite de escritura |
333
- | --- | --- | --- | --- |
334
- | Truth Structure | topology-first | La ruta predeterminada es demasiado amplia, la propiedad abarca varias áreas o los archivos de rutas siguen apuntando a placeholders. | Crea o repara rutas y documentos de verdad iniciales. |
335
- | Truth Document | implementation-first | El comportamiento ya existe en código, pero faltan o son débiles los documentos de verdad canónicos. | Escribe solo documentos de verdad y rutas. No debe cambiar código funcional. |
336
- | Truth Sync | code-first | Cambió código funcional y puede que los documentos de verdad asignados deban actualizarse antes de la entrega. | Actualiza documentos de verdad. Truth Sync no debe reescribir código funcional. |
337
- | Truth Preview | read-only | El agente necesita previsualizar rutas probables antes de editar. | Solo lee. No autoriza escrituras. |
338
- | Truth Realize | doc-first | Documentos de verdad de producto o arquitectura lideran y el código debe actualizarse para coincidir. | Actualiza solo código. El agente no debe editar los documentos de verdad que está realizando. |
339
- | Truth Check | audit-first | Un revisor o agente necesita auditar la salud de la verdad del repositorio. | Audita e informa. |
340
- | Truthmark Portal | presentation-only | Una persona pide explícitamente un Portal HTML estático navegable sobre los documentos de verdad del repositorio. | Escribe solo archivos estáticos generados no canónicos bajo el directorio de salida Portal configurado. |
341
-
342
- ### Distinción importante
343
-
344
- No confundas estas dos interfaces:
345
-
346
- | Interfaz | Usada por | Ejemplo | Significado |
347
- | --- | --- | --- | --- |
348
- | CLI para personas | personas, scripts, checks tipo CI | `truthmark check` | Validar artefactos de verdad del repositorio desde la terminal. |
349
- | Flujo orientado a IA | agentes de desarrollo y hosts de agentes | `/truthmark-check` | Pedir a un agente que ejecute el flujo instalado de auditoría. |
350
-
351
- Los nombres están relacionados a propósito, pero las interfaces son distintas.
352
-
353
- ## Cambio normal de código asistido por IA
354
-
355
- La mayoría de los usuarios no debería invocar Truth Sync manualmente cada vez.
356
-
357
- Truth Sync es la guarda de cierre instalada para cambios de código funcional.
358
-
359
- ```text
360
- el agente cambia código funcional
361
- el agente ejecuta o pide pruebas relevantes
362
- el flujo instalado detecta que cambió código funcional
363
- Truth Sync revisa los documentos de verdad asignados
364
- el agente actualiza documentos de verdad si hace falta
365
- una persona revisa el diff de código + el diff de verdad
366
- ```
367
-
368
- La invocación directa sigue siendo útil para depurar, forzar una sincronización temprana o hacer explícita la entrega:
369
-
370
- ```text
371
- /truthmark-sync sincroniza ahora la verdad del repositorio antes de la entrega
372
- ```
373
-
374
- ## Comportamiento existente sin docs
375
-
376
- Usa Truth Document cuando la implementación ya existe pero la verdad del repositorio está incompleta. Esta es la ruta normal para repositorios establecidos que adoptan Truthmark después de que la base de código ya existe.
377
-
378
- ```text
379
- /truthmark-document documenta el comportamiento implementado de timeout de sesión en src/auth/session.ts, src/auth/middleware.ts y tests/auth/session.test.ts
380
- ```
381
-
382
- Indica el nombre de la funcionalidad, rutas de código, rutas de pruebas o el área deseada de documentos de verdad. En hosts estilo OpenCode, llama al mismo flujo como `/skill truthmark-document ...`; en Gemini CLI, usa `/truthmark:doc ...`.
383
-
384
- Para un repositorio grande que aún tiene una ruta placeholder amplia, ejecuta primero Truth Structure y luego invoca Truth Document para una funcionalidad o un área acotada cada vez.
385
-
386
- Truth Document inspecciona implementación, pruebas, archivos de rutas y documentación existente como evidencia.
387
-
388
- Escribe solo documentos de verdad y rutas.
389
-
390
- No debe cambiar código funcional.
391
-
392
- ## Cambios doc-first
393
-
394
- Usa Truth Realize cuando una decisión de producto o arquitectura empieza en documentos y el código debe actualizarse para coincidir.
395
-
396
- ```text
397
- /truthmark-realize realiza docs/truthmark/product/capabilities/session-timeout.md como código
398
- ```
399
-
400
- Truth Realize es doc-first.
401
-
402
- Los documentos de verdad lideran. El código sigue.
403
-
404
- El agente no debe editar los documentos de verdad que está realizando.
405
-
406
- ## Preview de rutas de solo lectura
407
-
408
- Usa Truth Preview antes de un cambio cuando el agente necesita entender la ruta probable.
409
-
410
- ```text
411
- /truthmark-preview previsualiza la ruta de verdad probable para cambios en la API de billing
412
- ```
413
-
414
- Truth Preview es read-only.
415
-
416
- Es una ayuda de selección y planificación, no una autorización de escritura ni un reemplazo de Truth Check.
417
-
418
- ## Auditoría de verdad del repositorio
419
-
420
- Usa Truth Check cuando quieres un flujo de auditoría orientado a agentes.
421
-
422
- ```text
423
- /truthmark-check audita rutas y cobertura de verdad antes de la revisión
424
- ```
425
-
426
- Usa la CLI para personas cuando quieres validación en terminal:
427
-
428
- ```bash
429
- truthmark check
430
- ```
431
-
432
- Ambas son útiles. No son la misma interfaz.
433
-
434
- ## Comandos CLI para personas
435
-
436
- La mayoría de los mantenedores empieza con tres comandos.
437
-
438
- | Comando | Propósito |
439
- | --- | --- |
440
- | `truthmark config` | Crea `.truthmark/config.yml`. Solo escribe ese archivo, salvo que se use `--stdout`. |
441
- | `truthmark init` | Instala o refresca interfaces de flujo de trabajo configuradas desde la config revisada. |
442
- | `truthmark check` | Valida configuración, autoridad, rutas, documentos con decisiones, frontmatter, enlaces internos, alcance de rama, interfaces generadas, vigencia y diagnósticos de cobertura. |
443
-
444
- Los ayudantes opcionales de inteligencia del repositorio generan material derivado para revisión sobre el checkout activo, como RepoIndex, RouteMap, ImpactSet y JSON compacto de WorkflowState/action-context. Los paquetes de skills de flujo generados también pueden exponer manifiestos y políticas de helpers que llaman a validadores CLI `truthmark validate ... --json` instalados; esos helpers son aceleradores, no scripts locales empaquetados en el repo ni fuentes de verdad. Los prompts independientes de Copilot y los comandos de Gemini usan el mismo contrato de validador CLI cuando el runner instalado está disponible; de lo contrario informan un estado visible de helper omitido y hacen validación manual.
445
-
446
- No son fuentes de verdad.
447
-
448
- | Comando | Propósito |
449
- | --- | --- |
450
- | `truthmark index` | Construye JSON de RepoIndex y RouteMap para el checkout activo. |
451
- | `truthmark impact --base <ref>` | Mapea archivos cambiados a documentos de verdad enrutados, rutas propietarias, pruebas cercanas y símbolos públicos. |
452
- | `truthmark workflow status --workflow <workflow> [--base <ref>] --json` | Devuelve aplicabilidad del flujo, límites de escritura, documentos de verdad objetivo, checks, comandos helper y guía compacta de pruebas afectadas. |
453
-
454
- La salida estructurada está disponible con `--json` donde se admite.
455
-
456
- ## Truthmark Portal
457
-
458
- Truthmark Portal es un flujo opcional de presentación para equipos que quieren un sitio legible por personas sobre sus documentos de verdad versionados.
459
-
460
- Está separado deliberadamente del flujo central de verdad:
461
-
462
- - Los documentos de verdad Markdown siguen siendo canónicos.
463
- - El HTML Portal generado es solo presentación.
464
- - Portal se ejecuta solo manualmente; no se ejecuta como puerta de finalización, paso de Truth Sync, paso de `truthmark check` ni hook automático post-change.
465
- - Las escrituras de Portal permanecen dentro del directorio de salida configurado salvo que la persona cambie el alcance explícitamente.
466
- - Las páginas generadas deben usar assets locales, procedencia de fuentes y un aviso visible de que Markdown es canónico.
467
-
468
- Habilítalo con el bloque de configuración con espacio de nombres:
469
-
470
- ```yaml
471
- truthmark:
472
- generated:
473
- portal:
474
- enabled: true
475
- ```
476
-
477
- Luego vuelve a ejecutar:
478
-
479
- ```bash
480
- truthmark init
481
- ```
482
-
483
- Cuando está habilitado, Truthmark instala interfaces Portal nativas del host para las plataformas configuradas, como `/truthmark-portal` o `/truthmark:portal` según el host de agente.
484
-
485
- ## Configuración
486
-
487
- Truthmark es config-first.
488
-
489
- El archivo principal de configuración es:
490
-
491
- ```text
492
- .truthmark/config.yml
493
- ```
494
-
495
- Los repositorios nuevos deberían ejecutar:
496
-
497
- ```bash
498
- truthmark config
499
- ```
500
-
501
- Luego revisar la config generada antes de ejecutar:
502
-
503
- ```bash
504
- truthmark init
505
- ```
506
-
507
- Las áreas importantes de configuración incluyen:
508
-
509
- | Área de config | Propósito |
510
- | --- | --- |
511
- | `version` | Versión del contrato de configuración. |
512
- | `platforms` | Hosts de agentes que deben recibir interfaces generadas específicas de plataforma. |
513
- | `truthmark.workspace` | Workspace propiedad de Truthmark para rutas, documentos de verdad, plantillas y salida de presentación generada. |
514
- | Rutas fijas | Las rutas viven en `routes/areas.md` y `routes/areas/` dentro de `truthmark.workspace`; el área predeterminada es `repository` y la profundidad de delegación es `1`. |
515
- | Carriles de verdad fijos | La verdad de producto vive en `product/` y la verdad de ingeniería en `engineering/` dentro de `truthmark.workspace`. |
516
- | Plantillas fijas | Las plantillas de documentos de verdad viven en `templates/` dentro de `truthmark.workspace`. |
517
- | `truthmark.generated.portal` | Activación opcional del flujo manual de presentación: `enabled`. |
518
- | `instruction_targets` | Archivos que reciben bloques de instrucciones administrados compartidos, como `AGENTS.md`. |
519
- | `frontmatter.required` | Campos de metadatos que producen diagnósticos de error cuando faltan. |
520
- | `frontmatter.recommended` | Campos de metadatos que producen diagnósticos de revisión cuando faltan. |
521
- | `ignore` | Patrones glob excluidos de checks relevantes y lógica de rutas. |
522
-
523
- ## Rutas de verdad del repositorio
524
-
525
- Truthmark mapea áreas de código a documentos de verdad.
526
-
527
- Los archivos principales de rutas son:
528
-
529
- ```text
530
- docs/truthmark/routes/areas.md
531
- docs/truthmark/routes/areas/**/*.md
532
- ```
533
-
534
- Una ruta le dice al agente:
535
-
536
- - qué parte del código pertenece a un área
537
- - qué documentos de verdad poseen esa área
538
- - cuándo debe actualizarse la verdad
539
- - qué tipo de documento de verdad participa
540
-
541
- El scaffold predeterminado empieza con una ruta amplia provisional de arranque para que un repositorio nuevo sea enrutable. Cuando se toca código real, divide esa ruta de arranque en áreas reales de producto, servicio, dominio o propiedad antes de Truth Sync normal; no conviertas el handoff de arranque en un documento comodín de comportamiento.
542
-
543
- Ejemplo:
544
-
545
- ```text
546
- /truthmark-structure divide el área amplia repository en frontend, backend, billing y deployment
547
- ```
548
-
549
- Un buen enrutamiento da a Truth Sync destinos precisos.
550
-
551
- Un mal enrutamiento hace que los agentes adivinen.
552
-
553
- ## Qué instala Truthmark
554
-
555
- Truthmark instala una capa compacta de verdad nativa del repositorio.
556
-
557
- Lo instala en cuatro capas:
558
-
559
- - configuración y rutas para límites de propiedad
560
- - documentos de verdad canónicos y plantillas iniciales
561
- - bloques de instrucciones administrados y compactos para instrucciones de agente en todo el repositorio
562
- - paquetes de flujo de trabajo, comandos, prompts y agentes verificadores nativos del host para las plataformas habilitadas en la configuración
563
-
564
- Truthmark conserva el contenido manual fuera de los bloques de instrucciones administrados.
565
-
566
- Las interfaces de flujo de trabajo generadas son administradas por Truthmark y pueden refrescarse volviendo a ejecutar:
567
-
568
- ```bash
569
- truthmark init
570
- ```
571
-
572
- ## Subagentes y checks acotados de evidencia
573
-
574
- Donde el host lo admite, Truthmark puede instalar agentes verificadores con alcance de proyecto y un `truth-doc-writer` con lease.
575
-
576
- Ayudan a mantener acotadas las tareas grandes de verdad:
577
-
578
- - route auditors inspeccionan la propiedad de rutas
579
- - claim verifiers revisan si las afirmaciones de docs están respaldadas por evidencia
580
- - doc reviewers inspeccionan la calidad de los documentos de verdad
581
- - leased doc writers manejan fragmentos acotados de escritura de documentos de verdad
582
-
583
- El flujo padre sigue siendo dueño de la interpretación final, los límites de escritura, la validación del diff y la aceptación.
584
-
585
- Esto es importante: los subagentes ayudan con trabajo acotado de evidencia. No reemplazan el contrato principal del flujo.
586
-
587
- ## Bucle de revisión
588
-
589
- Truthmark está diseñado para revisión normal en Git.
590
-
591
- Una buena entrega asistida por IA debería mostrar:
592
-
593
- ```text
594
- diff de código
595
- evidencia de pruebas
596
- diff de documentos de verdad, si hace falta
597
- cambios de rutas, si hacen falta
598
- informe del agente
599
- ```
600
-
601
- Quien revisa debería poder responder:
602
-
603
- - ¿Qué código cambió?
604
- - ¿Qué documentos de verdad poseen ese código?
605
- - ¿Esos documentos necesitaron actualizaciones?
606
- - Si no, ¿por qué no?
607
- - ¿El agente permaneció dentro del límite de escritura del flujo?
608
- - ¿Se incluye evidencia de pruebas o verificación?
609
-
610
- ## Ejemplos
611
-
612
- ### Inicializar un repositorio
613
-
614
- ```bash
615
- npm install -g truthmark
616
- truthmark config
617
- truthmark init
618
- truthmark check
619
- ```
620
-
621
- ### Quitar plataformas de agentes no usadas
622
-
623
- Edita:
624
-
625
- ```text
626
- .truthmark/config.yml
627
- ```
628
-
629
- Luego vuelve a ejecutar:
630
-
631
- ```bash
632
- truthmark init
633
- truthmark check
634
- ```
635
-
636
- ### Dividir una ruta amplia
637
-
638
- ```text
639
- /truthmark-structure divide el área amplia repository en auth, billing, notifications y deployment
640
- ```
641
-
642
- ### Documentar comportamiento implementado
643
-
644
- ```text
645
- /truthmark-document documenta el flujo implementado de restablecimiento de contraseña bajo docs/truthmark/engineering/behaviors/authentication
646
- ```
647
-
648
- ### Sincronizar después de cambios de código
649
-
650
- ```text
651
- /truthmark-sync sincroniza ahora la verdad del repositorio antes de la entrega
652
- ```
653
-
654
- ### Realizar una decisión doc-first
655
-
656
- ```text
657
- /truthmark-realize realiza docs/truthmark/product/capabilities/invoice-retry-policy.md como código
658
- ```
659
-
660
- ### Auditar la salud de verdad desde la terminal
661
-
662
- ```bash
663
- truthmark check
664
- ```
665
-
666
- ### Generar resumen de impacto de rama
667
-
668
- ```bash
669
- truthmark impact --base main
670
- ```
671
-
672
- ### Inspeccionar el estado del workflow
673
-
674
- ```bash
675
- truthmark workflow status --workflow truthmark-sync --base main --json
676
- ```
677
-
678
- ### Habilitar el flujo Portal opcional
679
-
680
- ```yaml
681
- truthmark:
682
- generated:
683
- portal:
684
- enabled: true
685
- ```
686
-
687
- ```bash
688
- truthmark init
689
- ```
690
-
691
- Luego pide explícitamente al host de agente que ejecute el flujo Portal instalado cuando quieras generar o refrescar el sitio estático de presentación.
692
-
693
- ## Estado del proyecto
694
-
695
- Truthmark V1 actualmente proporciona:
696
-
697
- - `truthmark config`
698
- - `truthmark init`
699
- - `truthmark check`
700
- - `truthmark index`
701
- - `truthmark impact`
702
- - `truthmark workflow status`
703
- - metadatos de alcance de rama
704
- - bloques de instrucciones administrados
705
- - interfaces generadas de flujo Truth Structure
706
- - interfaces generadas de flujo Truth Document
707
- - interfaces generadas de flujo Truth Sync
708
- - interfaces generadas de flujo Truth Preview
709
- - interfaces generadas de flujo Truth Realize
710
- - interfaces generadas de flujo Truth Check
711
- - interfaces generadas opcionales de flujo Truthmark Portal
712
- - diagnósticos de rutas, autoridad, estructura de decisiones, frontmatter, enlaces, vigencia, interfaces generadas y cobertura
713
- - artefactos derivados RepoIndex, RouteMap, ImpactSet y WorkflowState
714
- - interfaces específicas de host para Codex, Claude Code, GitHub Copilot, OpenCode y Gemini CLI
715
-
716
- ## Desarrollo
717
-
718
- Instalar dependencias:
719
-
720
- ```bash
721
- npm install
722
- ```
723
-
724
- Ejecutar la CLI local de desarrollo:
725
-
726
- ```bash
727
- npm run dev -- init
728
- npm run dev -- check
729
- ```
730
-
731
- Ejecutar el check completo del proyecto:
732
-
733
- ```bash
734
- npm run check
735
- ```
736
-
737
- Scripts útiles:
738
-
739
- | Script | Propósito |
740
- | --- | --- |
741
- | `npm run dev` | Ejecuta el punto de entrada CLI en TypeScript con `tsx`. |
742
- | `npm run build` | Construye el paquete. |
743
- | `npm run lint` | Ejecuta ESLint. |
744
- | `npm run typecheck` | Ejecuta checks de TypeScript. |
745
- | `npm run test` | Ejecuta las pruebas. |
746
- | `npm run check` | Ejecuta lint, typecheck, pruebas y build. |
747
- | `npm run release:check` | Ejecuta validación orientada a release. |
748
-
749
- Cuando cambies Truthmark en sí, consulta [CONTRIBUTING.md](CONTRIBUTING.md).
750
-
751
- ## Documentación
752
-
753
- El README es el camino rápido para evaluación y configuración.
754
-
755
- El comportamiento actual detallado vive bajo `docs/`:
756
-
757
- - [Índice de documentación](docs/README.md)
758
- - [Resumen de arquitectura](docs/truthmark/engineering/architecture/overview.md)
759
- - [Contratos de API y CLI](docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
760
- - [Comportamiento de init y scaffold](docs/truthmark/engineering/behaviors/init-and-scaffold.md)
761
- - [Diagnósticos de check](docs/truthmark/engineering/behaviors/check-diagnostics.md)
762
- - [Flujos instalados](docs/truthmark/engineering/workflows/installed-workflow-runtime.md)
763
- - [Guía para mantener la verdad del repositorio](docs/standards/maintaining-repository-truth.md)
764
-
765
- ## Límites de diseño
766
-
767
- Truthmark es intencionalmente pequeño.
768
-
769
- No es:
770
-
771
- - un servicio alojado
772
- - un servidor MCP
773
- - una base de datos vectorial
774
- - un generador canónico de sitios de documentación o plataforma de docs alojada
775
- - un producto de enforcement para CI o PR
776
- - un reemplazo de pruebas, revisión de código o liderazgo técnico
777
- - un motor autónomo de reescritura de código
778
- - un framework de entrenamiento o fine-tuning de modelos
779
- - una capa oculta de memoria
780
-
781
- Esos límites son parte del producto.
782
-
783
- Truthmark mantiene el flujo local, versionado, acotado a la rama y revisable.
784
-
785
- ## Seguridad y disciplina de revisión
786
-
787
- Truthmark ayuda a que el repositorio se mantenga honesto. No prueba que el código sea correcto.
788
-
789
- Los equipos deberían seguir:
790
-
791
- - ejecutando pruebas relevantes
792
- - revisando cambios de código funcional
793
- - revisando cambios de documentos de verdad
794
- - manteniendo secretos fuera de la documentación
795
- - manteniendo instrucciones específicas del repositorio fuera de bloques administrados
796
- - revisando diffs de interfaces de flujo de trabajo generadas después de las actualizaciones
797
- - conservando propiedad humana sobre decisiones de producto y arquitectura
798
-
799
- Truthmark hace visible la verdad del repositorio orientada al agente. No reemplaza el juicio humano.
800
-
801
- ## Dirección de la hoja de ruta
802
-
803
- La dirección futura actual enfatiza:
804
-
805
- - reportes de evidencia más fuertes en `truthmark check`
806
- - ejemplos de adopción más claros
807
- - repositorios de ejemplo que muestren ciclos reales de Truth Sync
808
- - guías de migración para equipos que ya usan archivos de instrucciones para agentes
809
- - pruebas de conformidad para interfaces generadas de host
810
- - avisos de verdad obsoleta basados en rutas
811
- - listas de verificación acotadas de implementación para trabajo doc-first
812
-
813
- El centro de gravedad se mantiene igual:
814
-
815
- ```text
816
- verdad del repositorio
817
- flujos nativos para agentes
818
- revisión en Git
819
- documentación acotada a la rama
820
- ```
821
-
822
- ## Licencia
823
-
824
- MIT. Consulta [LICENSE](LICENSE).