truthmark 2.1.0 → 2.2.1
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 +18 -21
- package/README.es.md +18 -21
- package/README.md +18 -21
- package/README.ru.md +18 -21
- package/README.zh.md +18 -21
- package/dist/main.js +1335 -1135
- package/dist/main.js.map +1 -1
- package/package.json +4 -2
package/README.de.md
CHANGED
|
@@ -394,7 +394,7 @@ Es darf keinen funktionalen Code ändern.
|
|
|
394
394
|
Nutze Truth Realize, wenn eine Produkt- oder Architekturentscheidung in Dokumenten beginnt und Code daran angepasst werden soll.
|
|
395
395
|
|
|
396
396
|
```text
|
|
397
|
-
/truthmark-realize docs/truthmark/
|
|
397
|
+
/truthmark-realize docs/truthmark/product/capabilities/session-timeout.md in Code realisieren
|
|
398
398
|
```
|
|
399
399
|
|
|
400
400
|
Truth Realize ist doc-first.
|
|
@@ -441,7 +441,7 @@ Die meisten Maintainer beginnen mit drei Befehlen.
|
|
|
441
441
|
| `truthmark init` | Installiert oder aktualisiert konfigurierte Workflow-Schnittstellen aus der geprüften Config. |
|
|
442
442
|
| `truthmark check` | Validiert Config, Autorität, Routing, entscheidungstragende Dokumente, Frontmatter, interne Links, Branch-Scope, generierte Oberflächen, Freshness und Coverage-Diagnostik. |
|
|
443
443
|
|
|
444
|
-
Optionale Repository-Intelligence-Helfer erzeugen abgeleitetes Review-Material für den aktiven Checkout, etwa RepoIndex-, RouteMap-, ImpactSet- und
|
|
444
|
+
Optionale Repository-Intelligence-Helfer erzeugen abgeleitetes Review-Material für den aktiven Checkout, etwa RepoIndex-, RouteMap-, ImpactSet- und kompaktes WorkflowState/action-context-JSON. Generierte Workflow-Skill-Pakete können außerdem Helper-Manifeste und Helper-Policies bereitstellen, die installierte `truthmark validate ... --json` CLI-Validatoren aufrufen; diese Helpers sind Beschleuniger, keine im Repository gebündelten lokalen Skripte und keine Quellen der Wahrheit. Eigenständige Copilot-Prompts und Gemini-Commands verwenden denselben CLI-Validator-Vertrag, wenn der installierte Runner verfügbar ist; andernfalls melden sie einen sichtbaren übersprungenen Helper-Status und führen eine manuelle Validierung durch.
|
|
445
445
|
|
|
446
446
|
Sie sind keine Quellen der Wahrheit.
|
|
447
447
|
|
|
@@ -449,7 +449,7 @@ Sie sind keine Quellen der Wahrheit.
|
|
|
449
449
|
| --- | --- |
|
|
450
450
|
| `truthmark index` | Baut RepoIndex- und RouteMap-JSON für den aktiven Checkout. |
|
|
451
451
|
| `truthmark impact --base <ref>` | Ordnet geänderte Dateien gerouteten Truth-Dokumenten, besitzenden Routen, nahen Tests und öffentlichen Symbolen zu. |
|
|
452
|
-
| `truthmark
|
|
452
|
+
| `truthmark workflow status --workflow <workflow> [--base <ref>] --json` | Liefert Workflow-Anwendbarkeit, Schreibgrenzen, Ziel-Truth-Dokumente, Checks, Helper-Commands und kompakte Hinweise zu betroffenen Tests. |
|
|
453
453
|
|
|
454
454
|
Strukturierte Ausgabe ist mit `--json` verfügbar, wo sie unterstützt wird.
|
|
455
455
|
|
|
@@ -511,12 +511,9 @@ Wichtige Config-Bereiche sind:
|
|
|
511
511
|
| `version` | Version des Config-Vertrags. |
|
|
512
512
|
| `platforms` | Agenten-Hosts, die plattformspezifische generierte Oberflächen erhalten sollen. |
|
|
513
513
|
| `truthmark.workspace` | Truthmark-eigener Workspace für Routen, Truth-Dokumente, Vorlagen und generierte Präsentationsausgabe. |
|
|
514
|
-
| `
|
|
515
|
-
|
|
|
516
|
-
|
|
|
517
|
-
| `truthmark.routes.max_delegation_depth` | Aktuelle maximale Routing-Delegationstiefe. |
|
|
518
|
-
| `truthmark.truth.root` | Truth-Dokumentwurzel relativ zu `truthmark.workspace`. |
|
|
519
|
-
| `truthmark.templates.root` | Truth-Dokumentvorlagenwurzel relativ zu `truthmark.workspace`. |
|
|
514
|
+
| Feste Routen | Routen liegen unter `routes/areas.md` und `routes/areas/` innerhalb von `truthmark.workspace`; die Standard-Area ist `repository`, die Delegationstiefe ist `1`. |
|
|
515
|
+
| Feste Truth-Lanes | Product-Truth liegt unter `product/` und Engineering-Truth unter `engineering/` innerhalb von `truthmark.workspace`. |
|
|
516
|
+
| Feste Vorlagen | Truth-Dokumentvorlagen liegen unter `templates/` innerhalb von `truthmark.workspace`. |
|
|
520
517
|
| `truthmark.generated.portal` | Optionale manuelle Präsentations-Workflow-Aktivierung: `enabled`. |
|
|
521
518
|
| `instruction_targets` | Dateien, die gemeinsam verwaltete Instruktionsblöcke erhalten, etwa `AGENTS.md`. |
|
|
522
519
|
| `frontmatter.required` | Metadatenfelder, die bei Fehlen Error-Diagnostik erzeugen. |
|
|
@@ -645,7 +642,7 @@ truthmark check
|
|
|
645
642
|
### Implementiertes Verhalten dokumentieren
|
|
646
643
|
|
|
647
644
|
```text
|
|
648
|
-
/truthmark-document den implementierten Password-Reset-Flow unter docs/truthmark/
|
|
645
|
+
/truthmark-document den implementierten Password-Reset-Flow unter docs/truthmark/engineering/behaviors/authentication dokumentieren
|
|
649
646
|
```
|
|
650
647
|
|
|
651
648
|
### Nach Codeänderungen synchronisieren
|
|
@@ -657,7 +654,7 @@ truthmark check
|
|
|
657
654
|
### Eine doc-first Entscheidung realisieren
|
|
658
655
|
|
|
659
656
|
```text
|
|
660
|
-
/truthmark-realize docs/truthmark/
|
|
657
|
+
/truthmark-realize docs/truthmark/product/capabilities/invoice-retry-policy.md in Code realisieren
|
|
661
658
|
```
|
|
662
659
|
|
|
663
660
|
### Truth-Gesundheit im Terminal auditieren
|
|
@@ -672,10 +669,10 @@ truthmark check
|
|
|
672
669
|
truthmark impact --base main
|
|
673
670
|
```
|
|
674
671
|
|
|
675
|
-
### Workflow-
|
|
672
|
+
### Workflow-Status prüfen
|
|
676
673
|
|
|
677
674
|
```bash
|
|
678
|
-
truthmark
|
|
675
|
+
truthmark workflow status --workflow truthmark-sync --base main --json
|
|
679
676
|
```
|
|
680
677
|
|
|
681
678
|
### Optionalen Portal-Workflow aktivieren
|
|
@@ -702,7 +699,7 @@ Truthmark V1 bietet derzeit:
|
|
|
702
699
|
- `truthmark check`
|
|
703
700
|
- `truthmark index`
|
|
704
701
|
- `truthmark impact`
|
|
705
|
-
- `truthmark
|
|
702
|
+
- `truthmark workflow status`
|
|
706
703
|
- Branch-Scope-Metadaten
|
|
707
704
|
- verwaltete Instruktionsblöcke
|
|
708
705
|
- generierte Truth-Structure-Workflow-Schnittstellen
|
|
@@ -713,7 +710,7 @@ Truthmark V1 bietet derzeit:
|
|
|
713
710
|
- generierte Truth-Check-Workflow-Schnittstellen
|
|
714
711
|
- optionale generierte Truthmark-Portal-Workflow-Schnittstellen
|
|
715
712
|
- Diagnostik für Route, Autorität, Entscheidungsstruktur, Frontmatter, Links, Freshness, generierte Schnittstellen und Coverage
|
|
716
|
-
- abgeleitete RepoIndex-, RouteMap-, ImpactSet- und
|
|
713
|
+
- abgeleitete RepoIndex-, RouteMap-, ImpactSet- und WorkflowState-Artefakte
|
|
717
714
|
- host-spezifische Schnittstellen für Codex, Claude Code, GitHub Copilot, OpenCode und Gemini CLI
|
|
718
715
|
|
|
719
716
|
## Entwicklung
|
|
@@ -749,7 +746,7 @@ Nützliche Skripte:
|
|
|
749
746
|
| `npm run check` | Führt Lint, Typecheck, Tests und Build aus. |
|
|
750
747
|
| `npm run release:check` | Führt release-orientierte Validierung aus. |
|
|
751
748
|
|
|
752
|
-
Wenn du Truthmark selbst änderst, siehe [
|
|
749
|
+
Wenn du Truthmark selbst änderst, siehe [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
753
750
|
|
|
754
751
|
## Dokumentation
|
|
755
752
|
|
|
@@ -758,11 +755,11 @@ Die README ist der schnelle Pfad für Evaluation und Setup.
|
|
|
758
755
|
Aktuelles Verhalten im Detail lebt unter `docs/`:
|
|
759
756
|
|
|
760
757
|
- [Dokumentationsindex](docs/README.md)
|
|
761
|
-
- [Architekturüberblick](docs/truthmark/
|
|
762
|
-
- [API- und CLI-Verträge](docs/truthmark/
|
|
763
|
-
- [Init- und Scaffold-Verhalten](docs/truthmark/
|
|
764
|
-
- [Check-Diagnostik](docs/truthmark/
|
|
765
|
-
- [Installierte Workflows](docs/truthmark/
|
|
758
|
+
- [Architekturüberblick](docs/truthmark/engineering/architecture/overview.md)
|
|
759
|
+
- [API- und CLI-Verträge](docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
760
|
+
- [Init- und Scaffold-Verhalten](docs/truthmark/engineering/behaviors/init-and-scaffold.md)
|
|
761
|
+
- [Check-Diagnostik](docs/truthmark/engineering/behaviors/check-diagnostics.md)
|
|
762
|
+
- [Installierte Workflows](docs/truthmark/engineering/workflows/installed-workflow-runtime.md)
|
|
766
763
|
- [Leitfaden zur Pflege von Repository-Truth](docs/standards/maintaining-repository-truth.md)
|
|
767
764
|
|
|
768
765
|
## Designgrenzen
|
package/README.es.md
CHANGED
|
@@ -394,7 +394,7 @@ No debe cambiar código funcional.
|
|
|
394
394
|
Usa Truth Realize cuando una decisión de producto o arquitectura empieza en documentos y el código debe actualizarse para coincidir.
|
|
395
395
|
|
|
396
396
|
```text
|
|
397
|
-
/truthmark-realize realiza docs/truthmark/
|
|
397
|
+
/truthmark-realize realiza docs/truthmark/product/capabilities/session-timeout.md como código
|
|
398
398
|
```
|
|
399
399
|
|
|
400
400
|
Truth Realize es doc-first.
|
|
@@ -441,7 +441,7 @@ La mayoría de los mantenedores empieza con tres comandos.
|
|
|
441
441
|
| `truthmark init` | Instala o refresca interfaces de flujo de trabajo configuradas desde la config revisada. |
|
|
442
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
443
|
|
|
444
|
-
Los ayudantes opcionales de inteligencia del repositorio generan material derivado para revisión sobre el checkout activo, como
|
|
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
445
|
|
|
446
446
|
No son fuentes de verdad.
|
|
447
447
|
|
|
@@ -449,7 +449,7 @@ No son fuentes de verdad.
|
|
|
449
449
|
| --- | --- |
|
|
450
450
|
| `truthmark index` | Construye JSON de RepoIndex y RouteMap para el checkout activo. |
|
|
451
451
|
| `truthmark impact --base <ref>` | Mapea archivos cambiados a documentos de verdad enrutados, rutas propietarias, pruebas cercanas y símbolos públicos. |
|
|
452
|
-
| `truthmark
|
|
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
453
|
|
|
454
454
|
La salida estructurada está disponible con `--json` donde se admite.
|
|
455
455
|
|
|
@@ -511,12 +511,9 @@ Las áreas importantes de configuración incluyen:
|
|
|
511
511
|
| `version` | Versión del contrato de configuración. |
|
|
512
512
|
| `platforms` | Hosts de agentes que deben recibir interfaces generadas específicas de plataforma. |
|
|
513
513
|
| `truthmark.workspace` | Workspace propiedad de Truthmark para rutas, documentos de verdad, plantillas y salida de presentación generada. |
|
|
514
|
-
| `
|
|
515
|
-
|
|
|
516
|
-
|
|
|
517
|
-
| `truthmark.routes.max_delegation_depth` | Profundidad máxima actual de delegación de rutas. |
|
|
518
|
-
| `truthmark.truth.root` | Raíz de documentos de verdad relativa a `truthmark.workspace`. |
|
|
519
|
-
| `truthmark.templates.root` | Raíz de plantillas de documentos de verdad relativa a `truthmark.workspace`. |
|
|
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`. |
|
|
520
517
|
| `truthmark.generated.portal` | Activación opcional del flujo manual de presentación: `enabled`. |
|
|
521
518
|
| `instruction_targets` | Archivos que reciben bloques de instrucciones administrados compartidos, como `AGENTS.md`. |
|
|
522
519
|
| `frontmatter.required` | Campos de metadatos que producen diagnósticos de error cuando faltan. |
|
|
@@ -645,7 +642,7 @@ truthmark check
|
|
|
645
642
|
### Documentar comportamiento implementado
|
|
646
643
|
|
|
647
644
|
```text
|
|
648
|
-
/truthmark-document documenta el flujo implementado de restablecimiento de contraseña bajo docs/truthmark/
|
|
645
|
+
/truthmark-document documenta el flujo implementado de restablecimiento de contraseña bajo docs/truthmark/engineering/behaviors/authentication
|
|
649
646
|
```
|
|
650
647
|
|
|
651
648
|
### Sincronizar después de cambios de código
|
|
@@ -657,7 +654,7 @@ truthmark check
|
|
|
657
654
|
### Realizar una decisión doc-first
|
|
658
655
|
|
|
659
656
|
```text
|
|
660
|
-
/truthmark-realize realiza docs/truthmark/
|
|
657
|
+
/truthmark-realize realiza docs/truthmark/product/capabilities/invoice-retry-policy.md como código
|
|
661
658
|
```
|
|
662
659
|
|
|
663
660
|
### Auditar la salud de verdad desde la terminal
|
|
@@ -672,10 +669,10 @@ truthmark check
|
|
|
672
669
|
truthmark impact --base main
|
|
673
670
|
```
|
|
674
671
|
|
|
675
|
-
###
|
|
672
|
+
### Inspeccionar el estado del workflow
|
|
676
673
|
|
|
677
674
|
```bash
|
|
678
|
-
truthmark
|
|
675
|
+
truthmark workflow status --workflow truthmark-sync --base main --json
|
|
679
676
|
```
|
|
680
677
|
|
|
681
678
|
### Habilitar el flujo Portal opcional
|
|
@@ -702,7 +699,7 @@ Truthmark V1 actualmente proporciona:
|
|
|
702
699
|
- `truthmark check`
|
|
703
700
|
- `truthmark index`
|
|
704
701
|
- `truthmark impact`
|
|
705
|
-
- `truthmark
|
|
702
|
+
- `truthmark workflow status`
|
|
706
703
|
- metadatos de alcance de rama
|
|
707
704
|
- bloques de instrucciones administrados
|
|
708
705
|
- interfaces generadas de flujo Truth Structure
|
|
@@ -713,7 +710,7 @@ Truthmark V1 actualmente proporciona:
|
|
|
713
710
|
- interfaces generadas de flujo Truth Check
|
|
714
711
|
- interfaces generadas opcionales de flujo Truthmark Portal
|
|
715
712
|
- diagnósticos de rutas, autoridad, estructura de decisiones, frontmatter, enlaces, vigencia, interfaces generadas y cobertura
|
|
716
|
-
- artefactos derivados RepoIndex, RouteMap, ImpactSet y
|
|
713
|
+
- artefactos derivados RepoIndex, RouteMap, ImpactSet y WorkflowState
|
|
717
714
|
- interfaces específicas de host para Codex, Claude Code, GitHub Copilot, OpenCode y Gemini CLI
|
|
718
715
|
|
|
719
716
|
## Desarrollo
|
|
@@ -749,7 +746,7 @@ Scripts útiles:
|
|
|
749
746
|
| `npm run check` | Ejecuta lint, typecheck, pruebas y build. |
|
|
750
747
|
| `npm run release:check` | Ejecuta validación orientada a release. |
|
|
751
748
|
|
|
752
|
-
Cuando cambies Truthmark en sí, consulta [
|
|
749
|
+
Cuando cambies Truthmark en sí, consulta [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
753
750
|
|
|
754
751
|
## Documentación
|
|
755
752
|
|
|
@@ -758,11 +755,11 @@ El README es el camino rápido para evaluación y configuración.
|
|
|
758
755
|
El comportamiento actual detallado vive bajo `docs/`:
|
|
759
756
|
|
|
760
757
|
- [Índice de documentación](docs/README.md)
|
|
761
|
-
- [Resumen de arquitectura](docs/truthmark/
|
|
762
|
-
- [Contratos de API y CLI](docs/truthmark/
|
|
763
|
-
- [Comportamiento de init y scaffold](docs/truthmark/
|
|
764
|
-
- [Diagnósticos de check](docs/truthmark/
|
|
765
|
-
- [Flujos instalados](docs/truthmark/
|
|
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)
|
|
766
763
|
- [Guía para mantener la verdad del repositorio](docs/standards/maintaining-repository-truth.md)
|
|
767
764
|
|
|
768
765
|
## Límites de diseño
|
package/README.md
CHANGED
|
@@ -394,7 +394,7 @@ It must not change functional code.
|
|
|
394
394
|
Use Truth Realize when a product or architecture decision starts in docs and code should be updated to match.
|
|
395
395
|
|
|
396
396
|
```text
|
|
397
|
-
/truthmark-realize realize docs/truthmark/
|
|
397
|
+
/truthmark-realize realize docs/truthmark/product/capabilities/session-timeout.md into code
|
|
398
398
|
```
|
|
399
399
|
|
|
400
400
|
Truth Realize is doc-first.
|
|
@@ -441,7 +441,7 @@ Most maintainers start with three commands.
|
|
|
441
441
|
| `truthmark init` | Install or refresh configured workflow surfaces from the reviewed config. |
|
|
442
442
|
| `truthmark check` | Validate configuration, authority, routing, decision-bearing docs, frontmatter, internal links, branch scope, generated surfaces, freshness, and coverage diagnostics. |
|
|
443
443
|
|
|
444
|
-
Optional repository-intelligence helpers generate derived review material for the active checkout, such as RepoIndex, RouteMap, ImpactSet, and
|
|
444
|
+
Optional repository-intelligence helpers generate derived review material for the active checkout, such as RepoIndex, RouteMap, ImpactSet, and compact WorkflowState/action-context JSON. Generated workflow skill packages may also expose helper manifests and helper policies that call installed `truthmark validate ... --json` CLI validators; those helpers are accelerators, not bundled repo-local scripts or sources of truth. Standalone Copilot prompts and Gemini commands use the same CLI validator contract when the installed runner is available, and otherwise report a visible skipped helper status with manual validation.
|
|
445
445
|
|
|
446
446
|
They are not sources of truth.
|
|
447
447
|
|
|
@@ -449,7 +449,7 @@ They are not sources of truth.
|
|
|
449
449
|
| --- | --- |
|
|
450
450
|
| `truthmark index` | Build RepoIndex and RouteMap JSON for the active checkout. |
|
|
451
451
|
| `truthmark impact --base <ref>` | Map changed files to routed truth docs, owning routes, nearby tests, and public symbols. |
|
|
452
|
-
| `truthmark
|
|
452
|
+
| `truthmark workflow status --workflow <workflow> [--base <ref>] --json` | Return workflow applicability, write boundaries, target truth docs, checks, helper commands, and compact affected-test guidance. |
|
|
453
453
|
|
|
454
454
|
Structured output is available with `--json` where supported.
|
|
455
455
|
|
|
@@ -511,12 +511,9 @@ Important config areas include:
|
|
|
511
511
|
| `version` | Config contract version. |
|
|
512
512
|
| `platforms` | Agent hosts that should receive platform-specific generated surfaces. |
|
|
513
513
|
| `truthmark.workspace` | Truthmark-owned workspace for routes, truth docs, templates, and generated presentation output. |
|
|
514
|
-
|
|
|
515
|
-
|
|
|
516
|
-
|
|
|
517
|
-
| `truthmark.routes.max_delegation_depth` | Current maximum route delegation depth. |
|
|
518
|
-
| `truthmark.truth.root` | Truth doc root relative to `truthmark.workspace`. |
|
|
519
|
-
| `truthmark.templates.root` | Truth-doc template root relative to `truthmark.workspace`. |
|
|
514
|
+
| Fixed routes | Routes live under `routes/areas.md` and `routes/areas/` inside `truthmark.workspace`; the default area is `repository` and delegation depth is `1`. |
|
|
515
|
+
| Fixed truth lanes | Product truth lives under `product/` and engineering truth under `engineering/` inside `truthmark.workspace`. |
|
|
516
|
+
| Fixed templates | Truth-doc templates live under `templates/` inside `truthmark.workspace`. |
|
|
520
517
|
| `truthmark.generated.portal` | Optional manual presentation workflow enablement: `enabled`. |
|
|
521
518
|
| `instruction_targets` | Files that receive shared managed instruction blocks, such as `AGENTS.md`. |
|
|
522
519
|
| `frontmatter.required` | Metadata fields that produce error diagnostics when missing. |
|
|
@@ -645,7 +642,7 @@ truthmark check
|
|
|
645
642
|
### Document implemented behavior
|
|
646
643
|
|
|
647
644
|
```text
|
|
648
|
-
/truthmark-document document the implemented password reset flow under docs/truthmark/
|
|
645
|
+
/truthmark-document document the implemented password reset flow under docs/truthmark/engineering/behaviors/authentication
|
|
649
646
|
```
|
|
650
647
|
|
|
651
648
|
### Sync after code changes
|
|
@@ -657,7 +654,7 @@ truthmark check
|
|
|
657
654
|
### Realize a doc-first decision
|
|
658
655
|
|
|
659
656
|
```text
|
|
660
|
-
/truthmark-realize realize docs/truthmark/
|
|
657
|
+
/truthmark-realize realize docs/truthmark/product/capabilities/invoice-retry-policy.md into code
|
|
661
658
|
```
|
|
662
659
|
|
|
663
660
|
### Audit truth health from the terminal
|
|
@@ -672,10 +669,10 @@ truthmark check
|
|
|
672
669
|
truthmark impact --base main
|
|
673
670
|
```
|
|
674
671
|
|
|
675
|
-
###
|
|
672
|
+
### Inspect workflow status
|
|
676
673
|
|
|
677
674
|
```bash
|
|
678
|
-
truthmark
|
|
675
|
+
truthmark workflow status --workflow truthmark-sync --base main --json
|
|
679
676
|
```
|
|
680
677
|
|
|
681
678
|
### Enable the optional Portal workflow
|
|
@@ -702,7 +699,7 @@ Truthmark V1 currently provides:
|
|
|
702
699
|
- `truthmark check`
|
|
703
700
|
- `truthmark index`
|
|
704
701
|
- `truthmark impact`
|
|
705
|
-
- `truthmark
|
|
702
|
+
- `truthmark workflow status`
|
|
706
703
|
- branch-scope metadata
|
|
707
704
|
- managed instruction blocks
|
|
708
705
|
- generated Truth Structure workflow surfaces
|
|
@@ -713,7 +710,7 @@ Truthmark V1 currently provides:
|
|
|
713
710
|
- generated Truth Check workflow surfaces
|
|
714
711
|
- optional generated Truthmark Portal workflow surfaces
|
|
715
712
|
- route, authority, decision-structure, frontmatter, link, freshness, generated-surface, and coverage diagnostics
|
|
716
|
-
- derived RepoIndex, RouteMap, ImpactSet, and
|
|
713
|
+
- derived RepoIndex, RouteMap, ImpactSet, and WorkflowState artifacts
|
|
717
714
|
- host-specific surfaces for Codex, Claude Code, GitHub Copilot, OpenCode, and Gemini CLI
|
|
718
715
|
|
|
719
716
|
## Development
|
|
@@ -749,7 +746,7 @@ Useful scripts:
|
|
|
749
746
|
| `npm run check` | Run lint, typecheck, tests, and build. |
|
|
750
747
|
| `npm run release:check` | Run release-oriented validation. |
|
|
751
748
|
|
|
752
|
-
When changing Truthmark itself, see [
|
|
749
|
+
When changing Truthmark itself, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
753
750
|
|
|
754
751
|
## Documentation
|
|
755
752
|
|
|
@@ -758,11 +755,11 @@ The README is the fast path for evaluation and setup.
|
|
|
758
755
|
Detailed current behavior lives under `docs/`:
|
|
759
756
|
|
|
760
757
|
- [Docs index](docs/README.md)
|
|
761
|
-
- [Architecture overview](docs/truthmark/
|
|
762
|
-
- [API and CLI contracts](docs/truthmark/
|
|
763
|
-
- [Init and scaffold behavior](docs/truthmark/
|
|
764
|
-
- [Check diagnostics](docs/truthmark/
|
|
765
|
-
- [Installed workflows](docs/truthmark/
|
|
758
|
+
- [Architecture overview](docs/truthmark/engineering/architecture/overview.md)
|
|
759
|
+
- [API and CLI contracts](docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
760
|
+
- [Init and scaffold behavior](docs/truthmark/engineering/behaviors/init-and-scaffold.md)
|
|
761
|
+
- [Check diagnostics](docs/truthmark/engineering/behaviors/check-diagnostics.md)
|
|
762
|
+
- [Installed workflows](docs/truthmark/engineering/workflows/installed-workflow-runtime.md)
|
|
766
763
|
- [Repository truth maintenance guide](docs/standards/maintaining-repository-truth.md)
|
|
767
764
|
|
|
768
765
|
## Design boundaries
|
package/README.ru.md
CHANGED
|
@@ -394,7 +394,7 @@ Truth Document проверяет реализацию, тесты, файлы
|
|
|
394
394
|
Используйте Truth Realize, когда продуктовое или архитектурное решение начинается в docs и код нужно обновить под него.
|
|
395
395
|
|
|
396
396
|
```text
|
|
397
|
-
/truthmark-realize реализуй docs/truthmark/
|
|
397
|
+
/truthmark-realize реализуй docs/truthmark/product/capabilities/session-timeout.md в коде
|
|
398
398
|
```
|
|
399
399
|
|
|
400
400
|
Truth Realize работает doc-first.
|
|
@@ -441,7 +441,7 @@ truthmark check
|
|
|
441
441
|
| `truthmark init` | Устанавливает или обновляет настроенные интерфейсы workflow из проверенной config. |
|
|
442
442
|
| `truthmark check` | Валидирует config, authority, routing, документы с decisions, frontmatter, внутренние ссылки, branch scope, generated surfaces, freshness и coverage diagnostics. |
|
|
443
443
|
|
|
444
|
-
Необязательные helpers repository-intelligence создают производные материалы для ревью активного checkout, например
|
|
444
|
+
Необязательные helpers repository-intelligence создают производные материалы для ревью активного checkout, например RepoIndex, RouteMap, ImpactSet и компактный WorkflowState/action-context JSON. Сгенерированные workflow skill packages также могут предоставлять helper manifests и helper policies, которые вызывают установленные CLI validators `truthmark validate ... --json`; эти helpers являются ускорителями, а не локальными скриптами, упакованными в репозиторий, и не источниками истины. Отдельные Copilot prompts и Gemini commands используют тот же CLI validator contract, когда установленный runner доступен; иначе они должны сообщать видимый skipped helper status и выполнять manual validation.
|
|
445
445
|
|
|
446
446
|
Они не являются источниками истины.
|
|
447
447
|
|
|
@@ -449,7 +449,7 @@ truthmark check
|
|
|
449
449
|
| --- | --- |
|
|
450
450
|
| `truthmark index` | Строит JSON RepoIndex и RouteMap для активного checkout. |
|
|
451
451
|
| `truthmark impact --base <ref>` | Сопоставляет измененные файлы с routed truth docs, owning routes, nearby tests и public symbols. |
|
|
452
|
-
| `truthmark
|
|
452
|
+
| `truthmark workflow status --workflow <workflow> [--base <ref>] --json` | Возвращает применимость workflow, границы записи, целевые truth docs, checks, helper commands и компактные hints по affected tests. |
|
|
453
453
|
|
|
454
454
|
Структурированный вывод доступен с `--json` там, где поддерживается.
|
|
455
455
|
|
|
@@ -511,12 +511,9 @@ truthmark init
|
|
|
511
511
|
| `version` | Версия контракта config. |
|
|
512
512
|
| `platforms` | Agent hosts, которые должны получить сгенерированные интерфейсы для платформы. |
|
|
513
513
|
| `truthmark.workspace` | Workspace, принадлежащий Truthmark, для маршрутов, документов истины, шаблонов и сгенерированного презентационного вывода. |
|
|
514
|
-
| `
|
|
515
|
-
|
|
|
516
|
-
|
|
|
517
|
-
| `truthmark.routes.max_delegation_depth` | Текущая максимальная глубина делегирования routing. |
|
|
518
|
-
| `truthmark.truth.root` | Корень документов истины относительно `truthmark.workspace`. |
|
|
519
|
-
| `truthmark.templates.root` | Корень шаблонов документов истины относительно `truthmark.workspace`. |
|
|
514
|
+
| Фиксированные маршруты | Маршруты находятся в `routes/areas.md` и `routes/areas/` внутри `truthmark.workspace`; область по умолчанию — `repository`, глубина делегирования — `1`. |
|
|
515
|
+
| Фиксированные дорожки истины | Product truth находится в `product/`, а engineering truth в `engineering/` внутри `truthmark.workspace`. |
|
|
516
|
+
| Фиксированные шаблоны | Шаблоны документов истины находятся в `templates/` внутри `truthmark.workspace`. |
|
|
520
517
|
| `truthmark.generated.portal` | Опциональное включение ручного презентационного workflow: `enabled`. |
|
|
521
518
|
| `instruction_targets` | Файлы, которые получают общие управляемые блоки инструкций, например `AGENTS.md`. |
|
|
522
519
|
| `frontmatter.required` | Поля metadata, которые создают error diagnostics при отсутствии. |
|
|
@@ -645,7 +642,7 @@ truthmark check
|
|
|
645
642
|
### Документировать реализованное поведение
|
|
646
643
|
|
|
647
644
|
```text
|
|
648
|
-
/truthmark-document задокументируй реализованный password reset flow в docs/truthmark/
|
|
645
|
+
/truthmark-document задокументируй реализованный password reset flow в docs/truthmark/engineering/behaviors/authentication
|
|
649
646
|
```
|
|
650
647
|
|
|
651
648
|
### Синхронизировать после изменений кода
|
|
@@ -657,7 +654,7 @@ truthmark check
|
|
|
657
654
|
### Реализовать doc-first решение
|
|
658
655
|
|
|
659
656
|
```text
|
|
660
|
-
/truthmark-realize реализуй docs/truthmark/
|
|
657
|
+
/truthmark-realize реализуй docs/truthmark/product/capabilities/invoice-retry-policy.md в коде
|
|
661
658
|
```
|
|
662
659
|
|
|
663
660
|
### Проверить здоровье истины из терминала
|
|
@@ -672,10 +669,10 @@ truthmark check
|
|
|
672
669
|
truthmark impact --base main
|
|
673
670
|
```
|
|
674
671
|
|
|
675
|
-
###
|
|
672
|
+
### Проверить workflow status
|
|
676
673
|
|
|
677
674
|
```bash
|
|
678
|
-
truthmark
|
|
675
|
+
truthmark workflow status --workflow truthmark-sync --base main --json
|
|
679
676
|
```
|
|
680
677
|
|
|
681
678
|
### Включить опциональный Portal workflow
|
|
@@ -702,7 +699,7 @@ Truthmark V1 сейчас предоставляет:
|
|
|
702
699
|
- `truthmark check`
|
|
703
700
|
- `truthmark index`
|
|
704
701
|
- `truthmark impact`
|
|
705
|
-
- `truthmark
|
|
702
|
+
- `truthmark workflow status`
|
|
706
703
|
- branch-scope metadata
|
|
707
704
|
- управляемые блоки инструкций
|
|
708
705
|
- сгенерированные интерфейсы workflow Truth Structure
|
|
@@ -713,7 +710,7 @@ Truthmark V1 сейчас предоставляет:
|
|
|
713
710
|
- сгенерированные интерфейсы workflow Truth Check
|
|
714
711
|
- опциональные сгенерированные интерфейсы workflow Truthmark Portal
|
|
715
712
|
- diagnostics для route, authority, decision-structure, frontmatter, links, freshness, generated-surface и coverage
|
|
716
|
-
- производные артефакты RepoIndex, RouteMap, ImpactSet и
|
|
713
|
+
- производные артефакты RepoIndex, RouteMap, ImpactSet и WorkflowState
|
|
717
714
|
- host-specific интерфейсы для Codex, Claude Code, GitHub Copilot, OpenCode и Gemini CLI
|
|
718
715
|
|
|
719
716
|
## Разработка
|
|
@@ -749,7 +746,7 @@ npm run check
|
|
|
749
746
|
| `npm run check` | Запускает lint, typecheck, tests и build. |
|
|
750
747
|
| `npm run release:check` | Запускает release-oriented validation. |
|
|
751
748
|
|
|
752
|
-
Когда меняете сам Truthmark, смотрите [
|
|
749
|
+
Когда меняете сам Truthmark, смотрите [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
753
750
|
|
|
754
751
|
## Документация
|
|
755
752
|
|
|
@@ -758,11 +755,11 @@ README — быстрый путь для оценки и настройки.
|
|
|
758
755
|
Подробное текущее поведение живет в `docs/`:
|
|
759
756
|
|
|
760
757
|
- [Индекс документации](docs/README.md)
|
|
761
|
-
- [Обзор архитектуры](docs/truthmark/
|
|
762
|
-
- [Контракты API и CLI](docs/truthmark/
|
|
763
|
-
- [Поведение init и scaffold](docs/truthmark/
|
|
764
|
-
- [Диагностика check](docs/truthmark/
|
|
765
|
-
- [Установленные workflows](docs/truthmark/
|
|
758
|
+
- [Обзор архитектуры](docs/truthmark/engineering/architecture/overview.md)
|
|
759
|
+
- [Контракты API и CLI](docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
760
|
+
- [Поведение init и scaffold](docs/truthmark/engineering/behaviors/init-and-scaffold.md)
|
|
761
|
+
- [Диагностика check](docs/truthmark/engineering/behaviors/check-diagnostics.md)
|
|
762
|
+
- [Установленные workflows](docs/truthmark/engineering/workflows/installed-workflow-runtime.md)
|
|
766
763
|
- [Руководство по поддержанию истины репозитория](docs/standards/maintaining-repository-truth.md)
|
|
767
764
|
|
|
768
765
|
## Границы дизайна
|
package/README.zh.md
CHANGED
|
@@ -394,7 +394,7 @@ Truth Document 会把实现、测试、路由文件和现有文档作为证据
|
|
|
394
394
|
当产品或架构决策从文档开始,并且代码应更新以匹配时,使用 Truth Realize。
|
|
395
395
|
|
|
396
396
|
```text
|
|
397
|
-
/truthmark-realize 将 docs/truthmark/
|
|
397
|
+
/truthmark-realize 将 docs/truthmark/product/capabilities/session-timeout.md 实现到代码中
|
|
398
398
|
```
|
|
399
399
|
|
|
400
400
|
Truth Realize 是 doc-first。
|
|
@@ -441,7 +441,7 @@ truthmark check
|
|
|
441
441
|
| `truthmark init` | 从已审查配置安装或刷新已配置的工作流接口。 |
|
|
442
442
|
| `truthmark check` | 验证配置、权限边界、路由、承载决策的文档、frontmatter、内部链接、分支范围、生成接口、freshness 和覆盖率诊断。 |
|
|
443
443
|
|
|
444
|
-
可选的仓库情报辅助工具会为当前 checkout 生成派生审查材料,例如 RepoIndex、RouteMap、ImpactSet
|
|
444
|
+
可选的仓库情报辅助工具会为当前 checkout 生成派生审查材料,例如 RepoIndex、RouteMap、ImpactSet 和紧凑的 WorkflowState/action-context JSON。生成的工作流 skill packages 也可以暴露 helper manifests 和 helper policies,用来调用已安装的 `truthmark validate ... --json` CLI validators;这些 helpers 是加速器,不是打包进仓库的本地脚本,也不是事实来源。独立的 Copilot prompts 和 Gemini commands 在已安装 runner 可用时使用同一 CLI validator contract;不可用时应报告可见的 skipped helper status,并进行 manual validation。
|
|
445
445
|
|
|
446
446
|
它们不是事实来源。
|
|
447
447
|
|
|
@@ -449,7 +449,7 @@ truthmark check
|
|
|
449
449
|
| --- | --- |
|
|
450
450
|
| `truthmark index` | 为当前 checkout 构建 RepoIndex 和 RouteMap JSON。 |
|
|
451
451
|
| `truthmark impact --base <ref>` | 将变更文件映射到已路由事实文档、所属路由、附近测试和公开符号。 |
|
|
452
|
-
| `truthmark
|
|
452
|
+
| `truthmark workflow status --workflow <workflow> [--base <ref>] --json` | 返回工作流适用性、写入边界、目标事实文档、检查项、helper commands 和紧凑的受影响测试指引。 |
|
|
453
453
|
|
|
454
454
|
受支持位置可使用 `--json` 获取结构化输出。
|
|
455
455
|
|
|
@@ -511,12 +511,9 @@ truthmark init
|
|
|
511
511
|
| `version` | 配置契约版本。 |
|
|
512
512
|
| `platforms` | 应接收平台专属生成接口的代理宿主。 |
|
|
513
513
|
| `truthmark.workspace` | Truthmark 拥有的工作区,用于路由、事实文档、模板和生成的展示输出。 |
|
|
514
|
-
| `truthmark.routes.
|
|
515
|
-
|
|
|
516
|
-
| `truthmark.
|
|
517
|
-
| `truthmark.routes.max_delegation_depth` | 当前最大路由委托深度。 |
|
|
518
|
-
| `truthmark.truth.root` | 相对于 `truthmark.workspace` 的事实文档根。 |
|
|
519
|
-
| `truthmark.templates.root` | 相对于 `truthmark.workspace` 的事实文档模板根。 |
|
|
514
|
+
| 固定路由 | 路由固定在 `truthmark.workspace` 内的 `routes/areas.md` 和 `routes/areas/`;默认 area 是 `repository`,委托深度为 `1`。 |
|
|
515
|
+
| 固定事实分区 | 产品事实位于 `truthmark.workspace` 内的 `product/`,工程事实位于 `engineering/`。 |
|
|
516
|
+
| 固定模板 | 事实文档模板固定在 `truthmark.workspace` 内的 `templates/`。 |
|
|
520
517
|
| `truthmark.generated.portal` | 可选手动展示工作流启用设置:`enabled`。 |
|
|
521
518
|
| `instruction_targets` | 接收共享受管指令块的文件,例如 `AGENTS.md`。 |
|
|
522
519
|
| `frontmatter.required` | 缺失时产生错误诊断的元数据字段。 |
|
|
@@ -645,7 +642,7 @@ truthmark check
|
|
|
645
642
|
### 记录已实现行为
|
|
646
643
|
|
|
647
644
|
```text
|
|
648
|
-
/truthmark-document 在 docs/truthmark/
|
|
645
|
+
/truthmark-document 在 docs/truthmark/engineering/behaviors/authentication 下记录已实现的密码重置流程
|
|
649
646
|
```
|
|
650
647
|
|
|
651
648
|
### 代码变更后同步
|
|
@@ -657,7 +654,7 @@ truthmark check
|
|
|
657
654
|
### 实现 doc-first 决策
|
|
658
655
|
|
|
659
656
|
```text
|
|
660
|
-
/truthmark-realize 将 docs/truthmark/
|
|
657
|
+
/truthmark-realize 将 docs/truthmark/product/capabilities/invoice-retry-policy.md 实现到代码中
|
|
661
658
|
```
|
|
662
659
|
|
|
663
660
|
### 从终端审计事实健康
|
|
@@ -672,10 +669,10 @@ truthmark check
|
|
|
672
669
|
truthmark impact --base main
|
|
673
670
|
```
|
|
674
671
|
|
|
675
|
-
###
|
|
672
|
+
### 查看工作流状态
|
|
676
673
|
|
|
677
674
|
```bash
|
|
678
|
-
truthmark
|
|
675
|
+
truthmark workflow status --workflow truthmark-sync --base main --json
|
|
679
676
|
```
|
|
680
677
|
|
|
681
678
|
### 启用可选 Portal 工作流
|
|
@@ -702,7 +699,7 @@ Truthmark V1 目前提供:
|
|
|
702
699
|
- `truthmark check`
|
|
703
700
|
- `truthmark index`
|
|
704
701
|
- `truthmark impact`
|
|
705
|
-
- `truthmark
|
|
702
|
+
- `truthmark workflow status`
|
|
706
703
|
- 分支范围元数据
|
|
707
704
|
- 受管指令块
|
|
708
705
|
- 生成的 Truth Structure 工作流接口
|
|
@@ -713,7 +710,7 @@ Truthmark V1 目前提供:
|
|
|
713
710
|
- 生成的 Truth Check 工作流接口
|
|
714
711
|
- 可选生成的 Truthmark Portal 工作流接口
|
|
715
712
|
- 路由、权限边界、决策结构、frontmatter、链接、freshness、生成接口和覆盖率诊断
|
|
716
|
-
- 派生的 RepoIndex、RouteMap、ImpactSet 和
|
|
713
|
+
- 派生的 RepoIndex、RouteMap、ImpactSet 和 WorkflowState 产物
|
|
717
714
|
- 面向 Codex、Claude Code、GitHub Copilot、OpenCode 和 Gemini CLI 的宿主专属接口
|
|
718
715
|
|
|
719
716
|
## 开发
|
|
@@ -749,7 +746,7 @@ npm run check
|
|
|
749
746
|
| `npm run check` | 运行 lint、typecheck、测试和 build。 |
|
|
750
747
|
| `npm run release:check` | 运行面向发布的验证。 |
|
|
751
748
|
|
|
752
|
-
修改 Truthmark 本身时,请参阅 [
|
|
749
|
+
修改 Truthmark 本身时,请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
|
|
753
750
|
|
|
754
751
|
## 文档
|
|
755
752
|
|
|
@@ -758,11 +755,11 @@ README 是评估和设置的快速路径。
|
|
|
758
755
|
详细的当前行为位于 `docs/` 下:
|
|
759
756
|
|
|
760
757
|
- [文档索引](docs/README.md)
|
|
761
|
-
- [架构概览](docs/truthmark/
|
|
762
|
-
- [API 和 CLI 契约](docs/truthmark/
|
|
763
|
-
- [Init 和脚手架行为](docs/truthmark/
|
|
764
|
-
- [Check 诊断](docs/truthmark/
|
|
765
|
-
- [已安装工作流](docs/truthmark/
|
|
758
|
+
- [架构概览](docs/truthmark/engineering/architecture/overview.md)
|
|
759
|
+
- [API 和 CLI 契约](docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
760
|
+
- [Init 和脚手架行为](docs/truthmark/engineering/behaviors/init-and-scaffold.md)
|
|
761
|
+
- [Check 诊断](docs/truthmark/engineering/behaviors/check-diagnostics.md)
|
|
762
|
+
- [已安装工作流](docs/truthmark/engineering/workflows/installed-workflow-runtime.md)
|
|
766
763
|
- [仓库事实维护指南](docs/standards/maintaining-repository-truth.md)
|
|
767
764
|
|
|
768
765
|
## 设计边界
|