truthmark 1.2.3 → 1.4.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 +104 -48
- package/README.es.md +98 -42
- package/README.md +54 -39
- package/README.ru.md +97 -41
- package/README.zh.md +95 -39
- package/dist/main.js +3960 -962
- package/dist/main.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Truthmark
|
|
3
|
+
**Truthmark installs repository truth workflows for AI software development.**
|
|
4
4
|
|
|
5
5
|
English | [Deutsch](README.de.md) | [中文](README.zh.md) | [Español](README.es.md) | [Русский](README.ru.md)
|
|
6
6
|
|
|
@@ -8,14 +8,14 @@ English | [Deutsch](README.de.md) | [中文](README.zh.md) | [Español](README.e
|
|
|
8
8
|
|
|
9
9
|
AI coding agents already write code fast. The expensive part is keeping repository truth aligned with what changed.
|
|
10
10
|
|
|
11
|
-
Truthmark adds
|
|
11
|
+
Truthmark adds a finish-time workflow guard to that workflow. The normal path is simple:
|
|
12
12
|
|
|
13
13
|
- agent changes functional code
|
|
14
14
|
- run relevant tests
|
|
15
|
-
- Truth Sync updates mapped truth docs before the agent finishes
|
|
15
|
+
- the installed Truth Sync workflow updates mapped truth docs before the agent finishes
|
|
16
16
|
- review the truth-doc diff if one was produced
|
|
17
17
|
|
|
18
|
-
Most tools ask teams to adopt a habit. Truthmark
|
|
18
|
+
Most tools ask teams to adopt a habit. Truthmark turns the habit into repository workflow infrastructure.
|
|
19
19
|
|
|
20
20
|
Truthmark turns an AI workflow into repo infrastructure, not personal tooling. It installs a Git-native, branch-scoped truth layer inside the repository, gives agents explicit routing and bounded workflow surfaces, and keeps that truth reviewable in Git instead of scattering it across prompt history, stale docs, or private tool memory.
|
|
21
21
|
|
|
@@ -51,12 +51,12 @@ For teams who already know agents can generate code, Truthmark answers the next
|
|
|
51
51
|
|
|
52
52
|
Truthmark is not trying to make agents sound smarter. It is trying to make AI-assisted repository change easier to trust.
|
|
53
53
|
|
|
54
|
-
-
|
|
54
|
+
- Installed Truth Sync after code changes turns documentation maintenance into a workflow safeguard instead of a team habit.
|
|
55
55
|
- Branch-scoped truth moves with the code, so reviewers can inspect current truth in ordinary Git diffs.
|
|
56
56
|
- Repository-native workflow surfaces make rollout lighter and handoffs more resilient than per-user setup alone.
|
|
57
57
|
- Explicit routing in `docs/truthmark/areas.md` and delegated child route files gives agents ownership boundaries and safer write paths.
|
|
58
58
|
- Local-first operation avoids a daemon, database, remote service, or MCP dependency.
|
|
59
|
-
- The model
|
|
59
|
+
- The routing model is language-agnostic, with coverage diagnostics for common JavaScript, TypeScript, Go, Python, C#, and Java code surfaces.
|
|
60
60
|
|
|
61
61
|
For tech leads, the value is governance without extra infrastructure: tests, code review, and ownership still do the real work; Truthmark makes the agent's context durable, inspectable, and branch-scoped.
|
|
62
62
|
|
|
@@ -96,6 +96,7 @@ Truthmark turns repository truth into an explicit workflow surface for agents:
|
|
|
96
96
|
- `docs/truthmark/areas.md` and delegated child route files map code areas to the docs that own them.
|
|
97
97
|
- Truth Document generates or repairs canonical truth docs for existing implemented behavior when no code change is needed.
|
|
98
98
|
- Truth Sync keeps mapped truth docs aligned with functional changes.
|
|
99
|
+
- Truth Preview previews likely workflow routing before edits without authorizing writes.
|
|
99
100
|
- Truth Realize gives doc-first changes a bounded code-update path.
|
|
100
101
|
- `truthmark check` validates the resulting truth artifacts.
|
|
101
102
|
- The whole model stays local-first and Git-native.
|
|
@@ -133,10 +134,10 @@ Review `.truthmark/config.yml` before `init`; it is the committed hierarchy cont
|
|
|
133
134
|
.truthmark/config.yml
|
|
134
135
|
docs/truthmark/areas.md
|
|
135
136
|
docs/truthmark/areas/repository.md
|
|
136
|
-
docs/templates/
|
|
137
|
-
docs/
|
|
138
|
-
docs/
|
|
139
|
-
docs/
|
|
137
|
+
docs/templates/behavior-doc.md
|
|
138
|
+
docs/truth/README.md
|
|
139
|
+
docs/truth/repository/README.md
|
|
140
|
+
docs/truth/repository/overview.md
|
|
140
141
|
AGENTS.md
|
|
141
142
|
CLAUDE.md
|
|
142
143
|
GEMINI.md
|
|
@@ -144,7 +145,7 @@ GEMINI.md
|
|
|
144
145
|
|
|
145
146
|
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`.
|
|
146
147
|
|
|
147
|
-
The default scaffold keeps
|
|
148
|
+
The default scaffold keeps truth `README.md` files as indexes and starts current behavior truth in bounded leaf docs such as `docs/truth/repository/overview.md`.
|
|
148
149
|
|
|
149
150
|
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`.
|
|
150
151
|
|
|
@@ -171,22 +172,22 @@ review the truth-doc diff
|
|
|
171
172
|
Truth Document is manual and implementation-first: code is inspected as evidence, truth docs are created or repaired, and functional code must not be changed. Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-document`. OpenCode-style hosts can invoke `/skill truthmark-document`.
|
|
172
173
|
|
|
173
174
|
```text
|
|
174
|
-
/truthmark-document document the implemented session timeout behavior under docs/
|
|
175
|
+
/truthmark-document document the implemented session timeout behavior under docs/truth/authentication
|
|
175
176
|
```
|
|
176
177
|
|
|
177
178
|
### Normal code changes
|
|
178
179
|
|
|
179
|
-
Most users should not need to invoke Truth Sync directly. The important behavior is that Truth Sync
|
|
180
|
+
Most users should not need to invoke Truth Sync directly. The important behavior is that the installed agent workflow treats Truth Sync as a finish-time guard when functional code changed. The normal path is:
|
|
180
181
|
|
|
181
182
|
```text
|
|
182
183
|
agent changes functional code
|
|
183
184
|
run relevant tests
|
|
184
|
-
Truth Sync
|
|
185
|
+
the installed Truth Sync workflow runs before the agent finishes
|
|
185
186
|
review the truth-doc diff if one was produced
|
|
186
187
|
commit or hand off the work
|
|
187
188
|
```
|
|
188
189
|
|
|
189
|
-
Truth Sync is code-first: code leads, truth docs follow, and Truth Sync must not rewrite functional code. Its main job is to
|
|
190
|
+
Truth Sync is code-first: code leads, truth docs follow, and Truth Sync must not rewrite functional code. Its main job is to run through the installed agent workflow as a finish-time guard when functional code changed. Direct invocation is mainly for troubleshooting, forcing an early sync before handoff, or running the workflow intentionally.
|
|
190
191
|
|
|
191
192
|
Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-sync`. OpenCode-style hosts can invoke `/skill truthmark-sync`.
|
|
192
193
|
|
|
@@ -212,55 +213,65 @@ Truth Realize is manual and doc-first: truth docs lead, code follows, and the ag
|
|
|
212
213
|
Codex, Claude Code, and supported Copilot IDEs can invoke it with `/truthmark-realize`. OpenCode-style hosts can invoke `/skill truthmark-realize`.
|
|
213
214
|
|
|
214
215
|
```text
|
|
215
|
-
/truthmark-realize realize docs/
|
|
216
|
+
/truthmark-realize realize docs/truth/authentication/session-timeout.md into code
|
|
216
217
|
```
|
|
217
218
|
|
|
218
219
|
## What it installs
|
|
219
220
|
|
|
220
221
|
Truthmark keeps the durable workflow surface small and repository-native. After `truthmark init`, the repo itself carries the routing, rules, and installed workflow surfaces, so teams are not relying only on one operator's local setup.
|
|
221
222
|
|
|
222
|
-
|
|
223
|
-
|
|
223
|
+
Truthmark installs two distinct surfaces:
|
|
224
|
+
|
|
225
|
+
- human-facing CLI commands, run by people or CI to configure the repo, refresh installed files, validate truth artifacts, and optionally generate derived review context
|
|
226
|
+
- agent workflow surfaces, invoked by coding agents or agent hosts during implementation workflows; they are not extra daily terminal commands for humans
|
|
227
|
+
|
|
228
|
+
- `.truthmark/config.yml` for the machine-readable committed hierarchy contract
|
|
224
229
|
- `docs/truthmark/areas.md` for the root route index
|
|
225
230
|
- `docs/truthmark/areas/**/*.md` for delegated child route files
|
|
226
|
-
- `docs/templates/
|
|
231
|
+
- `docs/templates/behavior-doc.md` plus the other kind-specific templates under `docs/templates/` for the editable truth-doc standards used by generated workflows
|
|
227
232
|
- managed instruction blocks for configured platforms such as `AGENTS.md`, `CLAUDE.md`, Copilot instructions, and `GEMINI.md`
|
|
228
|
-
- host-native skills, prompts, or commands for Truth Structure, Truth Document, Truth Sync, Truth Realize, and Truth Check
|
|
233
|
+
- host-native skills, prompts, or commands for Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize, and Truth Check
|
|
234
|
+
- Codex, Claude Code, GitHub Copilot, and OpenCode project-scoped read-only verifiers plus leased `truth-doc-writer` agents where hosts support agents, under `.codex/agents/`, `.claude/agents/`, `.github/agents/`, and `.opencode/agents/` for workflow-owned audits and parent-leased doc shards
|
|
229
235
|
|
|
230
236
|
The installed workflow surfaces are the runtime:
|
|
231
237
|
|
|
232
238
|
- Truth Structure creates or repairs area routing and starter truth docs.
|
|
233
239
|
- Truth Document creates or repairs truth docs for existing implemented behavior.
|
|
234
240
|
- Truth Sync keeps mapped truth docs aligned with functional changes.
|
|
241
|
+
- Truth Preview previews likely workflow routing before edits without writing files.
|
|
235
242
|
- Truth Realize updates code to match truth docs.
|
|
236
243
|
- Truth Check audits repository truth health.
|
|
237
244
|
|
|
238
|
-
|
|
245
|
+
Truth `README.md` files are indexes. Truth Sync is expected to read and update bounded leaf docs for current behavior. Generated workflow surfaces preserve repository-rule authority while treating implementation code and canonical truth docs as evidence for current behavior.
|
|
239
246
|
|
|
240
247
|
Generated surfaces are managed by Truthmark, include a version marker, and may be refreshed by `truthmark init`.
|
|
241
248
|
|
|
242
249
|
## Commands
|
|
243
250
|
|
|
244
|
-
Truthmark V1
|
|
251
|
+
Truthmark V1 keeps the terminal CLI focused. Most human users only need setup, refresh, and validation:
|
|
245
252
|
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
truthmark
|
|
249
|
-
truthmark
|
|
250
|
-
truthmark
|
|
251
|
-
truthmark check --json
|
|
252
|
-
```
|
|
253
|
+
| Human-facing CLI | Use |
|
|
254
|
+
| ---------------- | --- |
|
|
255
|
+
| `truthmark config` | Create `.truthmark/config.yml`; writes only that file unless `--stdout` is used. |
|
|
256
|
+
| `truthmark init` | Install or refresh local workflow files from the reviewed config. |
|
|
257
|
+
| `truthmark check` | Validate configuration, authority, routing, decision-bearing docs, frontmatter, internal links, branch scope, and coverage diagnostics. |
|
|
253
258
|
|
|
254
|
-
|
|
259
|
+
The remaining CLI commands are optional repository-intelligence helpers. They generate derived review context for the active checkout; they are not sources of truth:
|
|
255
260
|
|
|
256
|
-
|
|
261
|
+
| Optional CLI | Use |
|
|
262
|
+
| ------------ | --- |
|
|
263
|
+
| `truthmark index` | Build RepoIndex and RouteMap JSON for the active checkout. |
|
|
264
|
+
| `truthmark impact --base <ref>` | Map changed files to routed truth docs, owning routes, nearby tests, and public symbols. |
|
|
265
|
+
| `truthmark context --workflow <workflow> [--base <ref>]` | Generate a bounded ContextPack for Truth Sync, Truth Document, or Truth Realize. `--format markdown` renders a human-readable pack. |
|
|
257
266
|
|
|
258
|
-
|
|
267
|
+
All CLI commands above support `--json` where structured output is useful for automation.
|
|
259
268
|
|
|
260
|
-
Truth Structure, Truth Document, Truth Sync, Truth Realize, and Truth Check are installed agent workflows, not top-level daily CLI commands.
|
|
269
|
+
Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize, and Truth Check are installed agent workflows, not top-level daily CLI commands.
|
|
261
270
|
|
|
262
271
|
They run through the configured agent host surfaces, for example Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*`, or Gemini `/truthmark:*`.
|
|
263
272
|
|
|
273
|
+
These invocations look command-like because agent hosts expose skills through slash commands. Treat them as instructions to an agent, not as terminal commands a human is expected to run.
|
|
274
|
+
|
|
264
275
|
```text
|
|
265
276
|
/truthmark-check audit routing and truth coverage before review
|
|
266
277
|
```
|
|
@@ -289,10 +300,14 @@ V1 currently provides:
|
|
|
289
300
|
- `truthmark config`
|
|
290
301
|
- `truthmark init`
|
|
291
302
|
- `truthmark check`
|
|
303
|
+
- `truthmark index`
|
|
304
|
+
- `truthmark impact`
|
|
305
|
+
- `truthmark context`
|
|
292
306
|
- managed `AGENTS.md` workflow instructions
|
|
293
|
-
- generated Truth Structure, Truth Document, Truth Sync, Truth Realize, and Truth Check skill surfaces for configured agent hosts
|
|
307
|
+
- generated Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize, and Truth Check skill surfaces for configured agent hosts
|
|
294
308
|
- branch-scope metadata
|
|
295
|
-
- config, authority, routing, decision-structure, frontmatter, link, and polyglot coverage diagnostics
|
|
309
|
+
- config, authority, routing, decision-structure, frontmatter, link, freshness, and polyglot coverage diagnostics
|
|
310
|
+
- derived RepoIndex, RouteMap, ImpactSet, and ContextPack artifacts for faster local review when the CLI is available
|
|
296
311
|
|
|
297
312
|
## Documentation
|
|
298
313
|
|
|
@@ -300,10 +315,10 @@ The root README is for people evaluating and trying the package. Detailed functi
|
|
|
300
315
|
|
|
301
316
|
- [Docs index](docs/README.md)
|
|
302
317
|
- [Architecture overview](docs/architecture/overview.md)
|
|
303
|
-
- [API and CLI contracts](docs/
|
|
304
|
-
- [Init and scaffold behavior](docs/
|
|
305
|
-
- [Check diagnostics](docs/
|
|
306
|
-
- [Installed workflows](docs/
|
|
318
|
+
- [API and CLI contracts](docs/truth/contracts.md)
|
|
319
|
+
- [Init and scaffold behavior](docs/truth/init-and-scaffold.md)
|
|
320
|
+
- [Check diagnostics](docs/truth/check-diagnostics.md)
|
|
321
|
+
- [Installed workflows](docs/truth/workflows/overview.md)
|
|
307
322
|
- [Repository truth maintenance guide](docs/standards/maintaining-repository-truth.md)
|
|
308
323
|
|
|
309
324
|
Current behavior belongs in the canonical docs tree above.
|
package/README.ru.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Truthmark
|
|
3
|
+
**Truthmark устанавливает рабочие процессы истины репозитория для разработки ПО с ИИ.**
|
|
4
4
|
|
|
5
5
|
[English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | [Español](README.es.md) | Русский
|
|
6
6
|
|
|
@@ -8,14 +8,14 @@
|
|
|
8
8
|
|
|
9
9
|
ИИ-агенты уже быстро пишут код. Дорогая часть — удерживать истину репозитория в соответствии с тем, что реально изменилось.
|
|
10
10
|
|
|
11
|
-
Truthmark добавляет в этот процесс
|
|
11
|
+
Truthmark добавляет в этот процесс финальную защиту на уровне рабочего процесса. Обычный путь прост:
|
|
12
12
|
|
|
13
13
|
- агент меняет функциональный код
|
|
14
14
|
- запускаются релевантные тесты
|
|
15
|
-
- Truth Sync обновляет связанные документы истины до завершения работы агента
|
|
15
|
+
- установленный рабочий процесс Truth Sync обновляет связанные документы истины до завершения работы агента
|
|
16
16
|
- если был создан diff документов истины, его проверяют
|
|
17
17
|
|
|
18
|
-
Большинство инструментов просит команды выработать привычку. Truthmark
|
|
18
|
+
Большинство инструментов просит команды выработать привычку. Truthmark превращает эту привычку в инфраструктуру рабочего процесса репозитория.
|
|
19
19
|
|
|
20
20
|
Truthmark превращает ИИ-процесс в инфраструктуру репозитория, а не в персональный инструмент. Он устанавливает Git-native слой истины внутри репозитория, задает агентам явную маршрутизацию и ограниченные рабочие поверхности и сохраняет эту истину проверяемой в Git вместо того, чтобы разносить ее по истории промптов, устаревшей документации или приватному состоянию инструментов.
|
|
21
21
|
|
|
@@ -51,12 +51,12 @@ Truthmark превращает ИИ-процесс в инфраструктур
|
|
|
51
51
|
|
|
52
52
|
Truthmark не пытается сделать так, чтобы агенты звучали умнее. Он пытается сделать изменения в репозитории, выполненные с помощью ИИ, более надежными.
|
|
53
53
|
|
|
54
|
-
-
|
|
54
|
+
- Установленный Truth Sync после изменений кода превращает поддержку документации в защиту рабочего процесса, а не в командную привычку.
|
|
55
55
|
- Истина, ограниченная веткой, движется вместе с кодом, поэтому ревьюеры могут проверять актуальную истину в обычных Git diff.
|
|
56
56
|
- Рабочие поверхности, встроенные в репозиторий, упрощают внедрение и делают передачу работы устойчивее, чем одна лишь персональная настройка.
|
|
57
57
|
- Явная маршрутизация в `docs/truthmark/areas.md` и делегированных дочерних файлах маршрутов дает агентам границы ответственности и более безопасные пути записи.
|
|
58
58
|
- Local-first работа избавляет от зависимости на демон, базу данных, удаленный сервис или MCP.
|
|
59
|
-
- Модель
|
|
59
|
+
- Модель маршрутизации не зависит от языка и дает диагностику покрытия для распространенных поверхностей кода JavaScript, TypeScript, Go, Python, C# и Java.
|
|
60
60
|
|
|
61
61
|
Для технических лидеров ценность в управлении без дополнительной инфраструктуры: тесты, ревью кода и владение зонами ответственности по-прежнему делают основную работу; Truthmark делает контекст агента долговечным, проверяемым и ограниченным веткой.
|
|
62
62
|
|
|
@@ -96,6 +96,7 @@ Truthmark превращает истину репозитория в явную
|
|
|
96
96
|
- `docs/truthmark/areas.md` и делегированные дочерние файлы маршрутов сопоставляют области кода с документами, которые за них отвечают.
|
|
97
97
|
- Truth Document создает или исправляет канонические документы истины для уже реализованного поведения, когда изменение кода не нужно.
|
|
98
98
|
- Truth Sync поддерживает синхронизацию сопоставленных документов истины при функциональных изменениях.
|
|
99
|
+
- Truth Preview предварительно показывает вероятную маршрутизацию рабочего процесса до правок, не авторизуя записи.
|
|
99
100
|
- Truth Realize дает изменениям, начинающимся с документации, ограниченный путь для обновления кода.
|
|
100
101
|
- `truthmark check` валидирует получившиеся артефакты истины.
|
|
101
102
|
- Вся модель остается local-first и Git-native.
|
|
@@ -132,17 +133,17 @@ node /path/to/truthmark/dist/main.js check
|
|
|
132
133
|
.truthmark/config.yml
|
|
133
134
|
docs/truthmark/areas.md
|
|
134
135
|
docs/truthmark/areas/repository.md
|
|
135
|
-
docs/templates/
|
|
136
|
-
docs/
|
|
137
|
-
docs/
|
|
138
|
-
docs/
|
|
136
|
+
docs/templates/behavior-doc.md
|
|
137
|
+
docs/truth/README.md
|
|
138
|
+
docs/truth/repository/README.md
|
|
139
|
+
docs/truth/repository/overview.md
|
|
139
140
|
AGENTS.md
|
|
140
141
|
CLAUDE.md
|
|
141
142
|
GEMINI.md
|
|
142
143
|
```
|
|
143
144
|
|
|
144
145
|
Поддерживаемые платформы: `codex`, `opencode`, `claude-code`, `github-copilot` и `gemini-cli`. Конфигурация по умолчанию включает их все; удалите из `.truthmark/config.yml` платформы, которыми не пользуетесь, перед повторным запуском `truthmark init`.
|
|
145
|
-
Стандартная шаблонная структура использует
|
|
146
|
+
Стандартная шаблонная структура использует truth-`README.md` как индексы и начинает описывать истину текущего поведения в ограниченных листовых документах, например `docs/truth/repository/overview.md`.
|
|
146
147
|
|
|
147
148
|
Существующим репозиториям обычно нужен один этап очистки после `init`: запустите установленный рабочий процесс Truth Structure, если созданный маршрут `repository` слишком широкий, владение охватывает несколько продуктов или сервисов, либо файлы маршрутов все еще указывают на документы-заглушки. Truth Structure разделяет широкие маршруты, создает или исправляет начальные канонические документы истины и дает Truth Sync точные цели до начала работы с функциональным кодом. Codex, Claude Code и поддерживаемые IDE Copilot могут вызвать его через `/truthmark-structure`; хосты в стиле OpenCode могут использовать `/skill truthmark-structure`.
|
|
148
149
|
|
|
@@ -150,51 +151,88 @@ GEMINI.md
|
|
|
150
151
|
|
|
151
152
|
Сильная сторона Truthmark — путь по умолчанию, а не набор ручных команд. Действующий агент и среда хоста сами решают, делегировать работу или выполнить установленный процесс на месте.
|
|
152
153
|
|
|
153
|
-
|
|
154
|
+
### Существующее поведение без документации
|
|
154
155
|
|
|
155
|
-
|
|
156
|
+
Используйте это, когда реализация уже есть, но канонические документы истины отсутствуют или слабы:
|
|
157
|
+
|
|
158
|
+
```text
|
|
159
|
+
пользователь определяет реализованное поведение или api-эндпоинт
|
|
160
|
+
пользователь явно вызывает truth document
|
|
161
|
+
агент читает реализацию, тесты, маршрутизацию и существующие docs
|
|
162
|
+
агент пишет только truth docs и маршрутизацию
|
|
163
|
+
проверить diff truth docs
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Truth Document — это ручной процесс с приоритетом реализации: код служит доказательством, документы истины создаются или исправляются, и функциональный код менять нельзя. Codex, Claude Code и поддерживаемые IDE Copilot могут вызывать его через `/truthmark-document`; хосты в стиле OpenCode могут использовать `/skill truthmark-document`.
|
|
167
|
+
|
|
168
|
+
```text
|
|
169
|
+
/truthmark-document документирует реализованное поведение session timeout в docs/truth/authentication
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Обычные изменения кода
|
|
173
|
+
|
|
174
|
+
Большинству пользователей не нужно напрямую вызывать Truth Sync. Главное, что установленный агентский процесс рассматривает Truth Sync как финальную защиту, когда менялся функциональный код. Нормальный путь выглядит так:
|
|
156
175
|
|
|
157
176
|
```text
|
|
158
177
|
агент изменяет функциональный код
|
|
159
178
|
запускаются релевантные тесты
|
|
160
|
-
|
|
161
|
-
если был создан diff
|
|
179
|
+
установленный truth sync workflow запускается до завершения агента
|
|
180
|
+
если был создан diff truth docs, он проверяется
|
|
162
181
|
работа коммитится или передается дальше
|
|
163
182
|
```
|
|
164
183
|
|
|
165
|
-
Truth Sync работает по принципу code-first: сначала идет код, затем документы истины, и Truth Sync не должен переписывать функциональный код. Его основная задача
|
|
184
|
+
Truth Sync работает по принципу code-first: сначала идет код, затем документы истины, и Truth Sync не должен переписывать функциональный код. Его основная задача - выполняться через установленный агентский процесс как финальная защита, когда менялся функциональный код. Прямой вызов нужен в основном для отладки, ранней синхронизации перед передачей работы или намеренного запуска рабочего процесса.
|
|
185
|
+
|
|
166
186
|
Codex, Claude Code и поддерживаемые IDE Copilot могут вызывать его через `/truthmark-sync`. Хосты в стиле OpenCode могут использовать `/skill truthmark-sync`.
|
|
187
|
+
|
|
188
|
+
```text
|
|
189
|
+
/truthmark-sync синхронизируй истину репозитория прямо сейчас перед передачей
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Doc-first изменения
|
|
193
|
+
|
|
167
194
|
Используйте этот путь, когда продуктовое или архитектурное решение начинается в документации:
|
|
168
195
|
|
|
169
196
|
```text
|
|
170
|
-
пользователь редактирует
|
|
171
|
-
пользователь явно вызывает
|
|
172
|
-
агент читает
|
|
197
|
+
пользователь редактирует truth docs
|
|
198
|
+
пользователь явно вызывает truth realize
|
|
199
|
+
агент читает truth docs и связанный код
|
|
173
200
|
агент обновляет только код
|
|
174
201
|
запускаются релевантные тесты
|
|
175
202
|
работа коммитится или передается дальше
|
|
176
203
|
```
|
|
177
204
|
|
|
178
|
-
Truth Realize это ручной
|
|
205
|
+
Truth Realize — это ручной doc-first процесс: документы истины идут первыми, код следует за ними, и агент не должен редактировать документы истины, которые он реализует.
|
|
206
|
+
|
|
179
207
|
Codex, Claude Code и поддерживаемые IDE Copilot могут вызывать его через `/truthmark-realize`. Хосты в стиле OpenCode могут использовать `/skill truthmark-realize`.
|
|
180
208
|
|
|
209
|
+
```text
|
|
210
|
+
/truthmark-realize реализуй docs/truth/authentication/session-timeout.md в код
|
|
211
|
+
```
|
|
212
|
+
|
|
181
213
|
## Что он устанавливает
|
|
182
214
|
|
|
183
215
|
Truthmark держит постоянную рабочую поверхность маленькой и встроенной в репозиторий. После `truthmark init` сам репозиторий несет маршрутизацию, правила и установленные рабочие поверхности, поэтому команда не зависит только от локальной настройки одного человека.
|
|
184
216
|
|
|
185
|
-
|
|
186
|
-
|
|
217
|
+
Truthmark устанавливает два разных интерфейса:
|
|
218
|
+
|
|
219
|
+
- CLI-команды для людей, которые запускают люди или CI, чтобы настроить репозиторий, обновить установленные файлы, проверить артефакты истины и при необходимости создать производный контекст для ревью
|
|
220
|
+
- агентские рабочие поверхности, которые вызывают coding agents или агентские хосты во время реализации; это не дополнительные ежедневные терминальные команды для людей
|
|
221
|
+
|
|
222
|
+
- `.truthmark/config.yml` для машиночитаемого зафиксированного контракта иерархии
|
|
187
223
|
- `docs/truthmark/areas.md` для корневого индекса маршрутов
|
|
188
224
|
- `docs/truthmark/areas/**/*.md` для делегированных дочерних файлов маршрутов
|
|
189
|
-
- `docs/templates/
|
|
225
|
+
- `docs/templates/behavior-doc.md` и другие шаблоны по видам под `docs/templates/` для редактируемых стандартов truth docs, используемых сгенерированными рабочими процессами
|
|
190
226
|
- управляемые блоки инструкций для настроенных платформ, таких как `AGENTS.md`, `CLAUDE.md`, инструкции Copilot и `GEMINI.md`
|
|
191
|
-
- нативные для хоста skills, prompts или commands для Truth Structure, Truth Document, Truth Sync, Truth Realize и Truth Check
|
|
227
|
+
- нативные для хоста skills, prompts или commands для Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize и Truth Check
|
|
228
|
+
- проектные проверяющие агенты Codex, Claude Code, GitHub Copilot и OpenCode в режиме только чтения, а также leased-агенты `truth-doc-writer` там, где хост поддерживает агентов, под `.codex/agents/`, `.claude/agents/`, `.github/agents/` и `.opencode/agents/` для аудитов, которыми владеет рабочий процесс, и для документных шардов, выданных родительским агентом
|
|
192
229
|
|
|
193
230
|
Установленные рабочие поверхности и есть среда выполнения:
|
|
194
231
|
|
|
195
232
|
- Truth Structure создает или исправляет маршрутизацию областей и стартовые документы истины.
|
|
196
233
|
- Truth Document создает или исправляет документы истины для уже реализованного поведения.
|
|
197
234
|
- Truth Sync поддерживает синхронизацию сопоставленных документов истины с функциональными изменениями.
|
|
235
|
+
- Truth Preview предварительно показывает вероятную маршрутизацию рабочего процесса до правок без записи файлов.
|
|
198
236
|
- Truth Realize обновляет код так, чтобы он соответствовал документам истины.
|
|
199
237
|
- Truth Check аудитирует здоровье истины репозитория.
|
|
200
238
|
|
|
@@ -204,20 +242,33 @@ Truthmark держит постоянную рабочую поверхност
|
|
|
204
242
|
|
|
205
243
|
## Команды
|
|
206
244
|
|
|
207
|
-
Truthmark V1
|
|
245
|
+
Truthmark V1 держит терминальный CLI сфокусированным. Большинству людей нужны только настройка, обновление и проверка:
|
|
208
246
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
truthmark
|
|
212
|
-
truthmark
|
|
213
|
-
truthmark
|
|
214
|
-
|
|
215
|
-
|
|
247
|
+
| CLI-команда для людей | Назначение |
|
|
248
|
+
| --------------------- | ---------- |
|
|
249
|
+
| `truthmark config` | Создает `.truthmark/config.yml`; пишет только этот файл, если не используется `--stdout`. |
|
|
250
|
+
| `truthmark init` | Устанавливает или обновляет локальные файлы рабочих процессов из проверенной конфигурации. |
|
|
251
|
+
| `truthmark check` | Валидирует конфигурацию, полномочия, маршрутизацию, документы с решениями, frontmatter, внутренние ссылки, область действия ветки и диагностику покрытия. |
|
|
252
|
+
|
|
253
|
+
Остальные CLI-команды - необязательные помощники репозиторной аналитики. Они создают производный контекст для ревью активного checkout; они не являются источниками истины:
|
|
216
254
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
`
|
|
220
|
-
|
|
255
|
+
| Необязательная CLI-команда | Назначение |
|
|
256
|
+
| -------------------------- | ---------- |
|
|
257
|
+
| `truthmark index` | Строит JSON RepoIndex и RouteMap для активного checkout. |
|
|
258
|
+
| `truthmark impact --base <ref>` | Сопоставляет измененные файлы с routed truth docs, owning routes, nearby tests и public symbols. |
|
|
259
|
+
| `truthmark context --workflow <workflow> [--base <ref>]` | Генерирует ограниченный ContextPack для Truth Sync, Truth Document или Truth Realize. `--format markdown` рендерит его в читаемый человеком вид. |
|
|
260
|
+
|
|
261
|
+
Все CLI-команды выше поддерживают `--json`, когда структурированный вывод полезен для автоматизации.
|
|
262
|
+
|
|
263
|
+
Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize и Truth Check это установленные агентские рабочие процессы, а не повседневные CLI-команды верхнего уровня.
|
|
264
|
+
|
|
265
|
+
Они запускаются через настроенные поверхности хоста агента, например Codex/Claude/Copilot `/truthmark-*`, OpenCode `/skill truthmark-*` или Gemini `/truthmark:*`.
|
|
266
|
+
|
|
267
|
+
Эти вызовы выглядят как команды, потому что агентские хосты предоставляют skills через slash-команды. Относитесь к ним как к инструкциям для агента, а не как к терминальным командам, которые должен запускать человек.
|
|
268
|
+
|
|
269
|
+
```text
|
|
270
|
+
/truthmark-check проверь маршрутизацию и покрытие truth перед review
|
|
271
|
+
```
|
|
221
272
|
|
|
222
273
|
## Зачем он существует
|
|
223
274
|
|
|
@@ -236,15 +287,20 @@ Truth Structure, Truth Document, Truth Sync, Truth Realize и Truth Check это
|
|
|
236
287
|
## Статус проекта
|
|
237
288
|
|
|
238
289
|
Truthmark не является сервером памяти и не является MCP-сервером. Это репозиторная практика, упакованная как небольшой CLI-установщик и родные для агентов рабочие поверхности, которые превращают правила ИИ-процесса в инфраструктуру репозитория.
|
|
290
|
+
|
|
239
291
|
V1 сейчас предоставляет:
|
|
240
292
|
|
|
241
293
|
- `truthmark config`
|
|
242
294
|
- `truthmark init`
|
|
243
295
|
- `truthmark check`
|
|
296
|
+
- `truthmark index`
|
|
297
|
+
- `truthmark impact`
|
|
298
|
+
- `truthmark context`
|
|
244
299
|
- управляемые инструкции рабочих процессов в `AGENTS.md`
|
|
245
|
-
- сгенерированные skill-поверхности Truth Structure, Truth Document, Truth Sync, Truth Realize и Truth Check для настроенных агентских хостов
|
|
300
|
+
- сгенерированные skill-поверхности Truth Structure, Truth Document, Truth Sync, Truth Preview, Truth Realize и Truth Check для настроенных агентских хостов
|
|
246
301
|
- метаданные области ветки
|
|
247
302
|
- диагностика конфигурации, полномочий, маршрутизации, структуры решений, frontmatter, ссылок и полиглотного покрытия
|
|
303
|
+
- производные артефакты RepoIndex, RouteMap, ImpactSet и ContextPack для более быстрой локальной проверки, когда CLI доступен
|
|
248
304
|
|
|
249
305
|
## Документация
|
|
250
306
|
|
|
@@ -252,10 +308,10 @@ V1 сейчас предоставляет:
|
|
|
252
308
|
|
|
253
309
|
- [Индекс документации](docs/README.md)
|
|
254
310
|
- [Обзор архитектуры](docs/architecture/overview.md)
|
|
255
|
-
- [Контракты API и CLI](docs/
|
|
256
|
-
- [Поведение init и scaffold](docs/
|
|
257
|
-
- [Диагностика check](docs/
|
|
258
|
-
- [Установленные workflow](docs/
|
|
311
|
+
- [Контракты API и CLI](docs/truth/contracts.md)
|
|
312
|
+
- [Поведение init и scaffold](docs/truth/init-and-scaffold.md)
|
|
313
|
+
- [Диагностика check](docs/truth/check-diagnostics.md)
|
|
314
|
+
- [Установленные workflow](docs/truth/workflows/overview.md)
|
|
259
315
|
- [Руководство по поддержанию истины репозитория](docs/standards/maintaining-repository-truth.md)
|
|
260
316
|
|
|
261
317
|
Текущее поведение должно жить в каноническом дереве документации выше.
|