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