truthmark 1.6.1 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.de.md +116 -107
- package/README.es.md +133 -124
- package/README.md +55 -46
- package/README.ru.md +105 -96
- package/README.zh.md +104 -97
- package/dist/main.js +2092 -1047
- package/dist/main.js.map +1 -1
- package/package.json +4 -1
package/README.ru.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**Ваши агенты пишут код. Truthmark
|
|
3
|
+
**Ваши агенты пишут код. Truthmark поддерживает документацию для людей, версионируемую и проверяемую в Git.**
|
|
4
4
|
|
|
5
5
|
[English](README.md) | [Deutsch](README.de.md) | [中文](README.zh.md) | [Español](README.es.md) | Русский
|
|
6
6
|
|
|
7
7
|

|
|
8
8
|
|
|
9
|
-
ИИ-агенты
|
|
9
|
+
ИИ-агенты разработки могут менять репозиторий быстрее, чем люди успевают поддерживать его документацию в актуальном состоянии.
|
|
10
10
|
|
|
11
|
-
Truthmark чинит ту часть, которая обычно ломается после написания кода:
|
|
11
|
+
Truthmark чинит ту часть, которая обычно ломается после написания кода: актуальное описание репозитория.
|
|
12
12
|
|
|
13
13
|
Он устанавливает Git-native, ограниченный веткой слой рабочего процесса, который помогает ИИ-агентам обновлять правильные документы, соблюдать границы владения и оставлять людям обычные diff для ревью.
|
|
14
14
|
|
|
@@ -20,11 +20,11 @@ Truthmark чинит ту часть, которая обычно ломаетс
|
|
|
20
20
|
|
|
21
21
|
Без дополнительного сервера в эксплуатации.
|
|
22
22
|
|
|
23
|
-
Только
|
|
23
|
+
Только актуальное описание репозитория, которое движется вместе с веткой.
|
|
24
24
|
|
|
25
25
|
## Проблема
|
|
26
26
|
|
|
27
|
-
ИИ-агенты
|
|
27
|
+
ИИ-агенты разработки хорошо создают код. Это порождает новый режим отказа.
|
|
28
28
|
|
|
29
29
|
Реализация меняется, но история репозитория начинает расходиться:
|
|
30
30
|
|
|
@@ -33,11 +33,11 @@ Truthmark чинит ту часть, которая обычно ломаетс
|
|
|
33
33
|
- продуктовые решения исчезают после передачи работы
|
|
34
34
|
- ревьюеры видят diff кода без связанных diff истины
|
|
35
35
|
- ветки незаметно развивают разные версии того, «что является правдой»
|
|
36
|
-
- каждой сессии агента приходится заново
|
|
36
|
+
- каждой сессии агента приходится заново понимать актуальное состояние репозитория
|
|
37
37
|
|
|
38
|
-
Truthmark превращает
|
|
38
|
+
Truthmark превращает это хрупкое описание текущего состояния в зафиксированную инфраструктуру репозитория.
|
|
39
39
|
|
|
40
|
-
Вместо надежды на то, что каждый человек и каждый агент вспомнят
|
|
40
|
+
Вместо надежды на то, что каждый человек и каждый агент вспомнят нужную дисциплину документирования, Truthmark устанавливает эту привычку в репозиторий.
|
|
41
41
|
|
|
42
42
|
## Обещание
|
|
43
43
|
|
|
@@ -56,17 +56,17 @@ Truth Sync проверяет сопоставленные документы и
|
|
|
56
56
|
|
|
57
57
|
Главная ценность такова: **ИИ-работе легче доверять, потому что репозиторий остается понятным.**
|
|
58
58
|
|
|
59
|
-
##
|
|
59
|
+
## Два интерфейса, одна система истины
|
|
60
60
|
|
|
61
61
|
Truthmark — это не только CLI.
|
|
62
62
|
|
|
63
|
-
У него
|
|
63
|
+
У него два разных интерфейса, и это различие важно.
|
|
64
64
|
|
|
65
65
|
### 1. CLI для людей
|
|
66
66
|
|
|
67
67
|
CLI предназначен для мейнтейнеров, ревьюеров и автоматизации.
|
|
68
68
|
|
|
69
|
-
Используйте его, чтобы настроить репозиторий, установить или обновить файлы рабочих процессов, проверить артефакты истины и создать
|
|
69
|
+
Используйте его, чтобы настроить репозиторий, установить или обновить файлы рабочих процессов, проверить артефакты истины и создать дополнительные материалы для ревью.
|
|
70
70
|
|
|
71
71
|
```bash
|
|
72
72
|
truthmark config
|
|
@@ -78,11 +78,11 @@ CLI подготавливает и валидирует среду репози
|
|
|
78
78
|
|
|
79
79
|
Он не является runtime для ИИ-рабочего процесса.
|
|
80
80
|
|
|
81
|
-
### 2.
|
|
81
|
+
### 2. Интерфейсы рабочих процессов для ИИ
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
Интерфейсы для ИИ предназначены для coding agents.
|
|
84
84
|
|
|
85
|
-
Truthmark устанавливает host-native skills, prompts, commands, управляемые блоки инструкций и поддерживаемые
|
|
85
|
+
Truthmark устанавливает host-native skills, prompts, commands, управляемые блоки инструкций и поддерживаемые интерфейсы subagents, чтобы ИИ-агенты могли следовать специфичным для репозитория truth-workflows внутри своих обычных инструментов разработки.
|
|
86
86
|
|
|
87
87
|
Примеры:
|
|
88
88
|
|
|
@@ -105,7 +105,7 @@ Truthmark устанавливает host-native skills, prompts, commands, уп
|
|
|
105
105
|
|
|
106
106
|
```text
|
|
107
107
|
люди владеют контрактом репозитория
|
|
108
|
-
Truthmark устанавливает контракт в
|
|
108
|
+
Truthmark устанавливает контракт в репозиторий
|
|
109
109
|
агенты работают внутри этого контракта
|
|
110
110
|
обновления истины появляются как Git diff
|
|
111
111
|
люди проверяют результат
|
|
@@ -142,7 +142,7 @@ truthmark config
|
|
|
142
142
|
|
|
143
143
|
Проверьте этот файл перед продолжением. Он определяет зафиксированный контракт иерархии для репозитория.
|
|
144
144
|
|
|
145
|
-
### Установить
|
|
145
|
+
### Установить интерфейсы рабочих процессов
|
|
146
146
|
|
|
147
147
|
```bash
|
|
148
148
|
truthmark init
|
|
@@ -153,7 +153,7 @@ truthmark init
|
|
|
153
153
|
- файлы маршрутов
|
|
154
154
|
- scaffolding документов истины
|
|
155
155
|
- управляемые блоки инструкций
|
|
156
|
-
-
|
|
156
|
+
- интерфейсы рабочих процессов для ИИ для настроенных платформ
|
|
157
157
|
|
|
158
158
|
Обоснование стандартных шаблонов документов истины находится в [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.
|
|
159
159
|
|
|
@@ -165,20 +165,28 @@ truthmark check
|
|
|
165
165
|
|
|
166
166
|
Затем проверьте сгенерированные файлы перед коммитом.
|
|
167
167
|
|
|
168
|
-
Точный набор файлов зависит от `.truthmark/config.yml`, но форма установки всегда одна: routing, truth scaffolding, компактные managed instructions и host-native workflow
|
|
168
|
+
Точный набор файлов зависит от `.truthmark/config.yml`, но форма установки всегда одна: routing, truth scaffolding, компактные managed instructions и host-native интерфейсы workflow для включённых платформ.
|
|
169
169
|
|
|
170
170
|
## Первое реальное использование
|
|
171
171
|
|
|
172
172
|
Большинству репозиториев после инициализации нужен один этап очистки.
|
|
173
173
|
|
|
174
|
-
Стандартный scaffold начинается с широкого area `
|
|
174
|
+
Стандартный scaffold начинается с широкого area `repo`. Реальным репозиториям обычно нужна более точная маршрутизация.
|
|
175
175
|
|
|
176
176
|
Попросите агента разделить широкий маршрут на реальные области продукта, сервиса, домена или владения:
|
|
177
177
|
|
|
178
178
|
```text
|
|
179
|
-
/truthmark-structure раздели широкий
|
|
179
|
+
/truthmark-structure раздели широкий repo area на auth, billing и notifications
|
|
180
180
|
```
|
|
181
181
|
|
|
182
|
+
Если в проекте уже есть реализованные функции, но документы истины отсутствуют или слабы, попросите установленный workflow Truth Document задокументировать сфокусированный scope:
|
|
183
|
+
|
|
184
|
+
```text
|
|
185
|
+
/truthmark-document задокументируй реализованное поведение payment retry в src/billing/retry.ts и связанных тестах
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Truth Document — самый частый первый workflow для существующих проектов. Он инспектирует реализацию, тесты, маршруты и существующие документы, затем создает или исправляет документы истины и маршрутизацию, не меняя функциональный код.
|
|
189
|
+
|
|
182
190
|
После этого используйте своего ИИ-агента для разработки как обычно.
|
|
183
191
|
|
|
184
192
|
Когда агент меняет функциональный код, Truth Sync действует как финальная защита, которая перед передачей работы проверяет, должны ли измениться сопоставленные документы истины.
|
|
@@ -187,8 +195,8 @@ truthmark check
|
|
|
187
195
|
|
|
188
196
|
| Возможность | Что она делает |
|
|
189
197
|
| --- | --- |
|
|
190
|
-
| Git-native истина | Хранит
|
|
191
|
-
|
|
|
198
|
+
| Git-native истина | Хранит актуальное описание репозитория в зафиксированных Markdown и config. |
|
|
199
|
+
| Документация в пределах ветки | Истина движется с веткой вместо жизни в приватной сессии. |
|
|
192
200
|
| CLI для людей | Дает мейнтейнерам команды настройки, обновления, валидации и инспекции. |
|
|
193
201
|
| Workflows для ИИ | Дает агентам host-native workflows для sync, documentation, structure, preview, realization и audit. |
|
|
194
202
|
| Явная маршрутизация | Сопоставляет области кода с каноническими документами истины. |
|
|
@@ -202,7 +210,7 @@ truthmark check
|
|
|
202
210
|
|
|
203
211
|

|
|
204
212
|
|
|
205
|
-
**Возможности:** что устанавливает Truthmark и как
|
|
213
|
+
**Возможности:** что устанавливает Truthmark и как устроен интерфейс workflow.
|
|
206
214
|
|
|
207
215
|

|
|
208
216
|
|
|
@@ -229,11 +237,11 @@ Truthmark помогает командам отвечать на это с по
|
|
|
229
237
|
- меньший дрейф документации
|
|
230
238
|
- лучшие передачи работы
|
|
231
239
|
- продуктовая истина, специфичная для ветки
|
|
232
|
-
-
|
|
240
|
+
- долговечная архитектурная и API-документация
|
|
233
241
|
- явное владение между документацией и кодом
|
|
234
242
|
- более безопасные границы записи для агентов
|
|
235
|
-
-
|
|
236
|
-
- ИИ-workflows, которые продолжают работать из зафиксированных файлов
|
|
243
|
+
- проверяемая документация вместо скрытой памяти
|
|
244
|
+
- ИИ-workflows, которые продолжают работать из зафиксированных файлов репозитория
|
|
237
245
|
|
|
238
246
|
## Где уместен Truthmark
|
|
239
247
|
|
|
@@ -248,12 +256,12 @@ Truthmark не заменяет prompts, memory, specs, tests или code review
|
|
|
248
256
|
| Работа над функцией plan-first | Spec workflow |
|
|
249
257
|
| Истина в пределах ветки, которая путешествует с кодом | Truthmark |
|
|
250
258
|
| Проверка корректности поведения | Tests and review |
|
|
251
|
-
| Ревью
|
|
259
|
+
| Ревью изменений документации, выполненных с ИИ | Truthmark plus Git review |
|
|
252
260
|
|
|
253
261
|
Область Truthmark намеренно узкая:
|
|
254
262
|
|
|
255
263
|
```text
|
|
256
|
-
сделать
|
|
264
|
+
сделать актуальное состояние репозитория явным
|
|
257
265
|
связать ее с кодом
|
|
258
266
|
установить вокруг нее workflows агентов
|
|
259
267
|
сохранить результат проверяемым в Git
|
|
@@ -265,7 +273,7 @@ Truthmark работает локально с активным Git worktree.
|
|
|
265
273
|
|
|
266
274
|
CLI для людей читает и записывает файлы репозитория, а затем завершается.
|
|
267
275
|
|
|
268
|
-
|
|
276
|
+
Интерфейсы рабочих процессов для ИИ — это зафиксированные файлы, которые agent hosts могут загрузить позже. Поэтому агенты могут следовать установленному workflow из состояния репозитория, не завися от фонового процесса Truthmark.
|
|
269
277
|
|
|
270
278
|
Эти слои связаны так:
|
|
271
279
|
|
|
@@ -283,9 +291,9 @@ flowchart LR
|
|
|
283
291
|
|
|
284
292
|
Agents не подключаются к daemon Truthmark, но могут запускать установленный Truthmark CLI, когда workflow требует validation, indexing или helper checks.
|
|
285
293
|
|
|
286
|
-
Truthmark владеет сгенерированными workflow
|
|
294
|
+
Truthmark владеет сгенерированными интерфейсами workflow, но главный контракт архитектурный: repo-local config и routing направляют agents к каноническим truth docs, а host-native workflows дают каждому поддерживаемому agent способ выполнять одни и те же процедуры Truthmark.
|
|
287
295
|
|
|
288
|
-
Сгенерированные
|
|
296
|
+
Сгенерированные интерфейсы workflow включают маркеры версии Truthmark. После обновления Truthmark снова выполните:
|
|
289
297
|
|
|
290
298
|
```bash
|
|
291
299
|
truthmark init
|
|
@@ -303,9 +311,9 @@ truthmark init
|
|
|
303
311
|
truthmark init
|
|
304
312
|
```
|
|
305
313
|
|
|
306
|
-
| Имя платформы в config |
|
|
314
|
+
| Имя платформы в config | Сгенерированный интерфейс | Форма вызова |
|
|
307
315
|
| --- | --- | --- |
|
|
308
|
-
| `codex` | `.
|
|
316
|
+
| `codex` | `.agents/skills/truthmark-*/`, `.codex/agents/` | `/truthmark-*` или `$truthmark-*` |
|
|
309
317
|
| `claude-code` | `.claude/skills/truthmark-*/`, `.claude/agents/`, `CLAUDE.md` | `/truthmark-*` |
|
|
310
318
|
| `github-copilot` | `.github/skills/truthmark-*/`, `.github/prompts/`, `.github/agents/`, `.github/copilot-instructions.md` | `/truthmark-*` в поддерживаемых Copilot IDE; custom agents `@truth-*` в Copilot CLI |
|
|
311
319
|
| `opencode` | `.opencode/skills/truthmark-*/`, `.opencode/agents/` | `/skill truthmark-*` |
|
|
@@ -323,24 +331,24 @@ truthmark init
|
|
|
323
331
|
|
|
324
332
|
| Workflow | Направление | Когда использовать | Граница записи |
|
|
325
333
|
| --- | --- | --- | --- |
|
|
326
|
-
| Truth Structure | topology-first | Стандартный маршрут слишком широкий, владение охватывает несколько областей или файлы маршрутов все еще указывают на placeholders. | Создает или
|
|
327
|
-
| Truth Document | implementation-first | Поведение уже есть в коде, но канонические документы истины отсутствуют или слабы. | Пишет только документы истины и
|
|
334
|
+
| Truth Structure | topology-first | Стандартный маршрут слишком широкий, владение охватывает несколько областей или файлы маршрутов все еще указывают на placeholders. | Создает или исправляет маршрутизацию и стартовые документы истины. |
|
|
335
|
+
| Truth Document | implementation-first | Поведение уже есть в коде, но канонические документы истины отсутствуют или слабы. | Пишет только документы истины и маршрутизацию. Функциональный код менять нельзя. |
|
|
328
336
|
| Truth Sync | code-first | Функциональный код изменился, и сопоставленные документы истины могут потребовать обновления перед передачей. | Обновляет документы истины. Truth Sync не должен переписывать функциональный код. |
|
|
329
|
-
| Truth Preview | read-only | Агенту нужно предварительно понять
|
|
337
|
+
| Truth Preview | read-only | Агенту нужно предварительно понять вероятную маршрутизацию перед правками. | Только чтение. Не авторизует записи. |
|
|
330
338
|
| Truth Realize | doc-first | Продуктовые или архитектурные документы истины ведут, и код нужно обновить под них. | Обновляет только код. Агент не должен редактировать документы истины, которые реализует. |
|
|
331
|
-
| Truth Check | audit-first | Ревьюеру или агенту нужно проверить
|
|
339
|
+
| Truth Check | audit-first | Ревьюеру или агенту нужно проверить актуальность истины репозитория. | Аудитирует и сообщает. |
|
|
332
340
|
| Truthmark Portal | presentation-only | Человек явно просит доступный для просмотра статический HTML Portal по документам истины репозитория. | Пишет только сгенерированные неканонические статические файлы в настроенную директорию вывода Portal. |
|
|
333
341
|
|
|
334
342
|
### Важное различие
|
|
335
343
|
|
|
336
|
-
Не путайте эти
|
|
344
|
+
Не путайте эти два интерфейса:
|
|
337
345
|
|
|
338
|
-
|
|
|
346
|
+
| Интерфейс | Используется | Пример | Значение |
|
|
339
347
|
| --- | --- | --- | --- |
|
|
340
348
|
| CLI для людей | людьми, скриптами, CI-подобными проверками | `truthmark check` | Проверить артефакты истины репозитория из терминала. |
|
|
341
349
|
| Workflow для ИИ | coding agents и agent hosts | `/truthmark-check` | Попросить агента выполнить установленный audit workflow. |
|
|
342
350
|
|
|
343
|
-
Имена намеренно похожи, но
|
|
351
|
+
Имена намеренно похожи, но интерфейсы разные.
|
|
344
352
|
|
|
345
353
|
## Обычное изменение кода с помощью ИИ
|
|
346
354
|
|
|
@@ -365,15 +373,19 @@ Truth Sync проверяет сопоставленные документы и
|
|
|
365
373
|
|
|
366
374
|
## Существующее поведение без docs
|
|
367
375
|
|
|
368
|
-
Используйте Truth Document, когда реализация уже существует, но истина репозитория неполна.
|
|
376
|
+
Используйте Truth Document, когда реализация уже существует, но истина репозитория неполна. Это обычный путь для зрелых репозиториев, которые внедряют Truthmark после того, как кодовая база уже существует.
|
|
369
377
|
|
|
370
378
|
```text
|
|
371
|
-
/truthmark-document задокументируй реализованное поведение session timeout в
|
|
379
|
+
/truthmark-document задокументируй реализованное поведение session timeout в src/auth/session.ts, src/auth/middleware.ts и tests/auth/session.test.ts
|
|
372
380
|
```
|
|
373
381
|
|
|
374
|
-
|
|
382
|
+
Укажите имя функции, пути к коду, пути к тестам или желаемую область truth-документов. В OpenCode-подобных хостах тот же workflow вызывается как `/skill truthmark-document ...`; в Gemini CLI используйте `/truthmark:doc ...`.
|
|
383
|
+
|
|
384
|
+
Для большого репозитория, где все еще есть один широкий placeholder-маршрут, сначала запустите Truth Structure, а затем вызывайте Truth Document для одной ограниченной функции или области за раз.
|
|
385
|
+
|
|
386
|
+
Truth Document проверяет реализацию, тесты, файлы маршрутов и существующие документы как подтверждения.
|
|
375
387
|
|
|
376
|
-
Он пишет только документы истины и
|
|
388
|
+
Он пишет только документы истины и маршрутизацию.
|
|
377
389
|
|
|
378
390
|
Он не должен менять функциональный код.
|
|
379
391
|
|
|
@@ -382,7 +394,7 @@ Truth Document проверяет реализацию, тесты, файлы
|
|
|
382
394
|
Используйте Truth Realize, когда продуктовое или архитектурное решение начинается в docs и код нужно обновить под него.
|
|
383
395
|
|
|
384
396
|
```text
|
|
385
|
-
/truthmark-realize реализуй docs/truth/authentication/session-timeout.md в коде
|
|
397
|
+
/truthmark-realize реализуй docs/truthmark/truth/authentication/session-timeout.md в коде
|
|
386
398
|
```
|
|
387
399
|
|
|
388
400
|
Truth Realize работает doc-first.
|
|
@@ -426,10 +438,10 @@ truthmark check
|
|
|
426
438
|
| Команда | Назначение |
|
|
427
439
|
| --- | --- |
|
|
428
440
|
| `truthmark config` | Создает `.truthmark/config.yml`. Пишет только этот файл, если не используется `--stdout`. |
|
|
429
|
-
| `truthmark init` | Устанавливает или обновляет настроенные
|
|
441
|
+
| `truthmark init` | Устанавливает или обновляет настроенные интерфейсы workflow из проверенной config. |
|
|
430
442
|
| `truthmark check` | Валидирует config, authority, routing, документы с decisions, frontmatter, внутренние ссылки, branch scope, generated surfaces, freshness и coverage diagnostics. |
|
|
431
443
|
|
|
432
|
-
Необязательные helpers repository-intelligence создают
|
|
444
|
+
Необязательные helpers repository-intelligence создают производные материалы для ревью активного checkout, например артефакты RepoIndex, RouteMap, ImpactSet и ограниченные ContextPack. Сгенерированные 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.
|
|
433
445
|
|
|
434
446
|
Они не являются источниками истины.
|
|
435
447
|
|
|
@@ -437,7 +449,7 @@ truthmark check
|
|
|
437
449
|
| --- | --- |
|
|
438
450
|
| `truthmark index` | Строит JSON RepoIndex и RouteMap для активного checkout. |
|
|
439
451
|
| `truthmark impact --base <ref>` | Сопоставляет измененные файлы с routed truth docs, owning routes, nearby tests и public symbols. |
|
|
440
|
-
| `truthmark
|
|
452
|
+
| `truthmark ctx --workflow <workflow> [--base <ref>]` | Генерирует ограниченный ContextPack для Truth Sync, Truth Document или Truth Realize. Используйте `--format markdown` для человекочитаемой версии. |
|
|
441
453
|
|
|
442
454
|
Структурированный вывод доступен с `--json` там, где поддерживается.
|
|
443
455
|
|
|
@@ -456,10 +468,10 @@ Truthmark Portal — опциональный презентационный wor
|
|
|
456
468
|
Включите его namespaced config-блоком:
|
|
457
469
|
|
|
458
470
|
```yaml
|
|
459
|
-
truthmark
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
471
|
+
truthmark:
|
|
472
|
+
generated:
|
|
473
|
+
portal:
|
|
474
|
+
enabled: true
|
|
463
475
|
```
|
|
464
476
|
|
|
465
477
|
Затем запустите снова:
|
|
@@ -468,7 +480,7 @@ truthmark-portal:
|
|
|
468
480
|
truthmark init
|
|
469
481
|
```
|
|
470
482
|
|
|
471
|
-
Когда Portal включен, Truthmark устанавливает host-native Portal workflow
|
|
483
|
+
Когда Portal включен, Truthmark устанавливает host-native Portal-интерфейсы workflow для настроенных платформ, например `/truthmark-portal` или `/truthmark:portal` в зависимости от agent host.
|
|
472
484
|
|
|
473
485
|
## Конфигурация
|
|
474
486
|
|
|
@@ -497,15 +509,12 @@ truthmark init
|
|
|
497
509
|
| Область config | Назначение |
|
|
498
510
|
| --- | --- |
|
|
499
511
|
| `version` | Версия контракта config. |
|
|
500
|
-
| `platforms` | Agent hosts, которые должны получить сгенерированные
|
|
501
|
-
| `
|
|
502
|
-
| `
|
|
503
|
-
|
|
|
504
|
-
|
|
|
505
|
-
| `
|
|
506
|
-
| `docs.routing.max_delegation_depth` | Текущая максимальная глубина делегирования routing. |
|
|
507
|
-
| `truthmark-portal` | Опциональные настройки ручного презентационного workflow: `enabled`, `output` и `template`. |
|
|
508
|
-
| `authority` | Упорядоченные канонические docs и globs, используемые как authority истины репозитория. |
|
|
512
|
+
| `platforms` | Agent hosts, которые должны получить сгенерированные интерфейсы для платформы. |
|
|
513
|
+
| `truthmark.workspace` | Workspace, принадлежащий Truthmark, для маршрутов, документов истины, шаблонов и сгенерированного презентационного вывода. |
|
|
514
|
+
| Фиксированные маршруты | Маршруты находятся в `routes/areas.md` и `routes/areas/` внутри `truthmark.workspace`; область по умолчанию — `repository`, глубина делегирования — `1`. |
|
|
515
|
+
| Фиксированные дорожки истины | Product truth находится в `product/`, а engineering truth в `engineering/` внутри `truthmark.workspace`. |
|
|
516
|
+
| Фиксированные шаблоны | Шаблоны документов истины находятся в `templates/` внутри `truthmark.workspace`. |
|
|
517
|
+
| `truthmark.generated.portal` | Опциональное включение ручного презентационного workflow: `enabled`. |
|
|
509
518
|
| `instruction_targets` | Файлы, которые получают общие управляемые блоки инструкций, например `AGENTS.md`. |
|
|
510
519
|
| `frontmatter.required` | Поля metadata, которые создают error diagnostics при отсутствии. |
|
|
511
520
|
| `frontmatter.recommended` | Поля metadata, которые создают review diagnostics при отсутствии. |
|
|
@@ -518,8 +527,8 @@ Truthmark сопоставляет code surfaces с документами ис
|
|
|
518
527
|
Основные файлы маршрутизации:
|
|
519
528
|
|
|
520
529
|
```text
|
|
521
|
-
docs/truthmark/areas.md
|
|
522
|
-
docs/truthmark/areas/**/*.md
|
|
530
|
+
docs/truthmark/routes/areas.md
|
|
531
|
+
docs/truthmark/routes/areas/**/*.md
|
|
523
532
|
```
|
|
524
533
|
|
|
525
534
|
Маршрут сообщает агенту:
|
|
@@ -534,7 +543,7 @@ docs/truthmark/areas/**/*.md
|
|
|
534
543
|
Пример:
|
|
535
544
|
|
|
536
545
|
```text
|
|
537
|
-
/truthmark-structure раздели широкий
|
|
546
|
+
/truthmark-structure раздели широкий repo area на frontend, backend, billing и deployment
|
|
538
547
|
```
|
|
539
548
|
|
|
540
549
|
Хороший routing дает Truth Sync точные цели.
|
|
@@ -549,12 +558,12 @@ Truthmark устанавливает компактный, встроенный
|
|
|
549
558
|
|
|
550
559
|
- config и routing для границ владения
|
|
551
560
|
- канонические truth docs и стартовые шаблоны
|
|
552
|
-
- компактные управляемые instruction blocks для repo-wide agent
|
|
561
|
+
- компактные управляемые instruction blocks для repo-wide agent instructions
|
|
553
562
|
- host-native workflow packages, commands, prompts и verifier agents для платформ, включённых в config
|
|
554
563
|
|
|
555
564
|
Truthmark сохраняет ручной контент вне управляемых блоков инструкций.
|
|
556
565
|
|
|
557
|
-
Сгенерированные
|
|
566
|
+
Сгенерированные интерфейсы workflow управляются Truthmark и могут обновляться повторным запуском:
|
|
558
567
|
|
|
559
568
|
```bash
|
|
560
569
|
truthmark init
|
|
@@ -627,13 +636,13 @@ truthmark check
|
|
|
627
636
|
### Разделить широкий routing
|
|
628
637
|
|
|
629
638
|
```text
|
|
630
|
-
/truthmark-structure раздели широкий
|
|
639
|
+
/truthmark-structure раздели широкий repo area на auth, billing, notifications и deployment
|
|
631
640
|
```
|
|
632
641
|
|
|
633
642
|
### Документировать реализованное поведение
|
|
634
643
|
|
|
635
644
|
```text
|
|
636
|
-
/truthmark-document задокументируй реализованный password reset flow в docs/truth/authentication
|
|
645
|
+
/truthmark-document задокументируй реализованный password reset flow в docs/truthmark/truth/authentication
|
|
637
646
|
```
|
|
638
647
|
|
|
639
648
|
### Синхронизировать после изменений кода
|
|
@@ -645,7 +654,7 @@ truthmark check
|
|
|
645
654
|
### Реализовать doc-first решение
|
|
646
655
|
|
|
647
656
|
```text
|
|
648
|
-
/truthmark-realize реализуй docs/truth/billing/invoice-retry-policy.md в коде
|
|
657
|
+
/truthmark-realize реализуй docs/truthmark/truth/billing/invoice-retry-policy.md в коде
|
|
649
658
|
```
|
|
650
659
|
|
|
651
660
|
### Проверить здоровье истины из терминала
|
|
@@ -654,25 +663,25 @@ truthmark check
|
|
|
654
663
|
truthmark check
|
|
655
664
|
```
|
|
656
665
|
|
|
657
|
-
### Создать branch-impact
|
|
666
|
+
### Создать summary branch-impact
|
|
658
667
|
|
|
659
668
|
```bash
|
|
660
669
|
truthmark impact --base main
|
|
661
670
|
```
|
|
662
671
|
|
|
663
|
-
### Создать workflow
|
|
672
|
+
### Создать workflow ContextPack
|
|
664
673
|
|
|
665
674
|
```bash
|
|
666
|
-
truthmark
|
|
675
|
+
truthmark ctx --workflow truth-sync --base main --format markdown
|
|
667
676
|
```
|
|
668
677
|
|
|
669
678
|
### Включить опциональный Portal workflow
|
|
670
679
|
|
|
671
680
|
```yaml
|
|
672
|
-
truthmark
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
681
|
+
truthmark:
|
|
682
|
+
generated:
|
|
683
|
+
portal:
|
|
684
|
+
enabled: true
|
|
676
685
|
```
|
|
677
686
|
|
|
678
687
|
```bash
|
|
@@ -690,19 +699,19 @@ Truthmark V1 сейчас предоставляет:
|
|
|
690
699
|
- `truthmark check`
|
|
691
700
|
- `truthmark index`
|
|
692
701
|
- `truthmark impact`
|
|
693
|
-
- `truthmark
|
|
702
|
+
- `truthmark ctx`
|
|
694
703
|
- branch-scope metadata
|
|
695
704
|
- управляемые блоки инструкций
|
|
696
|
-
- сгенерированные
|
|
697
|
-
- сгенерированные
|
|
698
|
-
- сгенерированные
|
|
699
|
-
- сгенерированные
|
|
700
|
-
- сгенерированные
|
|
701
|
-
- сгенерированные
|
|
702
|
-
- опциональные сгенерированные
|
|
705
|
+
- сгенерированные интерфейсы workflow Truth Structure
|
|
706
|
+
- сгенерированные интерфейсы workflow Truth Document
|
|
707
|
+
- сгенерированные интерфейсы workflow Truth Sync
|
|
708
|
+
- сгенерированные интерфейсы workflow Truth Preview
|
|
709
|
+
- сгенерированные интерфейсы workflow Truth Realize
|
|
710
|
+
- сгенерированные интерфейсы workflow Truth Check
|
|
711
|
+
- опциональные сгенерированные интерфейсы workflow Truthmark Portal
|
|
703
712
|
- diagnostics для route, authority, decision-structure, frontmatter, links, freshness, generated-surface и coverage
|
|
704
713
|
- производные артефакты RepoIndex, RouteMap, ImpactSet и ContextPack
|
|
705
|
-
- host-specific
|
|
714
|
+
- host-specific интерфейсы для Codex, Claude Code, GitHub Copilot, OpenCode и Gemini CLI
|
|
706
715
|
|
|
707
716
|
## Разработка
|
|
708
717
|
|
|
@@ -737,7 +746,7 @@ npm run check
|
|
|
737
746
|
| `npm run check` | Запускает lint, typecheck, tests и build. |
|
|
738
747
|
| `npm run release:check` | Запускает release-oriented validation. |
|
|
739
748
|
|
|
740
|
-
Когда меняете сам Truthmark, смотрите [
|
|
749
|
+
Когда меняете сам Truthmark, смотрите [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
741
750
|
|
|
742
751
|
## Документация
|
|
743
752
|
|
|
@@ -746,11 +755,11 @@ README — быстрый путь для оценки и настройки.
|
|
|
746
755
|
Подробное текущее поведение живет в `docs/`:
|
|
747
756
|
|
|
748
757
|
- [Индекс документации](docs/README.md)
|
|
749
|
-
- [Обзор архитектуры](docs/architecture/overview.md)
|
|
750
|
-
- [Контракты API и CLI](docs/truth/contracts.md)
|
|
751
|
-
- [Поведение init и scaffold](docs/truth/init-and-scaffold.md)
|
|
752
|
-
- [Диагностика check](docs/truth/check-diagnostics.md)
|
|
753
|
-
- [Установленные workflows](docs/truth/workflows/overview.md)
|
|
758
|
+
- [Обзор архитектуры](docs/truthmark/truth/architecture/overview.md)
|
|
759
|
+
- [Контракты API и CLI](docs/truthmark/truth/contracts.md)
|
|
760
|
+
- [Поведение init и scaffold](docs/truthmark/truth/init-and-scaffold.md)
|
|
761
|
+
- [Диагностика check](docs/truthmark/truth/check-diagnostics.md)
|
|
762
|
+
- [Установленные workflows](docs/truthmark/truth/workflows/overview.md)
|
|
754
763
|
- [Руководство по поддержанию истины репозитория](docs/standards/maintaining-repository-truth.md)
|
|
755
764
|
|
|
756
765
|
## Границы дизайна
|
|
@@ -784,16 +793,16 @@ Truthmark помогает репозиторию оставаться чест
|
|
|
784
793
|
- проверять изменения документов истины
|
|
785
794
|
- держать secrets вне документации
|
|
786
795
|
- держать специфичные для репозитория инструкции вне managed blocks
|
|
787
|
-
- проверять diff сгенерированных workflow
|
|
796
|
+
- проверять diff сгенерированных интерфейсов workflow после upgrades
|
|
788
797
|
- сохранять человеческое владение продуктовыми и архитектурными решениями
|
|
789
798
|
|
|
790
|
-
Truthmark делает
|
|
799
|
+
Truthmark делает видимой ориентированную на агента истину репозитория. Он не заменяет человеческое суждение.
|
|
791
800
|
|
|
792
801
|
## Направление roadmap
|
|
793
802
|
|
|
794
803
|
Текущее будущее направление делает акцент на:
|
|
795
804
|
|
|
796
|
-
- более
|
|
805
|
+
- более подробной отчетности по подтверждениям в `truthmark check`
|
|
797
806
|
- более ясных примерах adoption
|
|
798
807
|
- примерных репозиториях, показывающих реальные циклы Truth Sync
|
|
799
808
|
- migration guides для команд, уже использующих agent instruction files
|
|
@@ -807,7 +816,7 @@ Truthmark делает контекст агента видимым. Он не
|
|
|
807
816
|
истина репозитория
|
|
808
817
|
agent-native workflows
|
|
809
818
|
Git review
|
|
810
|
-
|
|
819
|
+
документация в пределах ветки
|
|
811
820
|
```
|
|
812
821
|
|
|
813
822
|
## Лицензия
|