truthmark 2.2.3 → 2.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.ru.md DELETED
@@ -1,823 +0,0 @@
1
- # Truthmark
2
-
3
- **Ваши агенты пишут код. Truthmark поддерживает документацию для людей, версионируемую и проверяемую в Git.**
4
-
5
- [English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | [Español](README.es.md) | Русский
6
-
7
- ![Баннер Truthmark](docs/assets/truthmark-banner.png)
8
-
9
- ИИ-агенты разработки могут менять репозиторий быстрее, чем люди успевают поддерживать его документацию в актуальном состоянии.
10
-
11
- Truthmark чинит ту часть, которая обычно ломается после написания кода: актуальное описание репозитория.
12
-
13
- Он устанавливает Git-native, ограниченный веткой слой рабочего процесса, который помогает ИИ-агентам обновлять правильные документы, соблюдать границы владения и оставлять людям обычные diff для ревью.
14
-
15
- Без размещенного сервиса.
16
-
17
- Без базы данных.
18
-
19
- Без скрытого слоя памяти.
20
-
21
- Без дополнительного сервера в эксплуатации.
22
-
23
- Только актуальное описание репозитория, которое движется вместе с веткой.
24
-
25
- ## Проблема
26
-
27
- ИИ-агенты разработки хорошо создают код. Это порождает новый режим отказа.
28
-
29
- Реализация меняется, но история репозитория начинает расходиться:
30
-
31
- - поведение живет в истории чата
32
- - архитектурные документы отстают
33
- - продуктовые решения исчезают после передачи работы
34
- - ревьюеры видят diff кода без связанных diff истины
35
- - ветки незаметно развивают разные версии того, «что является правдой»
36
- - каждой сессии агента приходится заново понимать актуальное состояние репозитория
37
-
38
- Truthmark превращает это хрупкое описание текущего состояния в зафиксированную инфраструктуру репозитория.
39
-
40
- Вместо надежды на то, что каждый человек и каждый агент вспомнят нужную дисциплину документирования, Truthmark устанавливает эту привычку в репозиторий.
41
-
42
- ## Обещание
43
-
44
- Когда агент меняет функциональный код, работа не должна заканчиваться только diff кода.
45
-
46
- Обычный путь Truthmark:
47
-
48
- ```text
49
- агент меняет функциональный код
50
- запускаются релевантные тесты
51
- Truth Sync проверяет сопоставленные документы истины
52
- документы истины обновляются при необходимости
53
- человек проверяет diff кода + diff истины
54
- коммит или передача работы
55
- ```
56
-
57
- Главная ценность такова: **ИИ-работе легче доверять, потому что репозиторий остается понятным.**
58
-
59
- ## Два интерфейса, одна система истины
60
-
61
- Truthmark — это не только CLI.
62
-
63
- У него два разных интерфейса, и это различие важно.
64
-
65
- ### 1. CLI для людей
66
-
67
- CLI предназначен для мейнтейнеров, ревьюеров и автоматизации.
68
-
69
- Используйте его, чтобы настроить репозиторий, установить или обновить файлы рабочих процессов, проверить артефакты истины и создать дополнительные материалы для ревью.
70
-
71
- ```bash
72
- truthmark config
73
- truthmark init
74
- truthmark check
75
- ```
76
-
77
- CLI подготавливает и валидирует среду репозитория.
78
-
79
- Он не является runtime для ИИ-рабочего процесса.
80
-
81
- ### 2. Интерфейсы рабочих процессов для ИИ
82
-
83
- Интерфейсы для ИИ предназначены для coding agents.
84
-
85
- Truthmark устанавливает host-native skills, prompts, commands, управляемые блоки инструкций и поддерживаемые интерфейсы subagents, чтобы ИИ-агенты могли следовать специфичным для репозитория truth-workflows внутри своих обычных инструментов разработки.
86
-
87
- Примеры:
88
-
89
- ```text
90
- /truthmark-sync
91
- /truthmark-document
92
- /truthmark-structure
93
- /truthmark-realize
94
- /truthmark-check
95
- ```
96
-
97
- Они выглядят как команды, потому что agent hosts раскрывают workflows через slash commands, prompts, skills или project commands.
98
-
99
- Это не shell-команды.
100
-
101
- Это точки входа workflow для ИИ.
102
-
103
- Разделение и есть продукт:
104
-
105
- ```text
106
- люди владеют контрактом репозитория
107
- Truthmark устанавливает контракт в репозиторий
108
- агенты работают внутри этого контракта
109
- обновления истины появляются как Git diff
110
- люди проверяют результат
111
- ```
112
-
113
- ## Быстрый старт
114
-
115
- ### Требования
116
-
117
- - Node.js `>=20`
118
- - npm
119
- - Git-репозиторий
120
-
121
- ### Установить Truthmark
122
-
123
- Выполните это внутри репозитория, который хотите инициализировать:
124
-
125
- ```bash
126
- cd /path/to/your-repo
127
- npm install -g truthmark
128
- ```
129
-
130
- ### Создать контракт истины репозитория
131
-
132
- ```bash
133
- truthmark config
134
- ```
135
-
136
- Это создает:
137
-
138
- ```text
139
- .truthmark/config.yml
140
- ```
141
-
142
- Проверьте этот файл перед продолжением. Он определяет зафиксированный контракт иерархии для репозитория.
143
-
144
- ### Установить интерфейсы рабочих процессов
145
-
146
- ```bash
147
- truthmark init
148
- ```
149
-
150
- Это устанавливает или обновляет:
151
-
152
- - файлы маршрутов
153
- - scaffolding документов истины
154
- - управляемые блоки инструкций
155
- - интерфейсы рабочих процессов для ИИ для настроенных платформ
156
-
157
- Обоснование стандартных шаблонов документов истины находится в [Template Standards](docs/standards/template-standards.md). В документе показано, как они соотносятся с признанными источниками по инженерии ПО, включая ISO/IEC/IEEE 42010, ISO/IEC/IEEE 29148, ISO/IEC/IEEE 12207, ISO/IEC 25010, C4, arc42, OpenAPI, SemVer, Google SRE и Diátaxis.
158
-
159
- ### Проверить настройку
160
-
161
- ```bash
162
- truthmark check
163
- ```
164
-
165
- Затем проверьте сгенерированные файлы перед коммитом.
166
-
167
- Точный набор файлов зависит от `.truthmark/config.yml`, но форма установки всегда одна: routing, truth scaffolding, компактные managed instructions и host-native интерфейсы workflow для включённых платформ.
168
-
169
- ## Первое реальное использование
170
-
171
- Большинству репозиториев после инициализации нужен один этап очистки.
172
-
173
- Стандартный scaffold начинается с временной широкой bootstrap-области `repository`. Перед обычной синхронизацией реального кода разделите этот bootstrap-маршрут на точные маршруты.
174
-
175
- Попросите агента разделить широкий маршрут на реальные области продукта, сервиса, домена или владения:
176
-
177
- ```text
178
- /truthmark-structure раздели широкий repo area на auth, billing и notifications
179
- ```
180
-
181
- Если в проекте уже есть реализованные функции, но документы истины отсутствуют или слабы, попросите установленный workflow Truth Document задокументировать сфокусированный scope:
182
-
183
- ```text
184
- /truthmark-document задокументируй реализованное поведение payment retry в src/billing/retry.ts и связанных тестах
185
- ```
186
-
187
- Truth Document — самый частый первый workflow для существующих проектов. Он инспектирует реализацию, тесты, маршруты и существующие документы, затем создает или исправляет документы истины и маршрутизацию, не меняя функциональный код.
188
-
189
- После этого используйте своего ИИ-агента для разработки как обычно.
190
-
191
- Когда агент меняет функциональный код, Truth Sync действует как финальная защита, которая перед передачей работы проверяет, должны ли измениться сопоставленные документы истины.
192
-
193
- ## Что вы получаете
194
-
195
- | Возможность | Что она делает |
196
- | --- | --- |
197
- | Git-native истина | Хранит актуальное описание репозитория в зафиксированных Markdown и config. |
198
- | Документация в пределах ветки | Истина движется с веткой вместо жизни в приватной сессии. |
199
- | CLI для людей | Дает мейнтейнерам команды настройки, обновления, валидации и инспекции. |
200
- | Workflows для ИИ | Дает агентам host-native workflows для sync, documentation, structure, preview, realization и audit. |
201
- | Явная маршрутизация | Сопоставляет области кода с каноническими документами истины. |
202
- | Проверяемые передачи работы | Создает обычные Git diff для кода и документов истины. |
203
- | Local-first работа | Не требует размещенного сервиса, daemon, базы данных или MCP-сервера. |
204
- | Более безопасные границы записи | Разделяет code-first, doc-first, read-only и doc-only workflows. |
205
- | Валидация | Сообщает о проблемах маршрутизации, authority, frontmatter, ссылок, generated surfaces, branch scope, freshness и coverage. |
206
- | Опциональный Portal | Генерирует зафиксированный статический HTML-сайт презентации из Markdown-документов истины, когда он явно включен и запрошен. |
207
-
208
- ## Визуальный обзор
209
-
210
- ![Возможности Truthmark](docs/assets/truthmark-features.png)
211
-
212
- **Возможности:** что устанавливает Truthmark и как устроен интерфейс workflow.
213
-
214
- ![Позиционирование Truthmark](docs/assets/truthmark-position.png)
215
-
216
- **Позиция:** где Truthmark находится относительно prompts, memory и spec workflows.
217
-
218
- ![Поток sync Truthmark](docs/assets/truthmark-syncflow.png)
219
-
220
- **Поток sync:** как Truth Sync закрывает обычные изменения кода перед передачей.
221
-
222
- ## Почему команды выбирают его
223
-
224
- Truthmark предназначен для команд, которые уже знают, что ИИ-агенты могут генерировать код.
225
-
226
- Следующая проблема — governance.
227
-
228
- Не governance как церемония. Governance как простой вопрос:
229
-
230
- > После этого ИИ-ассистированного изменения репозиторий все еще говорит правду?
231
-
232
- Truthmark помогает командам отвечать на это с помощью зафиксированных файлов, явной маршрутизации и проверяемых diff.
233
-
234
- Он полезен, когда нужны:
235
-
236
- - меньший дрейф документации
237
- - лучшие передачи работы
238
- - продуктовая истина, специфичная для ветки
239
- - долговечная архитектурная и API-документация
240
- - явное владение между документацией и кодом
241
- - более безопасные границы записи для агентов
242
- - проверяемая документация вместо скрытой памяти
243
- - ИИ-workflows, которые продолжают работать из зафиксированных файлов репозитория
244
-
245
- ## Где уместен Truthmark
246
-
247
- Truthmark не заменяет prompts, memory, specs, tests или code review.
248
-
249
- Он дает этим workflows долговечное место в Git.
250
-
251
- | Потребность | Лучше подходит |
252
- | --- | --- |
253
- | Лучший результат из одной сессии агента | Лучший prompt |
254
- | Персональная или сессионная преемственность | Memory tool |
255
- | Работа над функцией plan-first | Spec workflow |
256
- | Истина в пределах ветки, которая путешествует с кодом | Truthmark |
257
- | Проверка корректности поведения | Tests and review |
258
- | Ревью изменений документации, выполненных с ИИ | Truthmark plus Git review |
259
-
260
- Область Truthmark намеренно узкая:
261
-
262
- ```text
263
- сделать актуальное состояние репозитория явным
264
- связать ее с кодом
265
- установить вокруг нее workflows агентов
266
- сохранить результат проверяемым в Git
267
- ```
268
-
269
- ## Как работает Truthmark
270
-
271
- Truthmark работает локально с активным Git worktree.
272
-
273
- CLI для людей читает и записывает файлы репозитория, а затем завершается.
274
-
275
- Интерфейсы рабочих процессов для ИИ — это зафиксированные файлы, которые agent hosts могут загрузить позже. Поэтому агенты могут следовать установленному workflow из состояния репозитория, не завися от фонового процесса Truthmark.
276
-
277
- Эти слои связаны так:
278
-
279
- ```mermaid
280
- flowchart LR
281
- Human["Human / CI"] --> CLI["Truthmark CLI"]
282
- CLI --> Config["Config и routing"]
283
- CLI --> Truth["Канонические truth docs"]
284
- CLI --> Surfaces["Сгенерированные host-native workflows"]
285
- Surfaces --> Hosts["Codex / Claude Code / Copilot / OpenCode / Gemini"]
286
- Hosts --> Worktree["Активный Git worktree"]
287
- Hosts -->|"helper checks / validate / index"| CLI
288
- Worktree --> Truth
289
- ```
290
-
291
- Agents не подключаются к daemon Truthmark, но могут запускать установленный Truthmark CLI, когда workflow требует validation, indexing или helper checks.
292
-
293
- Truthmark владеет сгенерированными интерфейсами workflow, но главный контракт архитектурный: repo-local config и routing направляют agents к каноническим truth docs, а host-native workflows дают каждому поддерживаемому agent способ выполнять одни и те же процедуры Truthmark.
294
-
295
- Сгенерированные интерфейсы workflow включают маркеры версии Truthmark. После обновления Truthmark снова выполните:
296
-
297
- ```bash
298
- truthmark init
299
- ```
300
-
301
- Затем проверьте сгенерированные diff.
302
-
303
- ## Поддерживаемые платформы агентов
304
-
305
- Конфигурация по умолчанию включает все поддерживаемые платформы.
306
-
307
- Удалите платформы, которыми не пользуетесь, из `.truthmark/config.yml`, затем снова выполните:
308
-
309
- ```bash
310
- truthmark init
311
- ```
312
-
313
- | Имя платформы в config | Сгенерированный интерфейс | Форма вызова |
314
- | --- | --- | --- |
315
- | `codex` | `.agents/skills/truthmark-*/`, `.codex/agents/` | `/truthmark-*` или `$truthmark-*` |
316
- | `claude-code` | `.claude/skills/truthmark-*/`, `.claude/agents/`, `CLAUDE.md` | `/truthmark-*` |
317
- | `github-copilot` | `.github/skills/truthmark-*/`, `.github/prompts/`, `.github/agents/`, `.github/copilot-instructions.md` | `/truthmark-*` в поддерживаемых Copilot IDE; custom agents `@truth-*` в Copilot CLI |
318
- | `opencode` | `.opencode/skills/truthmark-*/`, `.opencode/agents/` | `/skill truthmark-*` |
319
- | `gemini-cli` | `.gemini/skills/truthmark-*/`, `.gemini/commands/truthmark/`, `.gemini/agents/`, `GEMINI.md` | `/truthmark:*` |
320
-
321
- Неизвестные имена платформ являются ошибками config.
322
-
323
- Удаление платформы останавливает будущие обновления для нее. Оно не удаляет ранее сгенерированные файлы.
324
-
325
- ## Workflows для ИИ
326
-
327
- Эти workflows устанавливаются в поддерживаемые ИИ coding hosts.
328
-
329
- Они используются агентами или agent hosts во время работы с репозиторием. Это не shell-команды верхнего уровня.
330
-
331
- | Workflow | Направление | Когда использовать | Граница записи |
332
- | --- | --- | --- | --- |
333
- | Truth Structure | topology-first | Стандартный маршрут слишком широкий, владение охватывает несколько областей или файлы маршрутов все еще указывают на placeholders. | Создает или исправляет маршрутизацию и стартовые документы истины. |
334
- | Truth Document | implementation-first | Поведение уже есть в коде, но канонические документы истины отсутствуют или слабы. | Пишет только документы истины и маршрутизацию. Функциональный код менять нельзя. |
335
- | Truth Sync | code-first | Функциональный код изменился, и сопоставленные документы истины могут потребовать обновления перед передачей. | Обновляет документы истины. Truth Sync не должен переписывать функциональный код. |
336
- | Truth Realize | doc-first | Продуктовые или архитектурные документы истины ведут, и код нужно обновить под них. | Обновляет только код. Агент не должен редактировать документы истины, которые реализует. |
337
- | Truth Check | audit-first | Ревьюеру или агенту нужно проверить актуальность истины репозитория. | Аудитирует и сообщает. |
338
- | Truthmark Portal | presentation-only | Человек явно просит доступный для просмотра статический HTML Portal по документам истины репозитория. | Пишет только сгенерированные неканонические статические файлы в настроенную директорию вывода Portal. |
339
-
340
- ### Важное различие
341
-
342
- Не путайте эти два интерфейса:
343
-
344
- | Интерфейс | Используется | Пример | Значение |
345
- | --- | --- | --- | --- |
346
- | CLI для людей | людьми, скриптами, CI-подобными проверками | `truthmark check` | Проверить артефакты истины репозитория из терминала. |
347
- | Workflow для ИИ | coding agents и agent hosts | `/truthmark-check` | Попросить агента выполнить установленный audit workflow. |
348
-
349
- Имена намеренно похожи, но интерфейсы разные.
350
-
351
- ## Обычное изменение кода с помощью ИИ
352
-
353
- Большинству пользователей не нужно вручную вызывать Truth Sync каждый раз.
354
-
355
- Truth Sync — установленная финальная защита для изменений функционального кода.
356
-
357
- ```text
358
- агент меняет функциональный код
359
- агент запускает или запрашивает релевантные тесты
360
- установленный workflow обнаруживает, что функциональный код изменился
361
- Truth Sync проверяет сопоставленные документы истины
362
- агент обновляет документы истины при необходимости
363
- человек проверяет diff кода + diff истины
364
- ```
365
-
366
- Прямой вызов все равно полезен для отладки, принудительной ранней синхронизации или явной передачи работы:
367
-
368
- ```text
369
- /truthmark-sync синхронизируй истину репозитория прямо сейчас перед передачей
370
- ```
371
-
372
- ## Существующее поведение без docs
373
-
374
- Используйте Truth Document, когда реализация уже существует, но истина репозитория неполна. Это обычный путь для зрелых репозиториев, которые внедряют Truthmark после того, как кодовая база уже существует.
375
-
376
- ```text
377
- /truthmark-document задокументируй реализованное поведение session timeout в src/auth/session.ts, src/auth/middleware.ts и tests/auth/session.test.ts
378
- ```
379
-
380
- Укажите имя функции, пути к коду, пути к тестам или желаемую область truth-документов. В OpenCode-подобных хостах тот же workflow вызывается как `/skill truthmark-document ...`; в Gemini CLI используйте `/truthmark:doc ...`.
381
-
382
- Для большого репозитория, где все еще есть один широкий placeholder-маршрут, сначала запустите Truth Structure, а затем вызывайте Truth Document для одной ограниченной функции или области за раз.
383
-
384
- Truth Document проверяет реализацию, тесты, файлы маршрутов и существующие документы как подтверждения.
385
-
386
- Он пишет только документы истины и маршрутизацию.
387
-
388
- Он не должен менять функциональный код.
389
-
390
- ## Doc-first изменения
391
-
392
- Используйте Truth Realize, когда продуктовое или архитектурное решение начинается в docs и код нужно обновить под него.
393
-
394
- ```text
395
- /truthmark-realize реализуй docs/truthmark/product/capabilities/session-timeout.md в коде
396
- ```
397
-
398
- Truth Realize работает doc-first.
399
-
400
- Документы истины ведут. Код следует.
401
-
402
- Агент не должен редактировать документы истины, которые реализует.
403
-
404
- ## Read-only preview маршрутизации
405
-
406
- Используйте Truth Preview перед изменением, когда агенту нужно понять вероятную маршрутизацию.
407
-
408
- ```text
409
- /truthmark-preview покажи вероятный truth routing для изменений billing API (GitHub Copilot)
410
- /truthmark:preview покажи вероятный truth routing для изменений billing API (Gemini CLI)
411
- ```
412
-
413
- Truth Preview работает read-only.
414
-
415
- Это средство выбора и планирования, а не авторизация записи и не замена Truth Check.
416
-
417
- ## Аудит истины репозитория
418
-
419
- Используйте Truth Check, когда нужен audit workflow для агента.
420
-
421
- ```text
422
- /truthmark-check проверь routing и truth coverage перед review
423
- ```
424
-
425
- Используйте CLI для людей, когда нужна terminal validation:
426
-
427
- ```bash
428
- truthmark check
429
- ```
430
-
431
- Оба варианта полезны. Это не одна и та же поверхность.
432
-
433
- ## CLI-команды для людей
434
-
435
- Большинство мейнтейнеров начинают с трех команд.
436
-
437
- | Команда | Назначение |
438
- | --- | --- |
439
- | `truthmark config` | Создает `.truthmark/config.yml`. Пишет только этот файл, если не используется `--stdout`. |
440
- | `truthmark init` | Устанавливает или обновляет настроенные интерфейсы workflow из проверенной config. |
441
- | `truthmark check` | Валидирует config, authority, routing, документы с decisions, frontmatter, внутренние ссылки, branch scope, generated surfaces, freshness и coverage diagnostics. |
442
-
443
- Необязательные 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.
444
-
445
- Они не являются источниками истины.
446
-
447
- | Команда | Назначение |
448
- | --- | --- |
449
- | `truthmark index` | Строит JSON RepoIndex и RouteMap для активного checkout. |
450
- | `truthmark impact --base <ref>` | Сопоставляет измененные файлы с routed truth docs, owning routes, nearby tests и public symbols. |
451
- | `truthmark workflow status --workflow <workflow> [--base <ref>] --json` | Возвращает применимость workflow, границы записи, целевые truth docs, checks, helper commands и компактные hints по affected tests. |
452
-
453
- Структурированный вывод доступен с `--json` там, где поддерживается.
454
-
455
- ## Truthmark Portal
456
-
457
- Truthmark Portal — опциональный презентационный workflow для команд, которым нужен человекочитаемый сайт поверх зафиксированных документов истины.
458
-
459
- Он намеренно отделен от основного workflow истины:
460
-
461
- - Markdown-документы истины остаются каноническими.
462
- - Сгенерированный HTML Portal предназначен только для презентации.
463
- - Portal запускается только вручную; он не выполняется как completion review, шаг Truth Sync, шаг `truthmark check` или автоматический post-change hook.
464
- - Записи Portal остаются внутри настроенной директории вывода, если пользователь явно не меняет scope.
465
- - Сгенерированные страницы должны использовать локальные assets, provenance источников и видимое уведомление, что Markdown является каноническим источником.
466
-
467
- Включите его namespaced config-блоком:
468
-
469
- ```yaml
470
- truthmark:
471
- generated:
472
- portal:
473
- enabled: true
474
- ```
475
-
476
- Затем запустите снова:
477
-
478
- ```bash
479
- truthmark init
480
- ```
481
-
482
- Когда Portal включен, Truthmark устанавливает host-native Portal-интерфейсы workflow для настроенных платформ, например `/truthmark-portal` или `/truthmark:portal` в зависимости от agent host.
483
-
484
- ## Конфигурация
485
-
486
- Truthmark работает config-first.
487
-
488
- Главный config-файл:
489
-
490
- ```text
491
- .truthmark/config.yml
492
- ```
493
-
494
- Новые репозитории должны выполнить:
495
-
496
- ```bash
497
- truthmark config
498
- ```
499
-
500
- Затем проверить сгенерированную config перед запуском:
501
-
502
- ```bash
503
- truthmark init
504
- ```
505
-
506
- Важные области config:
507
-
508
- | Область config | Назначение |
509
- | --- | --- |
510
- | `version` | Версия контракта config. |
511
- | `platforms` | Agent hosts, которые должны получить сгенерированные интерфейсы для платформы. |
512
- | `truthmark.workspace` | Workspace, принадлежащий Truthmark, для маршрутов, документов истины, шаблонов и сгенерированного презентационного вывода. |
513
- | Фиксированные маршруты | Маршруты находятся в `routes/areas.md` и `routes/areas/` внутри `truthmark.workspace`; область по умолчанию — `repository`, глубина делегирования — `1`. |
514
- | Фиксированные дорожки истины | Product truth находится в `product/`, а engineering truth в `engineering/` внутри `truthmark.workspace`. |
515
- | Фиксированные шаблоны | Шаблоны документов истины находятся в `templates/` внутри `truthmark.workspace`. |
516
- | `truthmark.generated.portal` | Опциональное включение ручного презентационного workflow: `enabled`. |
517
- | `instruction_targets` | Файлы, которые получают общие управляемые блоки инструкций, например `AGENTS.md`. |
518
- | `frontmatter.required` | Поля metadata, которые создают error diagnostics при отсутствии. |
519
- | `frontmatter.recommended` | Поля metadata, которые создают review diagnostics при отсутствии. |
520
- | `ignore` | Glob-паттерны, исключенные из релевантных checks и routing logic. |
521
-
522
- ## Маршрутизация истины репозитория
523
-
524
- Truthmark сопоставляет code surfaces с документами истины.
525
-
526
- Основные файлы маршрутизации:
527
-
528
- ```text
529
- docs/truthmark/routes/areas.md
530
- docs/truthmark/routes/areas/**/*.md
531
- ```
532
-
533
- Маршрут сообщает агенту:
534
-
535
- - какая code surface принадлежит области
536
- - какие документы истины владеют этой областью
537
- - когда истину нужно обновлять
538
- - какой тип документа истины участвует
539
-
540
- Стандартный scaffold сначала создаёт временный широкий bootstrap-маршрут, чтобы новый репозиторий можно было маршрутизировать. Когда затронут реальный код, до обычного Truth Sync разделите этот bootstrap-маршрут на реальные области продукта, сервиса, домена или владения; не превращайте bootstrap-handoff в универсальный документ поведения.
541
-
542
- Пример:
543
-
544
- ```text
545
- /truthmark-structure раздели широкий repo area на frontend, backend, billing и deployment
546
- ```
547
-
548
- Хороший routing дает Truth Sync точные цели.
549
-
550
- Плохой routing заставляет агентов гадать.
551
-
552
- ## Что устанавливает Truthmark
553
-
554
- Truthmark устанавливает компактный, встроенный в репозиторий слой истины.
555
-
556
- Он устанавливает четыре слоя:
557
-
558
- - config и routing для границ владения
559
- - канонические truth docs и стартовые шаблоны
560
- - компактные управляемые instruction blocks для repo-wide agent instructions
561
- - host-native workflow packages, commands, prompts и verifier agents для платформ, включённых в config
562
-
563
- Truthmark сохраняет ручной контент вне управляемых блоков инструкций.
564
-
565
- Сгенерированные интерфейсы workflow управляются Truthmark и могут обновляться повторным запуском:
566
-
567
- ```bash
568
- truthmark init
569
- ```
570
-
571
- ## Subagents и ограниченные проверки evidence
572
-
573
- Там, где host поддерживает это, Truthmark может устанавливать project-scoped verifier agents и leased `truth-doc-writer`.
574
-
575
- Они помогают держать большие truth-задачи ограниченными:
576
-
577
- - route auditors проверяют владение маршрутами
578
- - claim verifiers проверяют, поддержаны ли claims документов evidence
579
- - doc reviewers проверяют качество truth docs
580
- - leased doc writers обрабатывают ограниченные shards записи truth docs
581
-
582
- Родительский workflow все еще владеет финальной интерпретацией, границами записи, проверкой diff и приемкой.
583
-
584
- Это важно: subagents помогают с ограниченной evidence work. Они не заменяют основной контракт workflow.
585
-
586
- ## Цикл ревью
587
-
588
- Truthmark спроектирован для обычного Git review.
589
-
590
- Хорошая ИИ-ассистированная передача работы должна показывать:
591
-
592
- ```text
593
- diff кода
594
- test evidence
595
- diff truth docs, если нужен
596
- изменения routing, если нужны
597
- отчет агента
598
- ```
599
-
600
- Ревьюер должен уметь ответить:
601
-
602
- - Какой код изменился?
603
- - Какие документы истины владеют этим кодом?
604
- - Нужно ли было обновлять эти документы?
605
- - Если нет, почему?
606
- - Остался ли агент внутри границы записи workflow?
607
- - Приложена ли evidence тестов или проверки?
608
-
609
- ## Примеры
610
-
611
- ### Инициализировать репозиторий
612
-
613
- ```bash
614
- npm install -g truthmark
615
- truthmark config
616
- truthmark init
617
- truthmark check
618
- ```
619
-
620
- ### Удалить неиспользуемые платформы агентов
621
-
622
- Отредактируйте:
623
-
624
- ```text
625
- .truthmark/config.yml
626
- ```
627
-
628
- Затем снова выполните:
629
-
630
- ```bash
631
- truthmark init
632
- truthmark check
633
- ```
634
-
635
- ### Разделить широкий routing
636
-
637
- ```text
638
- /truthmark-structure раздели широкий repo area на auth, billing, notifications и deployment
639
- ```
640
-
641
- ### Документировать реализованное поведение
642
-
643
- ```text
644
- /truthmark-document задокументируй реализованный password reset flow в docs/truthmark/engineering/behaviors/authentication
645
- ```
646
-
647
- ### Синхронизировать после изменений кода
648
-
649
- ```text
650
- /truthmark-sync синхронизируй истину репозитория прямо сейчас перед передачей
651
- ```
652
-
653
- ### Реализовать doc-first решение
654
-
655
- ```text
656
- /truthmark-realize реализуй docs/truthmark/product/capabilities/invoice-retry-policy.md в коде
657
- ```
658
-
659
- ### Проверить здоровье истины из терминала
660
-
661
- ```bash
662
- truthmark check
663
- ```
664
-
665
- ### Создать summary branch-impact
666
-
667
- ```bash
668
- truthmark impact --base main
669
- ```
670
-
671
- ### Проверить workflow status
672
-
673
- ```bash
674
- truthmark workflow status --workflow truthmark-sync --base main --json
675
- ```
676
-
677
- ### Включить опциональный Portal workflow
678
-
679
- ```yaml
680
- truthmark:
681
- generated:
682
- portal:
683
- enabled: true
684
- ```
685
-
686
- ```bash
687
- truthmark init
688
- ```
689
-
690
- Затем явно попросите agent host выполнить установленный Portal workflow, когда нужно сгенерировать или обновить статический презентационный сайт.
691
-
692
- ## Статус проекта
693
-
694
- Truthmark V1 сейчас предоставляет:
695
-
696
- - `truthmark config`
697
- - `truthmark init`
698
- - `truthmark check`
699
- - `truthmark index`
700
- - `truthmark impact`
701
- - `truthmark workflow status`
702
- - branch-scope metadata
703
- - управляемые блоки инструкций
704
- - сгенерированные интерфейсы workflow Truth Structure
705
- - сгенерированные интерфейсы workflow Truth Document
706
- - сгенерированные интерфейсы workflow Truth Sync
707
- - сгенерированные интерфейсы workflow Truth Preview
708
- - сгенерированные интерфейсы workflow Truth Realize
709
- - сгенерированные интерфейсы workflow Truth Check
710
- - опциональные сгенерированные интерфейсы workflow Truthmark Portal
711
- - diagnostics для route, authority, decision-structure, frontmatter, links, freshness, generated-surface и coverage
712
- - производные артефакты RepoIndex, RouteMap, ImpactSet и WorkflowState
713
- - host-specific интерфейсы для Codex, Claude Code, GitHub Copilot, OpenCode и Gemini CLI
714
-
715
- ## Разработка
716
-
717
- Установить зависимости:
718
-
719
- ```bash
720
- npm install
721
- ```
722
-
723
- Запустить локальную development CLI:
724
-
725
- ```bash
726
- npm run dev -- init
727
- npm run dev -- check
728
- ```
729
-
730
- Запустить полный project check:
731
-
732
- ```bash
733
- npm run check
734
- ```
735
-
736
- Полезные scripts:
737
-
738
- | Script | Назначение |
739
- | --- | --- |
740
- | `npm run dev` | Запускает TypeScript CLI entry point через `tsx`. |
741
- | `npm run build` | Собирает package. |
742
- | `npm run lint` | Запускает ESLint. |
743
- | `npm run typecheck` | Запускает TypeScript checks. |
744
- | `npm run test` | Запускает tests. |
745
- | `npm run check` | Запускает lint, typecheck, tests и build. |
746
- | `npm run release:check` | Запускает release-oriented validation. |
747
-
748
- Когда меняете сам Truthmark, смотрите [CONTRIBUTING.md](CONTRIBUTING.md).
749
-
750
- ## Документация
751
-
752
- README — быстрый путь для оценки и настройки.
753
-
754
- Подробное текущее поведение живет в `docs/`:
755
-
756
- - [Индекс документации](docs/README.md)
757
- - [Обзор архитектуры](docs/truthmark/engineering/architecture/overview.md)
758
- - [Контракты API и CLI](docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
759
- - [Поведение init и scaffold](docs/truthmark/engineering/behaviors/init-and-scaffold.md)
760
- - [Диагностика check](docs/truthmark/engineering/behaviors/check-diagnostics.md)
761
- - [Установленные workflows](docs/truthmark/engineering/workflows/installed-workflow-runtime.md)
762
- - [Руководство по поддержанию истины репозитория](docs/standards/maintaining-repository-truth.md)
763
-
764
- ## Границы дизайна
765
-
766
- Truthmark намеренно небольшой.
767
-
768
- Он не является:
769
-
770
- - размещенным сервисом
771
- - MCP-сервером
772
- - векторной базой данных
773
- - каноническим генератором сайтов документации или hosted docs platform
774
- - CI- или PR-enforcement продуктом
775
- - заменой tests, code review или technical leadership
776
- - автономным движком переписывания кода
777
- - framework для model training или fine-tuning
778
- - скрытым слоем памяти
779
-
780
- Эти границы — часть продукта.
781
-
782
- Truthmark держит workflow локальным, зафиксированным, ограниченным веткой и проверяемым.
783
-
784
- ## Безопасность и дисциплина ревью
785
-
786
- Truthmark помогает репозиторию оставаться честным. Он не доказывает, что код корректен.
787
-
788
- Команды все равно должны:
789
-
790
- - запускать релевантные тесты
791
- - проверять изменения функционального кода
792
- - проверять изменения документов истины
793
- - держать secrets вне документации
794
- - держать специфичные для репозитория инструкции вне managed blocks
795
- - проверять diff сгенерированных интерфейсов workflow после upgrades
796
- - сохранять человеческое владение продуктовыми и архитектурными решениями
797
-
798
- Truthmark делает видимой ориентированную на агента истину репозитория. Он не заменяет человеческое суждение.
799
-
800
- ## Направление roadmap
801
-
802
- Текущее будущее направление делает акцент на:
803
-
804
- - более подробной отчетности по подтверждениям в `truthmark check`
805
- - более ясных примерах adoption
806
- - примерных репозиториях, показывающих реальные циклы Truth Sync
807
- - migration guides для команд, уже использующих agent instruction files
808
- - conformance tests для generated host surfaces
809
- - route-aware подсказках о stale truth
810
- - ограниченных implementation checklists для doc-first work
811
-
812
- Центр тяжести остается прежним:
813
-
814
- ```text
815
- истина репозитория
816
- agent-native workflows
817
- Git review
818
- документация в пределах ветки
819
- ```
820
-
821
- ## Лицензия
822
-
823
- MIT. См. [LICENSE](LICENSE).