truthmark 1.2.0 → 1.2.2

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.
Files changed (8) hide show
  1. package/README.de.md +18 -12
  2. package/README.es.md +18 -12
  3. package/README.md +29 -17
  4. package/README.ru.md +18 -12
  5. package/README.zh.md +18 -12
  6. package/dist/main.js +320 -266
  7. package/dist/main.js.map +1 -1
  8. package/package.json +1 -1
package/README.de.md CHANGED
@@ -66,7 +66,17 @@ Das ist das Kernversprechen: Agentenkontext wird zu festgeschriebenem Repository
66
66
 
67
67
  ## Erste Schritte
68
68
 
69
- Wenn du Truthmark zunächst gegen ein anderes lokales Repository ausprobieren willst, bevor das Paket anderswo veröffentlicht ist:
69
+ Installiere Truthmark in dem Repository, das du initialisieren möchtest:
70
+
71
+ ```bash
72
+ cd /path/to/your-repo
73
+ npm install -g truthmark
74
+ truthmark config
75
+ truthmark init
76
+ truthmark check
77
+ ```
78
+
79
+ Wenn du stattdessen unveröffentlichte Änderungen aus einem Source-Checkout ausprobieren möchtest:
70
80
 
71
81
  ```bash
72
82
  cd /path/to/truthmark
@@ -90,15 +100,13 @@ docs/features/repository/README.md
90
100
  docs/features/repository/overview.md
91
101
  AGENTS.md
92
102
  CLAUDE.md
93
- skills/truthmark-structure/SKILL.md
94
- skills/truthmark-sync/SKILL.md
95
- skills/truthmark-realize/SKILL.md
96
- skills/truthmark-check/SKILL.md
97
103
  ```
98
104
 
99
- Wenn du zusätzliche Plattformen in `.truthmark/config.yml` aktivierst, aktualisiert Truthmark die entsprechenden verwalteten Flächen beim nächsten `init`.
105
+ Unterstützte Plattformen sind `codex`, `opencode`, `claude-code`, `github-copilot` und `gemini-cli`. Die Standardkonfiguration enthält alle davon; entferne Plattformen, die du nicht nutzt, aus `.truthmark/config.yml`, bevor du `truthmark init` erneut ausführst.
100
106
  Die standardmäßig erzeugte Struktur verwendet `README.md`-Dateien von Features als Indizes und beginnt die Wahrheit über aktuelles Verhalten in begrenzten Blattdokumenten wie `docs/features/repository/overview.md`.
101
107
 
108
+ Bestehende Repositories brauchen nach `init` meist einen Aufräumschritt: Führe den installierten Truth-Structure-Workflow aus, wenn die erzeugte `repository`-Route zu breit ist, Ownership mehrere Produkte oder Services umfasst oder Routendateien noch auf Platzhalterdokumente zeigen. Truth Structure teilt breite Routings auf, erstellt oder repariert erste kanonische Wahrheitsdokumente und gibt Truth Sync präzise Ziele, bevor funktionale Codearbeit beginnt. Codex, Claude Code und unterstützte Copilot-IDEs können ihn mit `/truthmark-structure` aufrufen; Hosts im OpenCode-Stil können `/skill truthmark-structure` verwenden.
109
+
102
110
  ## Wie es läuft
103
111
 
104
112
  Truthmark legt nicht fest, welcher Subagent Truth Sync ausführen soll. Der handelnde Agent und die Host-Umgebung entscheiden, ob delegiert oder der Workflow inline ausgeführt wird.
@@ -113,7 +121,7 @@ Arbeit committen oder übergeben
113
121
  ```
114
122
 
115
123
  Truth Sync ist code-first: Code führt, Wahrheitsdokumente folgen, und Truth Sync darf funktionalen Code nicht umschreiben. Seine Hauptaufgabe ist eine automatische Abschlusskontrolle, wenn funktionaler Code geändert wurde. Direkte Aufrufe sind vor allem für Fehlersuche, frühe Synchronisierung vor einer Übergabe oder bewusstes Ausführen des Workflows gedacht.
116
- Codex-Nutzer können es mit `/truthmark-sync` oder `$truthmark-sync` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-sync` verwenden.
124
+ Codex, Claude Code und unterstützte Copilot-IDEs können es mit `/truthmark-sync` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-sync` verwenden.
117
125
  Nutze diesen Ablauf, wenn eine Produkt- oder Architekturentscheidung in der Dokumentation beginnt:
118
126
 
119
127
  ```text
@@ -126,7 +134,7 @@ Arbeit committen oder übergeben
126
134
  ```
127
135
 
128
136
  Truth Realize ist manuell und doc-first: Wahrheitsdokumente führen, Code folgt, und der Agent darf die Wahrheitsdokumente, die er realisiert, nicht bearbeiten.
129
- Codex-Nutzer können es mit `/truthmark-realize` oder `$truthmark-realize` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-realize` verwenden.
137
+ Codex, Claude Code und unterstützte Copilot-IDEs können es mit `/truthmark-realize` aufrufen. Hosts im OpenCode-Stil können `/skill truthmark-realize` verwenden.
130
138
 
131
139
  ## Was es installiert
132
140
 
@@ -136,8 +144,8 @@ Truthmark hält die dauerhafte Workflow-Fläche klein:
136
144
  - `TRUTHMARK.md` für den branch-lokalen Workflow-Vertrag
137
145
  - `docs/truthmark/areas.md` für den Root-Routenindex
138
146
  - `docs/truthmark/areas/**/*.md` für delegierte untergeordnete Routendateien
139
- - verwaltete Instruktionsblöcke für konfigurierte Plattformen wie `AGENTS.md`, `CLAUDE.md`, Cursor-Regeln, Copilot-Anweisungen und `GEMINI.md`
140
- - Codex- und repo-lokale Skills für Truth Structure, Truth Sync, Truth Realize und Truth Check
147
+ - verwaltete Instruktionsblöcke für konfigurierte Plattformen wie `AGENTS.md`, `CLAUDE.md`, Copilot-Anweisungen und `GEMINI.md`
148
+ - host-native Skills, Prompts oder Commands für Truth Structure, Truth Sync, Truth Realize und Truth Check
141
149
 
142
150
  Die installierten Workflow-Flächen sind die Runtime:
143
151
 
@@ -194,8 +202,6 @@ V1 bietet derzeit:
194
202
  - Branch-Scope-Metadaten
195
203
  - Diagnostik für Konfiguration, Autorität, Routing, Entscheidungsstruktur, Frontmatter, Links und polyglotte Abdeckung
196
204
 
197
- Es wird nicht angenommen, dass das ungescopte Paket `truthmark` bereits veröffentlicht ist.
198
-
199
205
  ## Dokumentation
200
206
 
201
207
  Die Root-README ist für Menschen gedacht, die das Paket evaluieren und ausprobieren. Detaillierte funktionale und geschäftliche Spezifikationen liegen unter `docs/`:
package/README.es.md CHANGED
@@ -66,7 +66,17 @@ Esta es la promesa central: el contexto del agente pasa a ser estado confirmado
66
66
 
67
67
  ## Primeros pasos
68
68
 
69
- Para probar Truthmark contra otro repositorio local antes de que el paquete se publique en otro lugar:
69
+ Instala Truthmark en el repositorio que quieras inicializar:
70
+
71
+ ```bash
72
+ cd /path/to/your-repo
73
+ npm install -g truthmark
74
+ truthmark config
75
+ truthmark init
76
+ truthmark check
77
+ ```
78
+
79
+ Si quieres probar cambios aún no publicados desde un checkout del código fuente:
70
80
 
71
81
  ```bash
72
82
  cd /path/to/truthmark
@@ -90,15 +100,13 @@ docs/features/repository/README.md
90
100
  docs/features/repository/overview.md
91
101
  AGENTS.md
92
102
  CLAUDE.md
93
- skills/truthmark-structure/SKILL.md
94
- skills/truthmark-sync/SKILL.md
95
- skills/truthmark-realize/SKILL.md
96
- skills/truthmark-check/SKILL.md
97
103
  ```
98
104
 
99
- Si habilitas plataformas adicionales en `.truthmark/config.yml`, Truthmark actualizará las superficies administradas correspondientes en el siguiente `init`.
105
+ Las plataformas compatibles son `codex`, `opencode`, `claude-code`, `github-copilot` y `gemini-cli`. La configuración predeterminada las incluye todas; elimina de `.truthmark/config.yml` las plataformas que no uses antes de volver a ejecutar `truthmark init`.
100
106
  La estructura generada por defecto usa los `README.md` de funciones como índices y empieza la verdad sobre el comportamiento actual en documentos hoja acotados, como `docs/features/repository/overview.md`.
101
107
 
108
+ Los repositorios existentes suelen necesitar una pasada de limpieza después de `init`: ejecuta el flujo instalado Truth Structure cuando la ruta `repository` generada sea demasiado amplia, la propiedad abarque varios productos o servicios, o los archivos de rutas sigan apuntando a documentos de marcador de posición. Truth Structure divide rutas amplias, crea o repara documentos de verdad canónica iniciales y da a Truth Sync destinos precisos antes de que empiece el trabajo de código funcional. Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-structure`; los hosts de estilo OpenCode pueden usar `/skill truthmark-structure`.
109
+
102
110
  ## Cómo se ejecuta
103
111
 
104
112
  Truthmark no especifica qué subagente debe ejecutar Truth Sync. El agente que actúa y el entorno anfitrión deciden si delegan o ejecutan el flujo en línea.
@@ -113,7 +121,7 @@ se confirma o se entrega el trabajo
113
121
  ```
114
122
 
115
123
  Truth Sync es code-first: el código lidera, los documentos de verdad siguen, y Truth Sync no debe reescribir código funcional. Su tarea principal es actuar como salvaguarda automática al cierre cuando cambió código funcional. La invocación directa se usa sobre todo para depurar, forzar una sincronización temprana antes de entregar el trabajo o ejecutar el flujo de forma intencional.
116
- Los usuarios de Codex pueden invocarlo con `/truthmark-sync` o `$truthmark-sync`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-sync`.
124
+ Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-sync`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-sync`.
117
125
  Usa este flujo cuando una decisión de producto o arquitectura empieza en la documentación:
118
126
 
119
127
  ```text
@@ -126,7 +134,7 @@ se confirma o se entrega el trabajo
126
134
  ```
127
135
 
128
136
  Truth Realize es manual y doc-first: los documentos de verdad lideran, el código sigue, y el agente no debe editar los documentos de verdad que está realizando.
129
- Los usuarios de Codex pueden invocarlo con `/truthmark-realize` o `$truthmark-realize`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-realize`.
137
+ Codex, Claude Code y los IDEs de Copilot compatibles pueden invocarlo con `/truthmark-realize`. Los hosts de estilo OpenCode pueden usar `/skill truthmark-realize`.
130
138
 
131
139
  ## Qué instala
132
140
 
@@ -136,8 +144,8 @@ Truthmark mantiene pequeña la superficie duradera de flujo de trabajo:
136
144
  - `TRUTHMARK.md` para el contrato de flujo de trabajo local a la rama
137
145
  - `docs/truthmark/areas.md` para el índice raíz de rutas
138
146
  - `docs/truthmark/areas/**/*.md` para archivos de rutas secundarias delegadas
139
- - bloques de instrucciones administrados para plataformas configuradas como `AGENTS.md`, `CLAUDE.md`, reglas de Cursor, instrucciones de Copilot y `GEMINI.md`
140
- - skills locales del repositorio y de Codex para Truth Structure, Truth Sync, Truth Realize y Truth Check
147
+ - bloques de instrucciones administrados para plataformas configuradas como `AGENTS.md`, `CLAUDE.md`, instrucciones de Copilot y `GEMINI.md`
148
+ - skills, prompts o comandos nativos del host para Truth Structure, Truth Sync, Truth Realize y Truth Check
141
149
 
142
150
  Las superficies de flujo de trabajo instaladas son el entorno de ejecución:
143
151
 
@@ -194,8 +202,6 @@ V1 actualmente ofrece:
194
202
  - metadatos de alcance de rama
195
203
  - diagnósticos de configuración, autoridad, enrutamiento, estructura de decisiones, frontmatter, enlaces y cobertura políglota
196
204
 
197
- No se debe asumir que el paquete sin scope `truthmark` ya está publicado.
198
-
199
205
  ## Documentación
200
206
 
201
207
  El README raíz es para personas que evalúan y prueban el paquete. Las especificaciones funcionales y de negocio detalladas viven en `docs/`:
package/README.md CHANGED
@@ -4,6 +4,8 @@
4
4
 
5
5
  English | [Deutsch](README.de.md) | [中文](README.zh.md) | [Español](README.es.md) | [Русский](README.ru.md)
6
6
 
7
+ ![Truthmark overview](docs/assets/truthmark-overview.png)
8
+
7
9
  AI coding agents are already good at writing code. They are still bad at reliably reconstructing product intent, architecture boundaries, and repository ownership from stale docs, scattered chats, and ephemeral tool memory.
8
10
 
9
11
  Truthmark fixes that by turning branch-local repository truth into a first-class runtime surface for agents. It installs a Git-native, branch-scoped truth layer directly inside the repo, gives agents explicit routing and workflow boundaries, and makes that truth move with the code that actually ships.
@@ -34,12 +36,12 @@ For tech leads, the value is governance without theater: tests, code review, and
34
36
 
35
37
  Truthmark is not trying to replace every other AI workflow tool. It sits in a specific layer of the stack:
36
38
 
37
- | If you need | Best fit |
38
- | --- | --- |
39
- | Better results from a single coding session | Better prompts and tighter task framing |
40
- | Convenience across sessions for one agent or one operator | Memory tools |
41
- | Spec-first planning for new features | Spec tools such as Spec Kit |
42
- | Branch-scoped, reviewable repository truth that travels with the code | Truthmark |
39
+ | If you need | Best fit |
40
+ | --------------------------------------------------------------------- | --------------------------------------- |
41
+ | Better results from a single coding session | Better prompts and tighter task framing |
42
+ | Convenience across sessions for one agent or one operator | Memory tools |
43
+ | Spec-first planning for new features | Spec tools such as Spec Kit |
44
+ | Branch-scoped, reviewable repository truth that travels with the code | Truthmark |
43
45
 
44
46
  The point is not that prompts, memory, or specs are useless. The point is that none of them, by themselves, turn repository truth into a committed, inspectable asset that survives handoffs, review, and branch divergence.
45
47
 
@@ -72,7 +74,17 @@ This is the core promise: agent context becomes committed repository state inste
72
74
 
73
75
  ## Get started
74
76
 
75
- To try Truthmark from a source checkout instead of the published npm package:
77
+ Install Truthmark in the repository you want to initialize:
78
+
79
+ ```bash
80
+ cd /path/to/your-repo
81
+ npm install -g truthmark
82
+ truthmark config
83
+ truthmark init
84
+ truthmark check
85
+ ```
86
+
87
+ If you want to try unreleased changes from a source checkout instead:
76
88
 
77
89
  ```bash
78
90
  cd /path/to/truthmark
@@ -97,20 +109,18 @@ docs/features/repository/README.md
97
109
  docs/features/repository/overview.md
98
110
  AGENTS.md
99
111
  CLAUDE.md
100
- skills/truthmark-structure/SKILL.md
101
- skills/truthmark-sync/SKILL.md
102
- skills/truthmark-realize/SKILL.md
103
- skills/truthmark-check/SKILL.md
104
112
  ```
105
113
 
106
- If you enable additional platforms in `.truthmark/config.yml`, Truthmark refreshes the corresponding managed surfaces on the next `init`.
114
+ Supported platforms are `codex`, `opencode`, `claude-code`, `github-copilot`, and `gemini-cli`. The default config includes all of them; remove platforms you do not use from `.truthmark/config.yml` before rerunning `truthmark init`.
107
115
 
108
116
  The default scaffold keeps feature `README.md` files as indexes and starts current behavior truth in bounded leaf docs such as `docs/features/repository/overview.md`.
109
117
 
110
- Truthmark does not specify which subagent should run Truth Sync. The acting agent and host environment decide whether to delegate or run the workflow inline.
118
+ Existing repositories usually need one cleanup pass after `init`: run the installed Truth Structure workflow when the generated `repository` route is too broad, ownership spans multiple products or services, or route files still point at placeholder docs. Truth Structure splits broad routing, creates or repairs starter canonical truth docs, and gives Truth Sync precise destinations before functional-code work begins. Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-structure`; OpenCode-style hosts can invoke `/skill truthmark-structure`.
111
119
 
112
120
  ## How it runs
113
121
 
122
+ Truthmark does not specify which subagent should run Truth Sync. The acting agent and host environment decide whether to delegate or run the workflow inline.
123
+
114
124
  ### Normal code changes
115
125
 
116
126
  Most users should not need to invoke Truth Sync directly. The normal path is:
@@ -125,7 +135,7 @@ commit or hand off the work
125
135
 
126
136
  Truth Sync is code-first: code leads, truth docs follow, and Truth Sync must not rewrite functional code. Its main job is to act as an automatic finish-time safeguard when functional code changed. Direct invocation is mainly for troubleshooting, forcing an early sync before handoff, or running the workflow intentionally.
127
137
 
128
- Codex users can invoke it with `/truthmark-sync` or `$truthmark-sync`. OpenCode-style hosts can invoke `/skill truthmark-sync`.
138
+ Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-sync`. OpenCode-style hosts can invoke `/skill truthmark-sync`.
129
139
 
130
140
  ### Doc-first changes
131
141
 
@@ -142,7 +152,7 @@ commit or hand off the work
142
152
 
143
153
  Truth Realize is manual and doc-first: truth docs lead, code follows, and the agent must not edit the truth docs it is realizing.
144
154
 
145
- Codex users can invoke it with `/truthmark-realize` or `$truthmark-realize`. OpenCode-style hosts can invoke `/skill truthmark-realize`.
155
+ Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-realize`. OpenCode-style hosts can invoke `/skill truthmark-realize`.
146
156
 
147
157
  ## What it installs
148
158
 
@@ -152,8 +162,8 @@ Truthmark keeps the durable workflow surface small:
152
162
  - `TRUTHMARK.md` for the branch-local workflow contract
153
163
  - `docs/truthmark/areas.md` for the root route index
154
164
  - `docs/truthmark/areas/**/*.md` for delegated child route files
155
- - managed instruction blocks for configured platforms such as `AGENTS.md`, `CLAUDE.md`, Cursor rules, Copilot instructions, and `GEMINI.md`
156
- - Codex and repo-local skills for Truth Structure, Truth Sync, Truth Realize, and Truth Check
165
+ - managed instruction blocks for configured platforms such as `AGENTS.md`, `CLAUDE.md`, Copilot instructions, and `GEMINI.md`
166
+ - host-native skills, prompts, or commands for Truth Structure, Truth Sync, Truth Realize, and Truth Check
157
167
 
158
168
  The installed workflow surfaces are the runtime:
159
169
 
@@ -186,6 +196,8 @@ truthmark check --json
186
196
 
187
197
  Truth Structure, Truth Sync, Truth Realize, and Truth Check are installed agent workflows, not top-level daily CLI commands.
188
198
 
199
+ They run through the configured agent host surfaces, for example Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*`, or Gemini `/truthmark:*`.
200
+
189
201
  ## Why it exists
190
202
 
191
203
  Most AI coding workflows optimize for the next answer. Truthmark optimizes for the next handoff.
package/README.ru.md CHANGED
@@ -66,7 +66,17 @@ Truthmark превращает истину репозитория в явную
66
66
 
67
67
  ## Начало работы
68
68
 
69
- Чтобы попробовать Truthmark на другом локальном репозитории до публикации пакета где-либо еще:
69
+ Установите Truthmark в репозитории, который хотите инициализировать:
70
+
71
+ ```bash
72
+ cd /path/to/your-repo
73
+ npm install -g truthmark
74
+ truthmark config
75
+ truthmark init
76
+ truthmark check
77
+ ```
78
+
79
+ Если вы хотите попробовать еще не выпущенные изменения из исходного checkout:
70
80
 
71
81
  ```bash
72
82
  cd /path/to/truthmark
@@ -90,15 +100,13 @@ docs/features/repository/README.md
90
100
  docs/features/repository/overview.md
91
101
  AGENTS.md
92
102
  CLAUDE.md
93
- skills/truthmark-structure/SKILL.md
94
- skills/truthmark-sync/SKILL.md
95
- skills/truthmark-realize/SKILL.md
96
- skills/truthmark-check/SKILL.md
97
103
  ```
98
104
 
99
- Если вы включите дополнительные платформы в `.truthmark/config.yml`, Truthmark обновит соответствующие управляемые поверхности при следующем `init`.
105
+ Поддерживаемые платформы: `codex`, `opencode`, `claude-code`, `github-copilot` и `gemini-cli`. Конфигурация по умолчанию включает их все; удалите из `.truthmark/config.yml` платформы, которыми не пользуетесь, перед повторным запуском `truthmark init`.
100
106
  Стандартная шаблонная структура использует `README.md` функциональных разделов как индексы и начинает описывать истину текущего поведения в ограниченных листовых документах, например `docs/features/repository/overview.md`.
101
107
 
108
+ Существующим репозиториям обычно нужен один этап очистки после `init`: запустите установленный рабочий процесс Truth Structure, если созданный маршрут `repository` слишком широкий, владение охватывает несколько продуктов или сервисов, либо файлы маршрутов все еще указывают на документы-заглушки. Truth Structure разделяет широкие маршруты, создает или исправляет начальные канонические документы истины и дает Truth Sync точные цели до начала работы с функциональным кодом. Codex, Claude Code и поддерживаемые IDE Copilot могут вызвать его через `/truthmark-structure`; хосты в стиле OpenCode могут использовать `/skill truthmark-structure`.
109
+
102
110
  ## Как он работает
103
111
 
104
112
  Truthmark не задает, какой именно подагент должен запускать Truth Sync. Действующий агент и среда хоста сами решают, делегировать работу или выполнить процесс на месте.
@@ -113,7 +121,7 @@ Truth Sync срабатывает до завершения работы аге
113
121
  ```
114
122
 
115
123
  Truth Sync работает по принципу code-first: сначала идет код, затем документы истины, и Truth Sync не должен переписывать функциональный код. Его основная задача быть автоматической финальной проверкой, когда менялся функциональный код. Прямой вызов нужен в основном для отладки, ранней синхронизации перед передачей работы или намеренного запуска рабочего процесса.
116
- Пользователи Codex могут вызывать его через `/truthmark-sync` или `$truthmark-sync`. Хосты в стиле OpenCode могут использовать `/skill truthmark-sync`.
124
+ Codex, Claude Code и поддерживаемые IDE Copilot могут вызывать его через `/truthmark-sync`. Хосты в стиле OpenCode могут использовать `/skill truthmark-sync`.
117
125
  Используйте этот путь, когда продуктовое или архитектурное решение начинается в документации:
118
126
 
119
127
  ```text
@@ -126,7 +134,7 @@ Truth Sync работает по принципу code-first: сначала и
126
134
  ```
127
135
 
128
136
  Truth Realize это ручной процесс по принципу doc-first: документы истины идут первыми, код следует за ними, и агент не должен редактировать документы истины, которые он реализует.
129
- Пользователи Codex могут вызывать его через `/truthmark-realize` или `$truthmark-realize`. Хосты в стиле OpenCode могут использовать `/skill truthmark-realize`.
137
+ Codex, Claude Code и поддерживаемые IDE Copilot могут вызывать его через `/truthmark-realize`. Хосты в стиле OpenCode могут использовать `/skill truthmark-realize`.
130
138
 
131
139
  ## Что он устанавливает
132
140
 
@@ -136,8 +144,8 @@ Truthmark намеренно держит постоянную рабочую п
136
144
  - `TRUTHMARK.md` для контракта рабочего процесса, локального для ветки
137
145
  - `docs/truthmark/areas.md` для корневого индекса маршрутов
138
146
  - `docs/truthmark/areas/**/*.md` для делегированных дочерних файлов маршрутов
139
- - управляемые блоки инструкций для настроенных платформ, таких как `AGENTS.md`, `CLAUDE.md`, правила Cursor, инструкции Copilot и `GEMINI.md`
140
- - Codex- и repo-local skills для Truth Structure, Truth Sync, Truth Realize и Truth Check
147
+ - управляемые блоки инструкций для настроенных платформ, таких как `AGENTS.md`, `CLAUDE.md`, инструкции Copilot и `GEMINI.md`
148
+ - нативные для хоста skills, prompts или commands для Truth Structure, Truth Sync, Truth Realize и Truth Check
141
149
 
142
150
  Установленные рабочие поверхности и есть среда выполнения:
143
151
 
@@ -194,8 +202,6 @@ V1 сейчас предоставляет:
194
202
  - метаданные области ветки
195
203
  - диагностика конфигурации, полномочий, маршрутизации, структуры решений, frontmatter, ссылок и полиглотного покрытия
196
204
 
197
- Не следует считать, что пакет `truthmark` без scope уже опубликован.
198
-
199
205
  ## Документация
200
206
 
201
207
  Корневой README предназначен для людей, которые оценивают и пробуют пакет. Подробные функциональные и бизнес-спецификации находятся в `docs/`:
package/README.zh.md CHANGED
@@ -66,7 +66,17 @@ Truthmark 把仓库事实变成代理可见的显式工作流载体：
66
66
 
67
67
  ## 快速开始
68
68
 
69
- 如果想在包发布到其他地方之前，先在另一个本地仓库试用 Truthmark：
69
+ 在你想初始化的仓库中安装 Truthmark：
70
+
71
+ ```bash
72
+ cd /path/to/your-repo
73
+ npm install -g truthmark
74
+ truthmark config
75
+ truthmark init
76
+ truthmark check
77
+ ```
78
+
79
+ 如果你想从源码检出中试用尚未发布的变更：
70
80
 
71
81
  ```bash
72
82
  cd /path/to/truthmark
@@ -90,15 +100,13 @@ docs/features/repository/README.md
90
100
  docs/features/repository/overview.md
91
101
  AGENTS.md
92
102
  CLAUDE.md
93
- skills/truthmark-structure/SKILL.md
94
- skills/truthmark-sync/SKILL.md
95
- skills/truthmark-realize/SKILL.md
96
- skills/truthmark-check/SKILL.md
97
103
  ```
98
104
 
99
- 如果你在 `.truthmark/config.yml` 中启用更多平台，Truthmark 会在下一次 `init` 时刷新对应的受管载体。
105
+ 支持的平台是 `codex`、`opencode`、`claude-code`、`github-copilot` 和 `gemini-cli`。默认配置包含全部平台；请先从 `.truthmark/config.yml` 中移除不使用的平台，再重新运行 `truthmark init`。
100
106
  默认脚手架把功能 `README.md` 作为索引，并把当前行为事实放在有边界的叶子文档中，例如 `docs/features/repository/overview.md`。
101
107
 
108
+ 现有仓库通常需要在 `init` 之后做一次清理：当生成的 `repository` 路由过宽、所有权跨越多个产品或服务，或路由文件仍指向占位文档时，运行已安装的 Truth Structure 工作流。Truth Structure 会拆分过宽的路由，创建或修复初始的规范事实文档，并在功能代码工作开始前为 Truth Sync 提供精确目标。Codex、Claude Code 和支持的 Copilot IDE 可以用 `/truthmark-structure` 调用它；OpenCode 风格的宿主可以用 `/skill truthmark-structure` 调用它。
109
+
102
110
  ## 它如何运行
103
111
 
104
112
  Truthmark 不规定应该由哪个子代理运行 Truth Sync。由实际执行的代理和宿主环境决定是委托执行，还是内联运行工作流。
@@ -113,7 +121,7 @@ Truthmark 不规定应该由哪个子代理运行 Truth Sync。由实际执行
113
121
  ```
114
122
 
115
123
  Truth Sync 是 code-first：代码在前，事实文档跟随，且 Truth Sync 不能重写功能代码。它的主要职责是在功能代码发生变化时，作为收尾阶段的自动安全检查。直接调用主要用于排查问题、交接前提前同步，或有意运行这套工作流。
116
- Codex 用户可以用 `/truthmark-sync` 或 `$truthmark-sync` 调用它。OpenCode 风格的宿主可以用 `/skill truthmark-sync` 调用它。
124
+ Codex、Claude Code 和支持的 Copilot IDE 可以用 `/truthmark-sync` 调用它。OpenCode 风格的宿主可以用 `/skill truthmark-sync` 调用它。
117
125
  当产品或架构决策从文档开始时，使用这个流程：
118
126
 
119
127
  ```text
@@ -126,7 +134,7 @@ Codex 用户可以用 `/truthmark-sync` 或 `$truthmark-sync` 调用它。OpenCo
126
134
  ```
127
135
 
128
136
  Truth Realize 是手动、文档优先的流程：事实文档在前，代码跟随，代理不能编辑它正在实现的事实文档。
129
- Codex 用户可以用 `/truthmark-realize` 或 `$truthmark-realize` 调用它。OpenCode 风格的宿主可以用 `/skill truthmark-realize` 调用它。
137
+ Codex、Claude Code 和支持的 Copilot IDE 可以用 `/truthmark-realize` 调用它。OpenCode 风格的宿主可以用 `/skill truthmark-realize` 调用它。
130
138
 
131
139
  ## 它会安装什么
132
140
 
@@ -136,8 +144,8 @@ Truthmark 把持久化的工作流载体保持得很小：
136
144
  - `TRUTHMARK.md`，用于分支内工作流契约
137
145
  - `docs/truthmark/areas.md`，用于根路由索引
138
146
  - `docs/truthmark/areas/**/*.md`，用于委托的子路由文件
139
- - 面向已配置平台的受管说明块，例如 `AGENTS.md`、`CLAUDE.md`、Cursor 规则、Copilot 指令和 `GEMINI.md`
140
- - 面向 Truth Structure、Truth Sync、Truth Realize 和 Truth Check 的 Codex 技能与仓库本地技能
147
+ - 面向已配置平台的受管说明块，例如 `AGENTS.md`、`CLAUDE.md`、Copilot 指令和 `GEMINI.md`
148
+ - 面向 Truth Structure、Truth Sync、Truth Realize 和 Truth Check 的宿主原生技能、提示或命令
141
149
 
142
150
  安装后的工作流载体就是运行时：
143
151
 
@@ -194,8 +202,6 @@ V1 目前提供：
194
202
  - 分支范围元数据
195
203
  - 配置、权限边界、路由、决策结构、frontmatter、链接和多语言覆盖率诊断
196
204
 
197
- 不要假定未带 scope 的 `truthmark` 包已经发布。
198
-
199
205
  ## 文档
200
206
 
201
207
  根 README 面向评估和试用这个包的人。详细的功能和业务规范位于 `docs/` 下：