truthmark 2.2.2 → 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.
@@ -0,0 +1,225 @@
1
+ # Truthmark
2
+
3
+ **Các tác tử của bạn viết mã. Truthmark duy trì tài liệu hướng tới con người và có thể được xem xét qua Git.**
4
+
5
+ [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
6
+
7
+ ![Biểu ngữ Truthmark](../assets/truthmark-banner.png)
8
+
9
+ ## 🚀 Bắt đầu nhanh: chạy cục bộ trong năm phút
10
+
11
+ Chạy lệnh này bên trong kho Git mà bạn muốn Truthmark quản lý:
12
+
13
+ ```bash
14
+ cd /path/to/your-repo
15
+ npm install -g truthmark
16
+ truthmark config
17
+ ```
18
+
19
+ Bật máy chủ AI mà bạn thực sự sử dụng. Cấu hình mới không gắn với máy chủ nào, vì vậy hãy thêm danh sách `platforms` ở cấp cao nhất vào `.truthmark/config.yml` trước khi khởi tạo:
20
+
21
+ ```yaml
22
+ version: 2
23
+ platforms:
24
+ - codex # or: claude-code, github-copilot, opencode, antigravity, cursor
25
+ truthmark:
26
+ workspace: docs/truthmark
27
+ generated:
28
+ portal:
29
+ enabled: false
30
+ ```
31
+
32
+ Sau đó cài đặt tài liệu sự thật cục bộ của kho, định tuyến và các bề mặt quy trình làm việc cho tác tử:
33
+
34
+ ```bash
35
+ truthmark init
36
+ truthmark check
37
+ git diff
38
+ ```
39
+
40
+ Bây giờ hãy thử lộ trình áp dụng phổ biến nhất: ghi tài liệu cho một hành vi hiện có từ mã và kiểm thử. Trong máy chủ lập trình AI của bạn, hãy yêu cầu quy trình đã cài đặt:
41
+
42
+ ```text
43
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
44
+ ```
45
+
46
+ Sau đó, người dùng thường không nên gọi Truth Sync trực tiếp. Hãy tiếp tục lập trình qua máy chủ AI của bạn; các chỉ dẫn kho đã cài đặt yêu cầu tác tử chạy các kiểm thử liên quan và thực hiện đánh giá Truth Sync trước khi bàn giao khi mã chức năng thay đổi. Bạn xem xét phần diff mã kết quả cùng với diff tài liệu truth.
47
+
48
+ Nếu bạn chỉ muốn xác thực bằng CLI và chưa muốn các quy trình AI theo máy chủ, hãy để trống `platforms` và chạy `truthmark init && truthmark check`; bạn có thể thêm nền tảng sau và chạy lại `truthmark init`.
49
+
50
+ ## 💡 Vấn đề: khoảng trống tài liệu AI
51
+
52
+ Các tác tử lập trình AI cực kỳ giỏi viết mã nhanh. Nhưng tốc độ này tạo ra một kiểu lỗi mới nguy hiểm: **câu chuyện của kho lệch khỏi thực tế.**
53
+
54
+ * Hành vi bị mất trong lịch sử trò chuyện tạm thời.
55
+ * Tài liệu kiến trúc nhanh chóng tụt lại phía sau.
56
+ * Quyết định sản phẩm biến mất sau khi bàn giao.
57
+ * Người xem xét mã phải xem các diff mã thô mà không hiểu "vì sao".
58
+ * Mỗi phiên AI mới buộc phải khám phá lại sự thật của kho từ đầu.
59
+
60
+ ## 🎯 Giải pháp: Truthmark
61
+
62
+ **Truthmark** cài đặt một lớp quy trình làm việc gốc Git vào kho của bạn. Nó khắc phục phần thường bị hỏng trong phát triển bằng AI: giúp tài liệu luôn khớp với mã.
63
+
64
+ Thay vì hy vọng con người và tác tử AI nhớ cập nhật tài liệu, Truthmark biến việc ghi tài liệu thành một thói quen có hệ thống, có thể xem xét ngay trong kho của bạn.
65
+
66
+ ### ✨ Vì sao Truthmark khác biệt
67
+
68
+ Truthmark không chỉ là một công cụ tài liệu khác. Nó được tích hợp sâu vào quy trình AI:
69
+
70
+ * **🚫 Không bị khóa vào nhà cung cấp:** Không dịch vụ lưu trữ, không cơ sở dữ liệu ẩn, không máy chủ bổ sung để vận hành.
71
+ * **🌳 100% gốc Git:** Mọi thứ nằm trong kho của bạn. Sự thật di chuyển cùng nhánh của bạn.
72
+ * **🤝 Hợp đồng do con người sở hữu, tác tử tuân theo:** Người bảo trì sở hữu hợp đồng kho; tác tử tuân theo hướng dẫn đã cài đặt khi viết mã.
73
+ * **✅ Tin cậy qua xác minh:** Công việc AI dễ được tin tưởng hơn vì công việc thay đổi hành vi bao gồm một quyết định hoặc diff tài liệu sự thật mà con người có thể xem xét.
74
+
75
+ ## 🔄 Cách hoạt động
76
+
77
+ Khi một tác tử AI sửa mã của bạn, công việc chưa kết thúc. Truthmark cài đặt một chốt quy trình lúc hoàn tất mà tác tử tuân theo trước khi bàn giao:
78
+
79
+ 1. 💻 **Mã:** Tác tử sửa mã chức năng.
80
+ 2. 🧪 **Kiểm thử:** Các kiểm thử liên quan được chạy.
81
+ 3. 🔍 **Kiểm tra:** Truthmark kiểm tra tài liệu được ánh xạ như một phần của bước xem xét kết thúc đã cài đặt.
82
+ 4. 📝 **Ghi tài liệu:** Tài liệu được tác tử cập nhật khi sự thật của kho thay đổi.
83
+ 5. 👀 **Xem xét:** Con người xem xét *diff mã* + *diff sự thật*.
84
+
85
+ ## 🛠 Cách bạn tương tác với Truthmark
86
+
87
+ Truthmark có một hợp đồng cục bộ trong kho và hai cách sử dụng nó.
88
+
89
+ ### Con người cài đặt và xác thực hợp đồng
90
+
91
+ Người bảo trì và CI dùng CLI:
92
+
93
+ * `truthmark config` - tạo cấu hình ban đầu.
94
+ * `truthmark init` - cài đặt hoặc làm mới định tuyến, scaffold truth-doc và hướng dẫn cho AI host.
95
+ * `truthmark check` - xác thực sự thật của kho từ terminal.
96
+
97
+ ### Tác tử tuân theo hợp đồng khi viết mã
98
+
99
+ Truthmark cài đặt hướng dẫn cục bộ trong kho cho các AI coding host được hỗ trợ như Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity và Cursor.
100
+
101
+ Vòng lặp bình thường rất đơn giản:
102
+
103
+ 1. Yêu cầu tác tử thay đổi mã hoặc ghi tài liệu cho một hành vi hiện có.
104
+ 2. Hướng dẫn đã cài đặt cho tác tử biết khi nào cần kiểm thử, khi nào cập nhật truth docs và khi nào dừng để con người xem xét.
105
+ 3. Bạn xem xét các Git diff thông thường: mã cộng với mọi thay đổi truth-doc.
106
+
107
+ Các yêu cầu tác tử do người dùng khởi động được cố ý giữ ít:
108
+
109
+ * `/truthmark-document` - ghi tài liệu cho hành vi đã triển khai hiện có từ mã và kiểm thử.
110
+ * `/truthmark-realize` - triển khai mã từ truth docs hiện có.
111
+ * `/truthmark-check` - kiểm toán sự thật của kho.
112
+
113
+ Truth Sync không phải cách thông thường để bắt đầu công việc; đó là bước xem xét kết thúc sau các thay đổi mã chức năng.
114
+ Truth Structure không phải lệnh hằng ngày; nó chỉ sửa định tuyến hoặc quyền sở hữu khi điều đó chặn công việc.
115
+
116
+ ## Bạn nhận được gì
117
+
118
+ | Khả năng | Tác dụng |
119
+ | --- | --- |
120
+ | Sự thật gốc Git | Giữ sự thật của kho trong Markdown và cấu hình đã commit. |
121
+ | Tài liệu theo phạm vi nhánh | Sự thật di chuyển cùng nhánh thay vì sống trong một phiên riêng tư. |
122
+ | CLI dành cho con người | Cung cấp cho người bảo trì các lệnh thiết lập, làm mới, xác thực và kiểm tra. |
123
+ | Hướng dẫn tác tử đã cài đặt | Cho tác tử lập trình biết khi nào ghi tài liệu, kiểm thử, đồng bộ sự thật, kiểm toán hoặc dừng để xem xét. |
124
+ | Định tuyến rõ ràng | Ánh xạ các vùng mã tới tài liệu sự thật chuẩn. |
125
+ | Bàn giao có thể xem xét | Tạo các diff Git thông thường cho cả mã và tài liệu sự thật. |
126
+ | Vận hành ưu tiên cục bộ | Không yêu cầu dịch vụ lưu trữ, daemon, cơ sở dữ liệu hoặc máy chủ MCP. |
127
+ | Ranh giới ghi an toàn hơn | Tách các quy trình code-first, doc-first, chỉ đọc và chỉ tài liệu. |
128
+ | Xác thực | Báo cáo vấn đề về định tuyến, thẩm quyền, frontmatter, liên kết, bề mặt sinh ra, phạm vi nhánh, độ mới và độ phủ. |
129
+ | Portal tùy chọn | Tạo một trang trình bày HTML tĩnh đã commit từ tài liệu sự thật Markdown khi được bật và yêu cầu rõ ràng. |
130
+
131
+ ## Tổng quan trực quan
132
+
133
+ ![Tính năng Truthmark](../assets/truthmark-features.png)
134
+
135
+ **Tính năng:** Truthmark cài đặt gì và bề mặt quy trình được chia như thế nào.
136
+
137
+ ![Vị trí Truthmark](../assets/truthmark-position.png)
138
+
139
+ **Vị trí:** Truthmark nằm ở đâu so với prompt, bộ nhớ và quy trình đặc tả.
140
+
141
+ ![Luồng đồng bộ Truthmark](../assets/truthmark-syncflow.png)
142
+
143
+ **Luồng đồng bộ:** Truth Sync kết thúc các thay đổi mã thông thường trước khi bàn giao như thế nào.
144
+
145
+ ## Vì sao các nhóm áp dụng
146
+
147
+ Truthmark dành cho các nhóm đã biết tác tử AI có thể tạo mã.
148
+
149
+ Vấn đề tiếp theo là quản trị.
150
+
151
+ Không phải quản trị như nghi thức. Quản trị như một câu hỏi đơn giản:
152
+
153
+ > Sau thay đổi được AI hỗ trợ này, kho có còn nói đúng sự thật không?
154
+
155
+ Truthmark giúp các nhóm trả lời điều đó bằng các tệp đã commit, định tuyến rõ ràng và diff có thể xem xét.
156
+
157
+ Nó hữu ích khi bạn cần:
158
+
159
+ - ít trôi lệch tài liệu hơn
160
+ - bàn giao tốt hơn
161
+ - sự thật sản phẩm theo từng nhánh
162
+ - tài liệu kiến trúc và API bền vững
163
+ - quyền sở hữu rõ ràng giữa tài liệu và mã
164
+ - ranh giới ghi an toàn hơn cho tác tử
165
+ - tài liệu có thể xem xét thay vì bộ nhớ ẩn
166
+ - quy trình AI vẫn hoạt động từ các tệp kho đã commit
167
+
168
+ ## Truthmark phù hợp ở đâu
169
+
170
+ Truthmark không thay thế prompt, bộ nhớ, đặc tả, kiểm thử hoặc xem xét mã.
171
+
172
+ Nó cho các quy trình đó một nơi bền vững để hạ cánh trong Git.
173
+
174
+ | Nhu cầu | Phù hợp hơn |
175
+ | --- | --- |
176
+ | Đầu ra tốt hơn từ một phiên tác tử | Prompt tốt hơn |
177
+ | Tính liên tục cá nhân hoặc cấp phiên | Công cụ bộ nhớ |
178
+ | Làm tính năng theo kế hoạch trước | Quy trình đặc tả |
179
+ | Truth theo nhánh đi cùng mã | Truthmark |
180
+ | Xác thực tính đúng của hành vi | Kiểm thử và xem xét |
181
+ | Xem xét thay đổi tài liệu do AI hỗ trợ | Truthmark cộng với xem xét Git |
182
+
183
+ Làn đường của Truthmark được thiết kế có chủ ý là hẹp:
184
+
185
+ ```text
186
+ make repository truth explicit
187
+ route it to code
188
+ cài đặt hướng dẫn tác tử quanh nó
189
+ keep the result reviewable in Git
190
+ ```
191
+
192
+ ## Tìm hiểu sâu hơn
193
+
194
+ README là mặt tiền: ngữ cảnh nhanh, bắt đầu nhanh và mô hình tư duy cốt lõi.
195
+
196
+ Để biết cách sử dụng từng lệnh, so sánh bề mặt, chi tiết nền tảng được hỗ trợ, cấu hình, định tuyến, Portal và ví dụ, hãy đọc [Hướng dẫn người dùng Truthmark](../user-guide.md).
197
+
198
+ ## Trạng thái dự án
199
+
200
+ Bản phát hành hiện tại cung cấp:
201
+
202
+ - các lệnh CLI cục bộ cho config, init, check, index, impact và trạng thái quy trình
203
+ - hướng dẫn tác tử cục bộ trong kho được tạo cho Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity và Cursor
204
+ - chẩn đoán về định tuyến, thẩm quyền, frontmatter, liên kết, độ mới, bề mặt sinh ra, phạm vi nhánh và độ phủ
205
+ - tài liệu sự thật theo phạm vi nhánh và các hiện vật trí tuệ kho được suy dẫn
206
+
207
+ ## Tài liệu
208
+
209
+ - [Hướng dẫn người dùng](../user-guide.md)
210
+ - [Chỉ mục tài liệu](../README.md)
211
+ - [Tổng quan kiến trúc](../truthmark/engineering/architecture/overview.md)
212
+ - [Hợp đồng API và CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
213
+ - [Hướng dẫn bảo trì sự thật của kho](../standards/maintaining-repository-truth.md)
214
+
215
+ Để xem các lệnh phát triển cục bộ và đóng góp, hãy xem [CONTRIBUTING.md](../../CONTRIBUTING.md).
216
+
217
+ ## Ranh giới thiết kế
218
+
219
+ Truthmark được cố ý giữ nhỏ: cục bộ, được commit, theo phạm vi nhánh và có thể xem xét.
220
+
221
+ Nó không phải dịch vụ lưu trữ, máy chủ MCP, cơ sở dữ liệu vector, lớp bộ nhớ ẩn, sản phẩm cưỡng chế CI hay động cơ tự động viết lại mã. Nó giúp sự thật của kho luôn hiển thị; nó không thay thế kiểm thử, xem xét mã hay phán đoán của con người.
222
+
223
+ ## Giấy phép
224
+
225
+ MIT. Xem [LICENSE](../../LICENSE).
@@ -0,0 +1,225 @@
1
+ # Truthmark
2
+
3
+ **你的代理会写代码。Truthmark 维护面向人类、可在 Git 中审查的文档。**
4
+
5
+ [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
6
+
7
+ ![Truthmark 横幅](../assets/truthmark-banner.png)
8
+
9
+ ## 🚀 快速开始:五分钟本地运行
10
+
11
+ 在你希望由 Truthmark 管理的 Git 仓库中运行:
12
+
13
+ ```bash
14
+ cd /path/to/your-repo
15
+ npm install -g truthmark
16
+ truthmark config
17
+ ```
18
+
19
+ 启用你实际使用的 AI 宿主。新配置默认与宿主无关,因此在初始化前,先把顶层 `platforms` 列表添加到 `.truthmark/config.yml`:
20
+
21
+ ```yaml
22
+ version: 2
23
+ platforms:
24
+ - codex # or: claude-code, github-copilot, opencode, antigravity, cursor
25
+ truthmark:
26
+ workspace: docs/truthmark
27
+ generated:
28
+ portal:
29
+ enabled: false
30
+ ```
31
+
32
+ 然后安装仓库本地的事实文档、路由和 AI 宿主指令:
33
+
34
+ ```bash
35
+ truthmark init
36
+ truthmark check
37
+ git diff
38
+ ```
39
+
40
+ 现在尝试最常见的采用路径:根据代码和测试记录一个已有行为。在你的 AI 编码宿主中,请求已安装的工作流:
41
+
42
+ ```text
43
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
44
+ ```
45
+
46
+ 之后,用户通常不应直接调用 Truth Sync。继续通过你的 AI 宿主编写代码;已安装的仓库指令会告诉代理:当功能代码发生变化时,在交接前运行相关测试并执行 Truth Sync 审查。你审查最终的代码 diff 和事实文档 diff。
47
+
48
+ 如果你暂时只想要 CLI 验证,而不需要特定宿主的 AI 工作流,可以省略 `platforms`,并运行 `truthmark init && truthmark check`;之后你可以再添加平台并重新运行 `truthmark init`。
49
+
50
+ ## 💡 问题:AI 文档缺口
51
+
52
+ AI 编码代理非常擅长快速编写代码。但这种速度会产生一种危险的新失效模式:**仓库所讲述的故事与现实发生偏移。**
53
+
54
+ * 行为遗失在短暂的聊天历史中。
55
+ * 架构文档很快落后。
56
+ * 产品决策在交接后消失。
57
+ * 代码审查者只能查看原始代码 diff,却不了解“为什么”。
58
+ * 每个新的 AI 会话都被迫从头重新发现仓库事实。
59
+
60
+ ## 🎯 解决方案:Truthmark
61
+
62
+ **Truthmark** 会在你的仓库中安装一个 Git 原生的工作流层。它修复 AI 开发中通常会坏掉的部分:帮助文档与代码保持一致。
63
+
64
+ Truthmark 不是指望人类和 AI 代理都记得更新文档,而是在你的仓库中把文档变成一种系统化、可审查的习惯。
65
+
66
+ ### ✨ Truthmark 的独特之处
67
+
68
+ Truthmark 不只是另一个文档工具。它深度集成到 AI 工作流中:
69
+
70
+ * **🚫 零供应商锁定:** 没有托管服务、隐藏数据库,也没有需要额外运维的服务器。
71
+ * **🌳 100% Git 原生:** 一切都存在于你的仓库中。事实随分支一起移动。
72
+ * **🤝 人类拥有、代理遵循的契约:**维护者拥有仓库契约;代理在编码时遵循已安装的指令。
73
+ * **✅ 通过验证建立信任:** 因为改变行为的工作会包含可由人类审查的事实文档决策或 diff,AI 工作更容易被信任。
74
+
75
+ ## 🔄 工作原理
76
+
77
+ 当 AI 代理修改你的代码时,工作并未完成。Truthmark 会安装一个交接前的收尾工作流保护,代理在交接前遵循它:
78
+
79
+ 1. 💻 **代码:** 代理修改功能代码。
80
+ 2. 🧪 **测试:** 执行相关测试。
81
+ 3. 🔍 **检查:**Truthmark 会把映射到的文档作为已安装收尾审查的一部分进行检查。
82
+ 4. 📝 **记录:** 当仓库事实发生变化时,代理更新文档。
83
+ 5. 👀 **审查:** 人类审查*代码 diff* + *事实 diff*。
84
+
85
+ ## 🛠 你如何使用 Truthmark
86
+
87
+ Truthmark 有一个仓库本地契约,以及两种使用方式。
88
+
89
+ ### 人类安装并验证契约
90
+
91
+ 维护者和 CI 使用 CLI:
92
+
93
+ * `truthmark config` - 创建初始配置。
94
+ * `truthmark init` - 安装或刷新路由、事实文档脚手架和 AI 宿主指令。
95
+ * `truthmark check` - 从终端验证仓库事实。
96
+
97
+ ### 代理在编码时遵循契约
98
+
99
+ Truthmark 会为 Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity 和 Cursor 等受支持的 AI 编码宿主安装仓库本地指令。
100
+
101
+ 正常循环很简单:
102
+
103
+ 1. 让代理修改代码,或让它记录已有行为。
104
+ 2. 已安装的指令会告诉代理何时测试、何时更新事实文档、何时停下来交给人类审查。
105
+ 3. 你审查普通的 Git diff:代码,以及任何事实文档变更。
106
+
107
+ 用户主动发起的代理请求刻意保持很少:
108
+
109
+ * `/truthmark-document` - 根据代码和测试记录已有实现行为。
110
+ * `/truthmark-realize` - 根据已有事实文档实现代码。
111
+ * `/truthmark-check` - 审计仓库事实。
112
+
113
+ Truth Sync 不是通常的开工方式;它是功能代码变更后的收尾审查。
114
+ Truth Structure 不是日常命令;只有当路由或所有权阻塞工作时,它才进行修复。
115
+
116
+ ## 你会得到什么
117
+
118
+ | 能力 | 作用 |
119
+ | --- | --- |
120
+ | Git 原生事实 | 将仓库事实保存在已提交的 Markdown 和配置中。 |
121
+ | 按分支生效的文档 | 事实随分支移动,而不是存在于私有会话中。 |
122
+ | 人类 CLI | 为维护者提供设置、刷新、验证和检查命令。 |
123
+ | 已安装的代理指引 | 告诉编码代理何时记录文档、测试、同步事实、审计或停下来等待审查。 |
124
+ | 显式路由 | 将代码区域映射到规范事实文档。 |
125
+ | 可审查交接 | 为代码和事实文档都产生普通 Git diff。 |
126
+ | 本地优先运行 | 不需要托管服务、守护进程、数据库或 MCP 服务器。 |
127
+ | 更安全的写入边界 | 区分代码优先、文档优先、只读和仅文档工作流。 |
128
+ | 验证 | 报告路由、权限、frontmatter、链接、生成界面、分支范围、新鲜度和覆盖率问题。 |
129
+ | 可选 Portal | 在明确启用并请求时,从 Markdown 事实文档生成已提交的静态 HTML 展示站点。 |
130
+
131
+ ## 视觉概览
132
+
133
+ ![Truthmark 功能](../assets/truthmark-features.png)
134
+
135
+ **功能:** Truthmark 会安装什么,以及代理如何使用仓库本地指令。
136
+
137
+ ![Truthmark 定位](../assets/truthmark-position.png)
138
+
139
+ **定位:** Truthmark 相对于提示、记忆和规格工作流的位置。
140
+
141
+ ![Truthmark 同步流程](../assets/truthmark-syncflow.png)
142
+
143
+ **同步流程:** Truth Sync 如何在交接前收尾普通代码变更。
144
+
145
+ ## 团队为什么采用它
146
+
147
+ Truthmark 面向已经知道 AI 代理能够生成代码的团队。
148
+
149
+ 下一个问题是治理。
150
+
151
+ 不是作为仪式的治理。治理只是一个简单问题:
152
+
153
+ > 在这次 AI 辅助变更之后,仓库仍然讲述事实吗?
154
+
155
+ Truthmark 通过已提交文件、显式路由和可审查 diff 帮助团队回答这个问题。
156
+
157
+ 当你需要以下内容时,它很有用:
158
+
159
+ - 减少文档漂移
160
+ - 更好的交接
161
+ - 按分支生效的产品事实
162
+ - 持久的架构和 API 文档
163
+ - 文档和代码之间的明确所有权
164
+ - 更安全的代理写入边界
165
+ - 可审查的文档,而不是隐藏记忆
166
+ - 仍然能从已提交仓库文件运行的 AI 工作流
167
+
168
+ ## Truthmark 的位置
169
+
170
+ Truthmark 不替代提示、记忆、规格、测试或代码审查。
171
+
172
+ 它为这些工作流提供一个可以持久落在 Git 中的位置。
173
+
174
+ | 需求 | 更合适的选择 |
175
+ | --- | --- |
176
+ | 从单次代理会话获得更好输出 | 更好的提示 |
177
+ | 个人或会话级连续性 | 记忆工具 |
178
+ | 先计划后实现的功能工作 | 规格工作流 |
179
+ | 随代码一起移动的按分支事实 | Truthmark |
180
+ | 验证行为正确性 | 测试和审查 |
181
+ | 审查 AI 辅助的文档变更 | Truthmark 加 Git 审查 |
182
+
183
+ Truthmark 的边界有意很窄:
184
+
185
+ ```text
186
+ make repository truth explicit
187
+ route it to code
188
+ 围绕它安装代理指引
189
+ keep the result reviewable in Git
190
+ ```
191
+
192
+ ## 深入了解
193
+
194
+ README 是门面:快速背景、快速开始和核心心智模型。
195
+
196
+ 如需逐条命令的用法、界面对比、受支持平台详情、配置、路由、Portal 和示例,请阅读 [Truthmark 用户指南](../user-guide.md)。
197
+
198
+ ## 项目状态
199
+
200
+ 当前版本提供:
201
+
202
+ - 用于 config、init、check、index、impact 和 workflow status 的本地 CLI 命令
203
+ - 为 Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity 和 Cursor 生成的仓库本地代理指令
204
+ - 路由、权限、frontmatter、链接、新鲜度、生成界面、分支范围和覆盖率诊断
205
+ - 按分支生效的事实文档和派生的仓库智能产物
206
+
207
+ ## 文档
208
+
209
+ - [用户指南](../user-guide.md)
210
+ - [文档索引](../README.md)
211
+ - [架构概览](../truthmark/engineering/architecture/overview.md)
212
+ - [API 和 CLI 契约](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
213
+ - [仓库事实维护指南](../standards/maintaining-repository-truth.md)
214
+
215
+ 有关本地开发和贡献命令,请参阅 [CONTRIBUTING.md](../../CONTRIBUTING.md)。
216
+
217
+ ## 设计边界
218
+
219
+ Truthmark 有意保持小而明确:本地、已提交、按分支生效、可审查。
220
+
221
+ 它不是托管服务、MCP 服务器、向量数据库、隐藏记忆层、CI 强制执行产品,也不是自主代码重写引擎。它帮助仓库事实保持可见;它不替代测试、代码审查或人类判断。
222
+
223
+ ## 许可证
224
+
225
+ MIT。见 [LICENSE](../../LICENSE)。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "truthmark",
3
- "version": "2.2.2",
3
+ "version": "2.2.5",
4
4
  "description": "Git-native, branch-scoped truth workflow installer for local AI coding agents.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -24,10 +24,27 @@
24
24
  "truthmark": "dist/main.js"
25
25
  },
26
26
  "files": [
27
- "dist"
27
+ "dist",
28
+ "README.md",
29
+ "docs/readmes/README.ar.md",
30
+ "docs/readmes/README.de.md",
31
+ "docs/readmes/README.el.md",
32
+ "docs/readmes/README.es.md",
33
+ "docs/readmes/README.fr.md",
34
+ "docs/readmes/README.id.md",
35
+ "docs/readmes/README.it.md",
36
+ "docs/readmes/README.ja.md",
37
+ "docs/readmes/README.ko.md",
38
+ "docs/README.md",
39
+ "docs/readmes/README.pl.md",
40
+ "docs/readmes/README.pt.md",
41
+ "docs/readmes/README.ru.md",
42
+ "docs/readmes/README.tr.md",
43
+ "docs/readmes/README.vi.md",
44
+ "docs/readmes/README.zh.md"
28
45
  ],
29
46
  "engines": {
30
- "node": ">=20"
47
+ "node": ">=24"
31
48
  },
32
49
  "scripts": {
33
50
  "build": "tsup",