truthmark 1.6.0 → 2.1.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 +120 -106
- package/README.es.md +137 -123
- package/README.md +59 -45
- package/README.ru.md +109 -95
- package/README.zh.md +108 -96
- package/dist/main.js +1235 -612
- package/dist/main.js.map +1 -1
- package/package.json +1 -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,9 @@ truthmark init
|
|
|
153
153
|
- файлы маршрутов
|
|
154
154
|
- scaffolding документов истины
|
|
155
155
|
- управляемые блоки инструкций
|
|
156
|
-
-
|
|
156
|
+
- интерфейсы рабочих процессов для ИИ для настроенных платформ
|
|
157
|
+
|
|
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.
|
|
157
159
|
|
|
158
160
|
### Проверить настройку
|
|
159
161
|
|
|
@@ -163,20 +165,28 @@ truthmark check
|
|
|
163
165
|
|
|
164
166
|
Затем проверьте сгенерированные файлы перед коммитом.
|
|
165
167
|
|
|
166
|
-
Точный набор файлов зависит от `.truthmark/config.yml`, но форма установки всегда одна: routing, truth scaffolding, компактные managed instructions и host-native workflow
|
|
168
|
+
Точный набор файлов зависит от `.truthmark/config.yml`, но форма установки всегда одна: routing, truth scaffolding, компактные managed instructions и host-native интерфейсы workflow для включённых платформ.
|
|
167
169
|
|
|
168
170
|
## Первое реальное использование
|
|
169
171
|
|
|
170
172
|
Большинству репозиториев после инициализации нужен один этап очистки.
|
|
171
173
|
|
|
172
|
-
Стандартный scaffold начинается с широкого area `
|
|
174
|
+
Стандартный scaffold начинается с широкого area `repo`. Реальным репозиториям обычно нужна более точная маршрутизация.
|
|
173
175
|
|
|
174
176
|
Попросите агента разделить широкий маршрут на реальные области продукта, сервиса, домена или владения:
|
|
175
177
|
|
|
176
178
|
```text
|
|
177
|
-
/truthmark-structure раздели широкий
|
|
179
|
+
/truthmark-structure раздели широкий repo area на auth, billing и notifications
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Если в проекте уже есть реализованные функции, но документы истины отсутствуют или слабы, попросите установленный workflow Truth Document задокументировать сфокусированный scope:
|
|
183
|
+
|
|
184
|
+
```text
|
|
185
|
+
/truthmark-document задокументируй реализованное поведение payment retry в src/billing/retry.ts и связанных тестах
|
|
178
186
|
```
|
|
179
187
|
|
|
188
|
+
Truth Document — самый частый первый workflow для существующих проектов. Он инспектирует реализацию, тесты, маршруты и существующие документы, затем создает или исправляет документы истины и маршрутизацию, не меняя функциональный код.
|
|
189
|
+
|
|
180
190
|
После этого используйте своего ИИ-агента для разработки как обычно.
|
|
181
191
|
|
|
182
192
|
Когда агент меняет функциональный код, Truth Sync действует как финальная защита, которая перед передачей работы проверяет, должны ли измениться сопоставленные документы истины.
|
|
@@ -185,8 +195,8 @@ truthmark check
|
|
|
185
195
|
|
|
186
196
|
| Возможность | Что она делает |
|
|
187
197
|
| --- | --- |
|
|
188
|
-
| Git-native истина | Хранит
|
|
189
|
-
|
|
|
198
|
+
| Git-native истина | Хранит актуальное описание репозитория в зафиксированных Markdown и config. |
|
|
199
|
+
| Документация в пределах ветки | Истина движется с веткой вместо жизни в приватной сессии. |
|
|
190
200
|
| CLI для людей | Дает мейнтейнерам команды настройки, обновления, валидации и инспекции. |
|
|
191
201
|
| Workflows для ИИ | Дает агентам host-native workflows для sync, documentation, structure, preview, realization и audit. |
|
|
192
202
|
| Явная маршрутизация | Сопоставляет области кода с каноническими документами истины. |
|
|
@@ -200,7 +210,7 @@ truthmark check
|
|
|
200
210
|
|
|
201
211
|

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

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