truthmark 1.6.1 → 2.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/README.de.md +116 -107
- package/README.es.md +133 -124
- package/README.md +55 -46
- package/README.ru.md +105 -96
- package/README.zh.md +104 -97
- package/dist/main.js +2092 -1047
- package/dist/main.js.map +1 -1
- package/package.json +4 -1
package/README.es.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Tus agentes escriben código. Truthmark
|
|
3
|
+
**Tus agentes escriben código. Truthmark mantiene documentación para personas, versionada y revisable en Git.**
|
|
4
4
|
|
|
5
5
|
[English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | Español | [Русский](README.ru.md)
|
|
6
6
|
|
|
7
7
|

|
|
8
8
|
|
|
9
|
-
Los agentes de
|
|
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
10
|
|
|
11
|
-
Truthmark
|
|
11
|
+
Truthmark corrige la parte que normalmente se rompe después de escribir el código: la verdad del repositorio.
|
|
12
12
|
|
|
13
|
-
Instala una capa de flujo de trabajo nativa de Git y acotada a la rama que ayuda a los agentes de
|
|
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
14
|
|
|
15
15
|
Sin servicio alojado.
|
|
16
16
|
|
|
@@ -24,18 +24,18 @@ Solo verdad del repositorio que se mueve con la rama.
|
|
|
24
24
|
|
|
25
25
|
## El problema
|
|
26
26
|
|
|
27
|
-
Los agentes de
|
|
27
|
+
Los agentes de desarrollo con IA son buenos produciendo código. Eso crea un nuevo modo de fallo.
|
|
28
28
|
|
|
29
29
|
La implementación cambia, pero la historia del repositorio se desvía:
|
|
30
30
|
|
|
31
31
|
- el comportamiento vive en el historial de chat
|
|
32
32
|
- los documentos de arquitectura quedan atrás
|
|
33
|
-
- las decisiones de producto desaparecen después
|
|
33
|
+
- las decisiones de producto desaparecen después de la entrega
|
|
34
34
|
- quienes revisan ven diffs de código sin los diffs de verdad relacionados
|
|
35
35
|
- las ramas desarrollan silenciosamente distintas versiones de “lo que es verdad”
|
|
36
|
-
- cada sesión de agente tiene que redescubrir
|
|
36
|
+
- cada sesión de agente tiene que redescubrir la verdad del repositorio desde cero
|
|
37
37
|
|
|
38
|
-
Truthmark convierte
|
|
38
|
+
Truthmark convierte esa verdad frágil del repositorio en infraestructura versionada en Git.
|
|
39
39
|
|
|
40
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
41
|
|
|
@@ -51,22 +51,22 @@ se ejecutan pruebas relevantes
|
|
|
51
51
|
Truth Sync revisa los documentos de verdad asignados
|
|
52
52
|
los documentos de verdad se actualizan cuando hace falta
|
|
53
53
|
una persona revisa el diff de código + el diff de verdad
|
|
54
|
-
confirmar o
|
|
54
|
+
confirmar o entregar
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
Ese es el valor central: **el trabajo con IA es más fácil de confiar porque el repositorio sigue siendo legible.**
|
|
58
58
|
|
|
59
|
-
## Dos
|
|
59
|
+
## Dos interfaces, un sistema de verdad
|
|
60
60
|
|
|
61
61
|
Truthmark no es solo una CLI.
|
|
62
62
|
|
|
63
|
-
Tiene dos
|
|
63
|
+
Tiene dos interfaces distintas, y la distinción importa.
|
|
64
64
|
|
|
65
|
-
### 1. CLI
|
|
65
|
+
### 1. CLI para personas
|
|
66
66
|
|
|
67
67
|
La CLI es para mantenedores, revisores y automatización.
|
|
68
68
|
|
|
69
|
-
Úsala para configurar un repositorio, instalar o refrescar archivos de flujo de trabajo, validar artefactos de verdad y generar
|
|
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
70
|
|
|
71
71
|
```bash
|
|
72
72
|
truthmark config
|
|
@@ -76,13 +76,13 @@ truthmark check
|
|
|
76
76
|
|
|
77
77
|
La CLI prepara y valida el entorno del repositorio.
|
|
78
78
|
|
|
79
|
-
No es el
|
|
79
|
+
No es el entorno de ejecución del flujo de trabajo con IA.
|
|
80
80
|
|
|
81
|
-
### 2.
|
|
81
|
+
### 2. Interfaces de flujo de trabajo para IA
|
|
82
82
|
|
|
83
|
-
Las
|
|
83
|
+
Las interfaces para IA son para agentes de desarrollo.
|
|
84
84
|
|
|
85
|
-
Truthmark instala skills, prompts, comandos, bloques de instrucciones administrados
|
|
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
86
|
|
|
87
87
|
Ejemplos:
|
|
88
88
|
|
|
@@ -105,7 +105,7 @@ La división es el producto:
|
|
|
105
105
|
|
|
106
106
|
```text
|
|
107
107
|
las personas poseen el contrato del repositorio
|
|
108
|
-
Truthmark instala el contrato en el
|
|
108
|
+
Truthmark instala el contrato en el repositorio
|
|
109
109
|
los agentes operan dentro de ese contrato
|
|
110
110
|
las actualizaciones de verdad aparecen como diffs de Git
|
|
111
111
|
las personas revisan el resultado
|
|
@@ -142,7 +142,7 @@ Esto crea:
|
|
|
142
142
|
|
|
143
143
|
Revisa este archivo antes de continuar. Define el contrato de jerarquía confirmado en el repositorio.
|
|
144
144
|
|
|
145
|
-
### Instalar las
|
|
145
|
+
### Instalar las interfaces de flujo de trabajo
|
|
146
146
|
|
|
147
147
|
```bash
|
|
148
148
|
truthmark init
|
|
@@ -153,7 +153,7 @@ Esto instala o refresca:
|
|
|
153
153
|
- archivos de rutas
|
|
154
154
|
- scaffolding de documentos de verdad
|
|
155
155
|
- bloques de instrucciones administrados
|
|
156
|
-
-
|
|
156
|
+
- interfaces de flujo de trabajo para IA en las plataformas configuradas
|
|
157
157
|
|
|
158
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
159
|
|
|
@@ -165,7 +165,7 @@ truthmark check
|
|
|
165
165
|
|
|
166
166
|
Después revisa los archivos generados antes de confirmar.
|
|
167
167
|
|
|
168
|
-
Los archivos exactos dependen de `.truthmark/config.yml`, pero la instalación siempre tiene la misma forma:
|
|
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
169
|
|
|
170
170
|
## Primer uso real
|
|
171
171
|
|
|
@@ -179,30 +179,38 @@ Pide a tu agente que divida la ruta amplia en áreas reales de producto, servici
|
|
|
179
179
|
/truthmark-structure divide el área amplia repository en auth, billing y notifications
|
|
180
180
|
```
|
|
181
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
|
+
|
|
182
190
|
Después usa tu agente de programación con IA normalmente.
|
|
183
191
|
|
|
184
|
-
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
|
|
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.
|
|
185
193
|
|
|
186
194
|
## Qué obtienes
|
|
187
195
|
|
|
188
196
|
| Capacidad | Qué hace |
|
|
189
197
|
| --- | --- |
|
|
190
|
-
| Verdad nativa de Git | Mantiene la verdad del repositorio en Markdown y config
|
|
191
|
-
|
|
|
192
|
-
| CLI
|
|
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. |
|
|
193
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. |
|
|
194
202
|
| Rutas explícitas | Mapea áreas de código a documentos de verdad canónicos. |
|
|
195
|
-
|
|
|
203
|
+
| Entregas revisables | Produce diffs normales de Git para código y documentos de verdad. |
|
|
196
204
|
| Operación local-first | No requiere servicio alojado, demonio, base de datos ni servidor MCP. |
|
|
197
205
|
| Límites de escritura más seguros | Separa flujos code-first, doc-first, read-only y doc-only. |
|
|
198
|
-
| Validación | Reporta problemas de rutas, autoridad, frontmatter, enlaces,
|
|
199
|
-
| Portal opcional | Genera un sitio HTML estático
|
|
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. |
|
|
200
208
|
|
|
201
209
|
## Resumen visual
|
|
202
210
|
|
|
203
211
|

|
|
204
212
|
|
|
205
|
-
**Características:** qué instala Truthmark y cómo se divide la
|
|
213
|
+
**Características:** qué instala Truthmark y cómo se divide la interfaz de flujo de trabajo.
|
|
206
214
|
|
|
207
215
|

|
|
208
216
|
|
|
@@ -210,7 +218,7 @@ Cuando el agente cambia código funcional, Truth Sync actúa como guarda de cier
|
|
|
210
218
|
|
|
211
219
|

|
|
212
220
|
|
|
213
|
-
**Flujo de sync:** cómo Truth Sync cierra cambios normales de código antes
|
|
221
|
+
**Flujo de sync:** cómo Truth Sync cierra cambios normales de código antes de la entrega.
|
|
214
222
|
|
|
215
223
|
## Por qué los equipos lo adoptan
|
|
216
224
|
|
|
@@ -222,18 +230,18 @@ No gobernanza como ceremonia. Gobernanza como una pregunta simple:
|
|
|
222
230
|
|
|
223
231
|
> Después de este cambio asistido por IA, ¿el repositorio todavía dice la verdad?
|
|
224
232
|
|
|
225
|
-
Truthmark ayuda a los equipos a responder con archivos
|
|
233
|
+
Truthmark ayuda a los equipos a responder con archivos versionados, rutas explícitas y diffs revisables.
|
|
226
234
|
|
|
227
235
|
Es útil cuando necesitas:
|
|
228
236
|
|
|
229
237
|
- menos deriva de documentación
|
|
230
|
-
- mejores
|
|
238
|
+
- mejores entregas
|
|
231
239
|
- verdad de producto específica de cada rama
|
|
232
|
-
-
|
|
240
|
+
- documentación duradera de arquitectura y API
|
|
233
241
|
- propiedad explícita entre documentos y código
|
|
234
242
|
- límites de escritura más seguros para agentes
|
|
235
|
-
-
|
|
236
|
-
- flujos de IA que sigan funcionando desde archivos
|
|
243
|
+
- documentación revisable en lugar de memoria oculta
|
|
244
|
+
- flujos de IA que sigan funcionando desde archivos versionados del repositorio
|
|
237
245
|
|
|
238
246
|
## Dónde encaja Truthmark
|
|
239
247
|
|
|
@@ -248,7 +256,7 @@ Les da a esos flujos un lugar duradero donde aterrizar en Git.
|
|
|
248
256
|
| Trabajo de funciones plan-first | Flujo de especificación |
|
|
249
257
|
| Verdad acotada a la rama que viaja con el código | Truthmark |
|
|
250
258
|
| Validar la corrección del comportamiento | Pruebas y revisión |
|
|
251
|
-
| Revisar cambios de
|
|
259
|
+
| Revisar cambios de documentación asistidos por IA | Truthmark más revisión Git |
|
|
252
260
|
|
|
253
261
|
El carril de Truthmark es estrecho por diseño:
|
|
254
262
|
|
|
@@ -263,29 +271,29 @@ mantener el resultado revisable en Git
|
|
|
263
271
|
|
|
264
272
|
Truthmark se ejecuta localmente contra el worktree Git activo.
|
|
265
273
|
|
|
266
|
-
La CLI
|
|
274
|
+
La CLI para personas lee y escribe archivos del repositorio, y luego termina.
|
|
267
275
|
|
|
268
|
-
Las
|
|
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.
|
|
269
277
|
|
|
270
278
|
Las capas encajan así:
|
|
271
279
|
|
|
272
280
|
```mermaid
|
|
273
281
|
flowchart LR
|
|
274
282
|
Human["Human / CI"] --> CLI["Truthmark CLI"]
|
|
275
|
-
CLI --> Config["Config y
|
|
283
|
+
CLI --> Config["Config y rutas"]
|
|
276
284
|
CLI --> Truth["Documentos truth canónicos"]
|
|
277
|
-
CLI --> Surfaces["Workflows host
|
|
285
|
+
CLI --> Surfaces["Workflows nativos del host generados"]
|
|
278
286
|
Surfaces --> Hosts["Codex / Claude Code / Copilot / OpenCode / Gemini"]
|
|
279
287
|
Hosts --> Worktree["Git worktree activo"]
|
|
280
288
|
Hosts -->|"helper checks / validate / index"| CLI
|
|
281
289
|
Worktree --> Truth
|
|
282
290
|
```
|
|
283
291
|
|
|
284
|
-
Los agentes no hablan con un daemon de Truthmark, pero pueden ejecutar la CLI instalada de Truthmark cuando un workflow pide validación,
|
|
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.
|
|
285
293
|
|
|
286
|
-
Truthmark es dueño de las
|
|
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.
|
|
287
295
|
|
|
288
|
-
Las
|
|
296
|
+
Las interfaces de flujo de trabajo generadas incluyen marcadores de versión de Truthmark. Después de actualizar Truthmark, vuelve a ejecutar:
|
|
289
297
|
|
|
290
298
|
```bash
|
|
291
299
|
truthmark init
|
|
@@ -303,9 +311,9 @@ Elimina de `.truthmark/config.yml` las plataformas que no uses, y luego vuelve a
|
|
|
303
311
|
truthmark init
|
|
304
312
|
```
|
|
305
313
|
|
|
306
|
-
| Nombre de plataforma en config |
|
|
314
|
+
| Nombre de plataforma en config | Interfaz generada | Forma de invocación |
|
|
307
315
|
| --- | --- | --- |
|
|
308
|
-
| `codex` | `.
|
|
316
|
+
| `codex` | `.agents/skills/truthmark-*/`, `.codex/agents/` | `/truthmark-*` o `$truthmark-*` |
|
|
309
317
|
| `claude-code` | `.claude/skills/truthmark-*/`, `.claude/agents/`, `CLAUDE.md` | `/truthmark-*` |
|
|
310
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 |
|
|
311
319
|
| `opencode` | `.opencode/skills/truthmark-*/`, `.opencode/agents/` | `/skill truthmark-*` |
|
|
@@ -325,7 +333,7 @@ Los usan agentes o hosts de agentes durante el trabajo en el repositorio. No son
|
|
|
325
333
|
| --- | --- | --- | --- |
|
|
326
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. |
|
|
327
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. |
|
|
328
|
-
| Truth Sync | code-first | Cambió código funcional y puede que los documentos de verdad asignados deban actualizarse antes
|
|
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. |
|
|
329
337
|
| Truth Preview | read-only | El agente necesita previsualizar rutas probables antes de editar. | Solo lee. No autoriza escrituras. |
|
|
330
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. |
|
|
331
339
|
| Truth Check | audit-first | Un revisor o agente necesita auditar la salud de la verdad del repositorio. | Audita e informa. |
|
|
@@ -333,14 +341,14 @@ Los usan agentes o hosts de agentes durante el trabajo en el repositorio. No son
|
|
|
333
341
|
|
|
334
342
|
### Distinción importante
|
|
335
343
|
|
|
336
|
-
No confundas estas dos
|
|
344
|
+
No confundas estas dos interfaces:
|
|
337
345
|
|
|
338
|
-
|
|
|
346
|
+
| Interfaz | Usada por | Ejemplo | Significado |
|
|
339
347
|
| --- | --- | --- | --- |
|
|
340
|
-
| CLI
|
|
341
|
-
| Flujo orientado a IA | agentes de
|
|
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. |
|
|
342
350
|
|
|
343
|
-
Los nombres están relacionados a propósito, pero las
|
|
351
|
+
Los nombres están relacionados a propósito, pero las interfaces son distintas.
|
|
344
352
|
|
|
345
353
|
## Cambio normal de código asistido por IA
|
|
346
354
|
|
|
@@ -357,20 +365,24 @@ el agente actualiza documentos de verdad si hace falta
|
|
|
357
365
|
una persona revisa el diff de código + el diff de verdad
|
|
358
366
|
```
|
|
359
367
|
|
|
360
|
-
La invocación directa sigue siendo útil para depurar, forzar una sincronización temprana o hacer
|
|
368
|
+
La invocación directa sigue siendo útil para depurar, forzar una sincronización temprana o hacer explícita la entrega:
|
|
361
369
|
|
|
362
370
|
```text
|
|
363
|
-
/truthmark-sync sincroniza ahora la verdad del repositorio antes
|
|
371
|
+
/truthmark-sync sincroniza ahora la verdad del repositorio antes de la entrega
|
|
364
372
|
```
|
|
365
373
|
|
|
366
374
|
## Comportamiento existente sin docs
|
|
367
375
|
|
|
368
|
-
Usa Truth Document cuando la implementación ya existe pero la verdad del repositorio está incompleta.
|
|
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.
|
|
369
377
|
|
|
370
378
|
```text
|
|
371
|
-
/truthmark-document documenta el comportamiento implementado de timeout de sesión
|
|
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
|
|
372
380
|
```
|
|
373
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
|
+
|
|
374
386
|
Truth Document inspecciona implementación, pruebas, archivos de rutas y documentación existente como evidencia.
|
|
375
387
|
|
|
376
388
|
Escribe solo documentos de verdad y rutas.
|
|
@@ -382,7 +394,7 @@ No debe cambiar código funcional.
|
|
|
382
394
|
Usa Truth Realize cuando una decisión de producto o arquitectura empieza en documentos y el código debe actualizarse para coincidir.
|
|
383
395
|
|
|
384
396
|
```text
|
|
385
|
-
/truthmark-realize realiza docs/truth/authentication/session-timeout.md como código
|
|
397
|
+
/truthmark-realize realiza docs/truthmark/truth/authentication/session-timeout.md como código
|
|
386
398
|
```
|
|
387
399
|
|
|
388
400
|
Truth Realize es doc-first.
|
|
@@ -411,25 +423,25 @@ Usa Truth Check cuando quieres un flujo de auditoría orientado a agentes.
|
|
|
411
423
|
/truthmark-check audita rutas y cobertura de verdad antes de la revisión
|
|
412
424
|
```
|
|
413
425
|
|
|
414
|
-
Usa la CLI
|
|
426
|
+
Usa la CLI para personas cuando quieres validación en terminal:
|
|
415
427
|
|
|
416
428
|
```bash
|
|
417
429
|
truthmark check
|
|
418
430
|
```
|
|
419
431
|
|
|
420
|
-
Ambas son útiles. No son la misma
|
|
432
|
+
Ambas son útiles. No son la misma interfaz.
|
|
421
433
|
|
|
422
|
-
## Comandos CLI
|
|
434
|
+
## Comandos CLI para personas
|
|
423
435
|
|
|
424
436
|
La mayoría de los mantenedores empieza con tres comandos.
|
|
425
437
|
|
|
426
438
|
| Comando | Propósito |
|
|
427
439
|
| --- | --- |
|
|
428
440
|
| `truthmark config` | Crea `.truthmark/config.yml`. Solo escribe ese archivo, salvo que se use `--stdout`. |
|
|
429
|
-
| `truthmark init` | Instala o refresca
|
|
430
|
-
| `truthmark check` | Valida configuración, autoridad, rutas, documentos con decisiones, frontmatter, enlaces internos, alcance de rama,
|
|
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. |
|
|
431
443
|
|
|
432
|
-
Los ayudantes opcionales de inteligencia del repositorio generan
|
|
444
|
+
Los ayudantes opcionales de inteligencia del repositorio generan material derivado para revisión sobre el checkout activo, como artefactos RepoIndex, RouteMap, ImpactSet y ContextPack acotados. 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.
|
|
433
445
|
|
|
434
446
|
No son fuentes de verdad.
|
|
435
447
|
|
|
@@ -437,13 +449,13 @@ No son fuentes de verdad.
|
|
|
437
449
|
| --- | --- |
|
|
438
450
|
| `truthmark index` | Construye JSON de RepoIndex y RouteMap para el checkout activo. |
|
|
439
451
|
| `truthmark impact --base <ref>` | Mapea archivos cambiados a documentos de verdad enrutados, rutas propietarias, pruebas cercanas y símbolos públicos. |
|
|
440
|
-
| `truthmark
|
|
452
|
+
| `truthmark ctx --workflow <workflow> [--base <ref>]` | Genera un ContextPack acotado para Truth Sync, Truth Document o Truth Realize. Usa `--format markdown` para una versión legible por personas. |
|
|
441
453
|
|
|
442
454
|
La salida estructurada está disponible con `--json` donde se admite.
|
|
443
455
|
|
|
444
456
|
## Truthmark Portal
|
|
445
457
|
|
|
446
|
-
Truthmark Portal es un flujo opcional de presentación para equipos que quieren un sitio legible por personas sobre sus documentos de verdad
|
|
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.
|
|
447
459
|
|
|
448
460
|
Está separado deliberadamente del flujo central de verdad:
|
|
449
461
|
|
|
@@ -456,10 +468,10 @@ Está separado deliberadamente del flujo central de verdad:
|
|
|
456
468
|
Habilítalo con el bloque de configuración con espacio de nombres:
|
|
457
469
|
|
|
458
470
|
```yaml
|
|
459
|
-
truthmark
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
471
|
+
truthmark:
|
|
472
|
+
generated:
|
|
473
|
+
portal:
|
|
474
|
+
enabled: true
|
|
463
475
|
```
|
|
464
476
|
|
|
465
477
|
Luego vuelve a ejecutar:
|
|
@@ -468,7 +480,7 @@ Luego vuelve a ejecutar:
|
|
|
468
480
|
truthmark init
|
|
469
481
|
```
|
|
470
482
|
|
|
471
|
-
Cuando está habilitado, Truthmark instala
|
|
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.
|
|
472
484
|
|
|
473
485
|
## Configuración
|
|
474
486
|
|
|
@@ -497,15 +509,12 @@ Las áreas importantes de configuración incluyen:
|
|
|
497
509
|
| Área de config | Propósito |
|
|
498
510
|
| --- | --- |
|
|
499
511
|
| `version` | Versión del contrato de configuración. |
|
|
500
|
-
| `platforms` | Hosts de agentes que deben recibir
|
|
501
|
-
| `
|
|
502
|
-
| `
|
|
503
|
-
|
|
|
504
|
-
|
|
|
505
|
-
| `
|
|
506
|
-
| `docs.routing.max_delegation_depth` | Profundidad máxima actual de delegación de rutas. |
|
|
507
|
-
| `truthmark-portal` | Ajustes opcionales del flujo manual de presentación: `enabled`, `output` y `template`. |
|
|
508
|
-
| `authority` | Documentos canónicos y globs ordenados usados como autoridad de verdad del repositorio. |
|
|
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`. |
|
|
509
518
|
| `instruction_targets` | Archivos que reciben bloques de instrucciones administrados compartidos, como `AGENTS.md`. |
|
|
510
519
|
| `frontmatter.required` | Campos de metadatos que producen diagnósticos de error cuando faltan. |
|
|
511
520
|
| `frontmatter.recommended` | Campos de metadatos que producen diagnósticos de revisión cuando faltan. |
|
|
@@ -513,18 +522,18 @@ Las áreas importantes de configuración incluyen:
|
|
|
513
522
|
|
|
514
523
|
## Rutas de verdad del repositorio
|
|
515
524
|
|
|
516
|
-
Truthmark mapea
|
|
525
|
+
Truthmark mapea áreas de código a documentos de verdad.
|
|
517
526
|
|
|
518
527
|
Los archivos principales de rutas son:
|
|
519
528
|
|
|
520
529
|
```text
|
|
521
|
-
docs/truthmark/areas.md
|
|
522
|
-
docs/truthmark/areas/**/*.md
|
|
530
|
+
docs/truthmark/routes/areas.md
|
|
531
|
+
docs/truthmark/routes/areas/**/*.md
|
|
523
532
|
```
|
|
524
533
|
|
|
525
534
|
Una ruta le dice al agente:
|
|
526
535
|
|
|
527
|
-
- qué
|
|
536
|
+
- qué parte del código pertenece a un área
|
|
528
537
|
- qué documentos de verdad poseen esa área
|
|
529
538
|
- cuándo debe actualizarse la verdad
|
|
530
539
|
- qué tipo de documento de verdad participa
|
|
@@ -537,9 +546,9 @@ Ejemplo:
|
|
|
537
546
|
/truthmark-structure divide el área amplia repository en frontend, backend, billing y deployment
|
|
538
547
|
```
|
|
539
548
|
|
|
540
|
-
Un buen
|
|
549
|
+
Un buen enrutamiento da a Truth Sync destinos precisos.
|
|
541
550
|
|
|
542
|
-
Un mal
|
|
551
|
+
Un mal enrutamiento hace que los agentes adivinen.
|
|
543
552
|
|
|
544
553
|
## Qué instala Truthmark
|
|
545
554
|
|
|
@@ -547,14 +556,14 @@ Truthmark instala una capa compacta de verdad nativa del repositorio.
|
|
|
547
556
|
|
|
548
557
|
Lo instala en cuatro capas:
|
|
549
558
|
|
|
550
|
-
-
|
|
551
|
-
- documentos
|
|
552
|
-
- bloques de instrucciones administrados y compactos para
|
|
553
|
-
- paquetes de
|
|
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
|
|
554
563
|
|
|
555
564
|
Truthmark conserva el contenido manual fuera de los bloques de instrucciones administrados.
|
|
556
565
|
|
|
557
|
-
Las
|
|
566
|
+
Las interfaces de flujo de trabajo generadas son administradas por Truthmark y pueden refrescarse volviendo a ejecutar:
|
|
558
567
|
|
|
559
568
|
```bash
|
|
560
569
|
truthmark init
|
|
@@ -569,7 +578,7 @@ Ayudan a mantener acotadas las tareas grandes de verdad:
|
|
|
569
578
|
- route auditors inspeccionan la propiedad de rutas
|
|
570
579
|
- claim verifiers revisan si las afirmaciones de docs están respaldadas por evidencia
|
|
571
580
|
- doc reviewers inspeccionan la calidad de los documentos de verdad
|
|
572
|
-
- leased doc writers manejan
|
|
581
|
+
- leased doc writers manejan fragmentos acotados de escritura de documentos de verdad
|
|
573
582
|
|
|
574
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.
|
|
575
584
|
|
|
@@ -579,7 +588,7 @@ Esto es importante: los subagentes ayudan con trabajo acotado de evidencia. No r
|
|
|
579
588
|
|
|
580
589
|
Truthmark está diseñado para revisión normal en Git.
|
|
581
590
|
|
|
582
|
-
|
|
591
|
+
Una buena entrega asistida por IA debería mostrar:
|
|
583
592
|
|
|
584
593
|
```text
|
|
585
594
|
diff de código
|
|
@@ -633,19 +642,19 @@ truthmark check
|
|
|
633
642
|
### Documentar comportamiento implementado
|
|
634
643
|
|
|
635
644
|
```text
|
|
636
|
-
/truthmark-document documenta el flujo implementado de restablecimiento de contraseña bajo docs/truth/authentication
|
|
645
|
+
/truthmark-document documenta el flujo implementado de restablecimiento de contraseña bajo docs/truthmark/truth/authentication
|
|
637
646
|
```
|
|
638
647
|
|
|
639
648
|
### Sincronizar después de cambios de código
|
|
640
649
|
|
|
641
650
|
```text
|
|
642
|
-
/truthmark-sync sincroniza ahora la verdad del repositorio antes
|
|
651
|
+
/truthmark-sync sincroniza ahora la verdad del repositorio antes de la entrega
|
|
643
652
|
```
|
|
644
653
|
|
|
645
654
|
### Realizar una decisión doc-first
|
|
646
655
|
|
|
647
656
|
```text
|
|
648
|
-
/truthmark-realize realiza docs/truth/billing/invoice-retry-policy.md como código
|
|
657
|
+
/truthmark-realize realiza docs/truthmark/truth/billing/invoice-retry-policy.md como código
|
|
649
658
|
```
|
|
650
659
|
|
|
651
660
|
### Auditar la salud de verdad desde la terminal
|
|
@@ -654,25 +663,25 @@ truthmark check
|
|
|
654
663
|
truthmark check
|
|
655
664
|
```
|
|
656
665
|
|
|
657
|
-
### Generar
|
|
666
|
+
### Generar resumen de impacto de rama
|
|
658
667
|
|
|
659
668
|
```bash
|
|
660
669
|
truthmark impact --base main
|
|
661
670
|
```
|
|
662
671
|
|
|
663
|
-
### Generar
|
|
672
|
+
### Generar un ContextPack de workflow
|
|
664
673
|
|
|
665
674
|
```bash
|
|
666
|
-
truthmark
|
|
675
|
+
truthmark ctx --workflow truth-sync --base main --format markdown
|
|
667
676
|
```
|
|
668
677
|
|
|
669
678
|
### Habilitar el flujo Portal opcional
|
|
670
679
|
|
|
671
680
|
```yaml
|
|
672
|
-
truthmark
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
681
|
+
truthmark:
|
|
682
|
+
generated:
|
|
683
|
+
portal:
|
|
684
|
+
enabled: true
|
|
676
685
|
```
|
|
677
686
|
|
|
678
687
|
```bash
|
|
@@ -690,19 +699,19 @@ Truthmark V1 actualmente proporciona:
|
|
|
690
699
|
- `truthmark check`
|
|
691
700
|
- `truthmark index`
|
|
692
701
|
- `truthmark impact`
|
|
693
|
-
- `truthmark
|
|
702
|
+
- `truthmark ctx`
|
|
694
703
|
- metadatos de alcance de rama
|
|
695
704
|
- bloques de instrucciones administrados
|
|
696
|
-
-
|
|
697
|
-
-
|
|
698
|
-
-
|
|
699
|
-
-
|
|
700
|
-
-
|
|
701
|
-
-
|
|
702
|
-
-
|
|
703
|
-
- diagnósticos de rutas, autoridad, estructura de decisiones, frontmatter, enlaces,
|
|
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
|
|
704
713
|
- artefactos derivados RepoIndex, RouteMap, ImpactSet y ContextPack
|
|
705
|
-
-
|
|
714
|
+
- interfaces específicas de host para Codex, Claude Code, GitHub Copilot, OpenCode y Gemini CLI
|
|
706
715
|
|
|
707
716
|
## Desarrollo
|
|
708
717
|
|
|
@@ -737,7 +746,7 @@ Scripts útiles:
|
|
|
737
746
|
| `npm run check` | Ejecuta lint, typecheck, pruebas y build. |
|
|
738
747
|
| `npm run release:check` | Ejecuta validación orientada a release. |
|
|
739
748
|
|
|
740
|
-
Cuando cambies Truthmark en sí, consulta [
|
|
749
|
+
Cuando cambies Truthmark en sí, consulta [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
741
750
|
|
|
742
751
|
## Documentación
|
|
743
752
|
|
|
@@ -746,11 +755,11 @@ El README es el camino rápido para evaluación y configuración.
|
|
|
746
755
|
El comportamiento actual detallado vive bajo `docs/`:
|
|
747
756
|
|
|
748
757
|
- [Índice de documentación](docs/README.md)
|
|
749
|
-
- [Resumen de arquitectura](docs/architecture/overview.md)
|
|
750
|
-
- [Contratos de API y CLI](docs/truth/contracts.md)
|
|
751
|
-
- [Comportamiento de init y scaffold](docs/truth/init-and-scaffold.md)
|
|
752
|
-
- [Diagnósticos de check](docs/truth/check-diagnostics.md)
|
|
753
|
-
- [Flujos instalados](docs/truth/workflows/overview.md)
|
|
758
|
+
- [Resumen de arquitectura](docs/truthmark/truth/architecture/overview.md)
|
|
759
|
+
- [Contratos de API y CLI](docs/truthmark/truth/contracts.md)
|
|
760
|
+
- [Comportamiento de init y scaffold](docs/truthmark/truth/init-and-scaffold.md)
|
|
761
|
+
- [Diagnósticos de check](docs/truthmark/truth/check-diagnostics.md)
|
|
762
|
+
- [Flujos instalados](docs/truthmark/truth/workflows/overview.md)
|
|
754
763
|
- [Guía para mantener la verdad del repositorio](docs/standards/maintaining-repository-truth.md)
|
|
755
764
|
|
|
756
765
|
## Límites de diseño
|
|
@@ -771,7 +780,7 @@ No es:
|
|
|
771
780
|
|
|
772
781
|
Esos límites son parte del producto.
|
|
773
782
|
|
|
774
|
-
Truthmark mantiene el flujo local,
|
|
783
|
+
Truthmark mantiene el flujo local, versionado, acotado a la rama y revisable.
|
|
775
784
|
|
|
776
785
|
## Seguridad y disciplina de revisión
|
|
777
786
|
|
|
@@ -784,10 +793,10 @@ Los equipos deberían seguir:
|
|
|
784
793
|
- revisando cambios de documentos de verdad
|
|
785
794
|
- manteniendo secretos fuera de la documentación
|
|
786
795
|
- manteniendo instrucciones específicas del repositorio fuera de bloques administrados
|
|
787
|
-
- revisando diffs de
|
|
796
|
+
- revisando diffs de interfaces de flujo de trabajo generadas después de las actualizaciones
|
|
788
797
|
- conservando propiedad humana sobre decisiones de producto y arquitectura
|
|
789
798
|
|
|
790
|
-
Truthmark hace visible
|
|
799
|
+
Truthmark hace visible la verdad del repositorio orientada al agente. No reemplaza el juicio humano.
|
|
791
800
|
|
|
792
801
|
## Dirección de la hoja de ruta
|
|
793
802
|
|
|
@@ -797,9 +806,9 @@ La dirección futura actual enfatiza:
|
|
|
797
806
|
- ejemplos de adopción más claros
|
|
798
807
|
- repositorios de ejemplo que muestren ciclos reales de Truth Sync
|
|
799
808
|
- guías de migración para equipos que ya usan archivos de instrucciones para agentes
|
|
800
|
-
- pruebas de conformidad para
|
|
801
|
-
-
|
|
802
|
-
-
|
|
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
|
|
803
812
|
|
|
804
813
|
El centro de gravedad se mantiene igual:
|
|
805
814
|
|
|
@@ -807,7 +816,7 @@ El centro de gravedad se mantiene igual:
|
|
|
807
816
|
verdad del repositorio
|
|
808
817
|
flujos nativos para agentes
|
|
809
818
|
revisión en Git
|
|
810
|
-
|
|
819
|
+
documentación acotada a la rama
|
|
811
820
|
```
|
|
812
821
|
|
|
813
822
|
## Licencia
|