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.
- package/README.md +83 -682
- package/dist/main.js +524 -754
- package/dist/main.js.map +1 -1
- package/docs/README.md +119 -0
- package/docs/readmes/README.ar.md +225 -0
- package/docs/readmes/README.de.md +225 -0
- package/docs/readmes/README.el.md +225 -0
- package/docs/readmes/README.es.md +225 -0
- package/docs/readmes/README.fr.md +225 -0
- package/docs/readmes/README.id.md +225 -0
- package/docs/readmes/README.it.md +225 -0
- package/docs/readmes/README.ja.md +225 -0
- package/docs/readmes/README.ko.md +225 -0
- package/docs/readmes/README.pl.md +225 -0
- package/docs/readmes/README.pt.md +225 -0
- package/docs/readmes/README.ru.md +225 -0
- package/docs/readmes/README.tr.md +225 -0
- package/docs/readmes/README.vi.md +225 -0
- package/docs/readmes/README.zh.md +225 -0
- package/package.json +20 -3
- package/README.de.md +0 -824
- package/README.es.md +0 -824
- package/README.ru.md +0 -824
- package/README.zh.md +0 -824
|
@@ -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
|
+

|
|
8
|
+
|
|
9
|
+
## 🚀 クイックスタート:5 分でローカル実行
|
|
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
|
+
次に、リポジトリローカルの truth ドキュメント、ルーティング、エージェントワークフローサーフェスをインストールします:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
truthmark init
|
|
36
|
+
truthmark check
|
|
37
|
+
git diff
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
次に、最も一般的な導入パスを試します。コードとテストから既存の振る舞いを 1 つドキュメント化します。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 と truth-doc 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 セッションのたびに、リポジトリの truth を一から再発見しなければなりません。
|
|
59
|
+
|
|
60
|
+
## 🎯 解決策:Truthmark
|
|
61
|
+
|
|
62
|
+
**Truthmark** は、Git ネイティブなワークフロー層をリポジトリにインストールします。AI 開発で通常壊れやすい部分、つまりドキュメントをコードと整合させ続けることを修復します。
|
|
63
|
+
|
|
64
|
+
人間や AI エージェントがドキュメント更新を忘れないことに期待するのではなく、Truthmark はドキュメントを体系的でレビュー可能な習慣としてリポジトリ内に組み込みます。
|
|
65
|
+
|
|
66
|
+
### ✨ Truthmark が独自である理由
|
|
67
|
+
|
|
68
|
+
Truthmark は単なる別のドキュメントツールではありません。AI ワークフローに深く統合されています:
|
|
69
|
+
|
|
70
|
+
* **🚫 ベンダーロックインなし:** ホステッドサービスも、隠れたデータベースも、運用すべき追加サーバーもありません。
|
|
71
|
+
* **🌳 100% Git ネイティブ:** すべてがリポジトリ内にあります。truth はブランチと一緒に移動します。
|
|
72
|
+
* **🤝 人間が所有し、エージェントが従う契約:** メンテナーがリポジトリ契約を所有し、エージェントはコーディング中にインストール済み指示に従います。
|
|
73
|
+
* **✅ 検証による信頼:** 振る舞いを変える作業には、人間がレビューできる truth-doc の判断または diff が含まれるため、AI の作業を信頼しやすくなります。
|
|
74
|
+
|
|
75
|
+
## 🔄 仕組み
|
|
76
|
+
|
|
77
|
+
AI エージェントがコードを変更しても、仕事はまだ終わりではありません。Truthmark は、引き渡し前にエージェントが従う完了時ワークフローガードをインストールします:
|
|
78
|
+
|
|
79
|
+
1. 💻 **コード:** エージェントが機能コードを変更します。
|
|
80
|
+
2. 🧪 **テスト:** 関連テストを実行します。
|
|
81
|
+
3. 🔍 **チェック:** Truthmark は、インストール済みの終了時レビューの一部として、対応するドキュメントを確認します。
|
|
82
|
+
4. 📝 **ドキュメント化:** リポジトリの truth が変わった場合、エージェントがドキュメントを更新します。
|
|
83
|
+
5. 👀 **レビュー:** 人間が*コード diff* + *truth diff*をレビューします。
|
|
84
|
+
|
|
85
|
+
## 🛠 Truthmark との関わり方
|
|
86
|
+
|
|
87
|
+
Truthmark には、リポジトリローカルな契約が 1 つあり、それを使う方法が 2 つあります。
|
|
88
|
+
|
|
89
|
+
### 人間が契約をインストールして検証する
|
|
90
|
+
|
|
91
|
+
メンテナーと CI は CLI を使います:
|
|
92
|
+
|
|
93
|
+
* `truthmark config` - 初期設定を作成します。
|
|
94
|
+
* `truthmark init` - ルーティング、truth-doc の足場、AI ホスト向け指示をインストールまたは更新します。
|
|
95
|
+
* `truthmark check` - ターミナルからリポジトリ truth を検証します。
|
|
96
|
+
|
|
97
|
+
### エージェントはコーディング中に契約に従う
|
|
98
|
+
|
|
99
|
+
Truthmark は、Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor などの対応 AI コーディングホスト向けに、リポジトリローカルな指示をインストールします。
|
|
100
|
+
|
|
101
|
+
通常の流れは単純です:
|
|
102
|
+
|
|
103
|
+
1. エージェントにコード変更を依頼するか、既存の振る舞いの文書化を依頼します。
|
|
104
|
+
2. インストール済みの指示が、いつテストし、いつ truth docs を更新し、いつ人間レビューのために止まるかをエージェントに伝えます。
|
|
105
|
+
3. あなたは通常の Git diff をレビューします。コードと、必要なら truth-doc の変更です。
|
|
106
|
+
|
|
107
|
+
ユーザーが開始するエージェント依頼は意図的に少なくしています:
|
|
108
|
+
|
|
109
|
+
* `/truthmark-document` - コードとテストから既存の実装済み振る舞いを文書化します。
|
|
110
|
+
* `/truthmark-realize` - 既存の truth docs からコードを実装します。
|
|
111
|
+
* `/truthmark-check` - リポジトリ truth を監査します。
|
|
112
|
+
|
|
113
|
+
Truth Sync は作業を始める通常の方法ではありません。機能コード変更後の終了時レビューです。
|
|
114
|
+
Truth Structure は日常コマンドではありません。作業をブロックしている場合にだけ、ルーティングや所有者情報を修復します。
|
|
115
|
+
|
|
116
|
+
## 得られるもの
|
|
117
|
+
|
|
118
|
+
| 機能 | 内容 |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| Git ネイティブな truth | リポジトリの truth をコミット済み Markdown と設定に保持します。 |
|
|
121
|
+
| ブランチ単位のドキュメント | truth はプライベートセッションではなく、ブランチと一緒に移動します。 |
|
|
122
|
+
| 人間向け CLI | メンテナーにセットアップ、更新、検証、確認のコマンドを提供します。 |
|
|
123
|
+
| インストール済みエージェント契約 | ドキュメント化、実現、監査、終了時 sync、限定的なルーティング修復のためのホストネイティブなガイダンスをエージェントに提供します。 |
|
|
124
|
+
| 明示的なルーティング | コード領域を正規の truth ドキュメントに対応付けます。 |
|
|
125
|
+
| レビュー可能な引き渡し | コードと truth ドキュメントの両方について通常の Git diff を生成します。 |
|
|
126
|
+
| ローカルファースト運用 | ホステッドサービス、デーモン、データベース、MCP サーバーを必要としません。 |
|
|
127
|
+
| より安全な書き込み境界 | コードファースト、ドキュメントファースト、読み取り専用、ドキュメント専用のワークフローを分離します。 |
|
|
128
|
+
| 検証 | ルーティング、権限、frontmatter、リンク、生成サーフェス、ブランチスコープ、鮮度、カバレッジの問題を報告します。 |
|
|
129
|
+
| 任意の Portal | 明示的に有効化され要求された場合、Markdown truth ドキュメントからコミット済みの静的 HTML プレゼンテーションサイトを生成します。 |
|
|
130
|
+
|
|
131
|
+
## ビジュアル概要
|
|
132
|
+
|
|
133
|
+

|
|
134
|
+
|
|
135
|
+
**機能:** Truthmark が何をインストールし、ワークフローサーフェスがどのように分割されるか。
|
|
136
|
+
|
|
137
|
+

|
|
138
|
+
|
|
139
|
+
**位置づけ:** Truthmark がプロンプト、メモリ、仕様ワークフローに対してどこに位置するか。
|
|
140
|
+
|
|
141
|
+

|
|
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
|
+
- ブランチ固有のプロダクト truth
|
|
162
|
+
- 長持ちするアーキテクチャおよび API ドキュメント
|
|
163
|
+
- ドキュメントとコードの間の明示的な所有関係
|
|
164
|
+
- より安全なエージェントの書き込み境界
|
|
165
|
+
- 隠れたメモリではなく、レビュー可能なドキュメント
|
|
166
|
+
- コミット済みリポジトリファイルから引き続き動作する AI ワークフロー
|
|
167
|
+
|
|
168
|
+
## Truthmark の適用範囲
|
|
169
|
+
|
|
170
|
+
Truthmark は、プロンプト、メモリ、仕様、テスト、コードレビューを置き換えません。
|
|
171
|
+
|
|
172
|
+
それらのワークフローが Git に永続的に着地する場所を提供します。
|
|
173
|
+
|
|
174
|
+
| ニーズ | より適したもの |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| 1 回のエージェントセッションからより良い出力を得る | より良いプロンプト |
|
|
177
|
+
| 個人またはセッション単位の継続性 | メモリツール |
|
|
178
|
+
| 計画ファーストの機能開発 | 仕様ワークフロー |
|
|
179
|
+
| コードと一緒に移動するブランチ単位の truth | 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
|
+
- ブランチ単位の truth ドキュメントと、派生したリポジトリインテリジェンス成果物
|
|
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
|
+
- [リポジトリ truth メンテナンスガイド](../standards/maintaining-repository-truth.md)
|
|
214
|
+
|
|
215
|
+
ローカル開発とコントリビューション用コマンドについては、[CONTRIBUTING.md](../../CONTRIBUTING.md)を参照してください。
|
|
216
|
+
|
|
217
|
+
## 設計上の境界
|
|
218
|
+
|
|
219
|
+
Truthmark は意図的に小さく保たれています:ローカル、コミット済み、ブランチ単位、レビュー可能。
|
|
220
|
+
|
|
221
|
+
これはホステッドサービス、MCP サーバー、ベクトルデータベース、隠れたメモリ層、CI 強制製品、自律的なコード書き換えエンジンではありません。リポジトリの truth を見える状態に保つのを助けますが、テスト、コードレビュー、人間の判断を置き換えるものではありません。
|
|
222
|
+
|
|
223
|
+
## ライセンス
|
|
224
|
+
|
|
225
|
+
MIT。[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
|
+

|
|
8
|
+
|
|
9
|
+
## 🚀 빠른 시작: 5분 안에 로컬에서 실행하기
|
|
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 호스트를 활성화하세요. 새 설정은 기본적으로 호스트 중립적이므로, 초기화 전에 `.truthmark/config.yml`에 최상위 `platforms` 목록을 추가하세요:
|
|
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
|
+
그런 다음 저장소 로컬 truth 문서, 라우팅, 에이전트 워크플로 표면을 설치하세요:
|
|
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와 truth-doc diff를 함께 검토합니다.
|
|
47
|
+
|
|
48
|
+
아직 호스트별 AI 워크플로는 원하지 않고 CLI 검증만 원한다면 `platforms`를 생략한 채 `truthmark init && truthmark check`를 실행하세요. 나중에 플랫폼을 추가하고 `truthmark init`을 다시 실행할 수 있습니다.
|
|
49
|
+
|
|
50
|
+
## 💡 문제: AI 문서화 격차
|
|
51
|
+
|
|
52
|
+
AI 코딩 에이전트는 코드를 빠르게 작성하는 데 탁월합니다. 하지만 이 속도는 위험한 새로운 실패 모드를 만듭니다. **저장소가 말하는 이야기가 현실과 어긋나는 것**입니다.
|
|
53
|
+
|
|
54
|
+
* 동작은 일시적인 채팅 기록 속에서 사라집니다.
|
|
55
|
+
* 아키텍처 문서는 빠르게 뒤처집니다.
|
|
56
|
+
* 제품 결정은 인계 후 사라집니다.
|
|
57
|
+
* 코드 리뷰어는 “왜”를 이해하지 못한 채 원시 코드 diff만 보게 됩니다.
|
|
58
|
+
* 모든 새 AI 세션은 저장소의 truth를 처음부터 다시 발견해야 합니다.
|
|
59
|
+
|
|
60
|
+
## 🎯 해결책: Truthmark
|
|
61
|
+
|
|
62
|
+
**Truthmark**는 저장소에 Git 네이티브 워크플로 계층을 설치합니다. AI 개발에서 보통 깨지는 부분, 즉 문서가 코드와 계속 정렬되도록 돕는 일을 해결합니다.
|
|
63
|
+
|
|
64
|
+
사람과 AI 에이전트가 문서 업데이트를 기억하길 기대하는 대신, Truthmark는 문서화를 저장소 안의 체계적이고 검토 가능한 습관으로 만듭니다.
|
|
65
|
+
|
|
66
|
+
### ✨ Truthmark가 특별한 이유
|
|
67
|
+
|
|
68
|
+
Truthmark는 단순한 또 하나의 문서화 도구가 아닙니다. AI 워크플로에 깊이 통합되어 있습니다:
|
|
69
|
+
|
|
70
|
+
* **🚫 벤더 종속 없음:** 호스팅 서비스, 숨겨진 데이터베이스, 운영해야 할 추가 서버가 없습니다.
|
|
71
|
+
* **🌳 100% Git 네이티브:** 모든 것이 저장소 안에 있습니다. truth는 브랜치와 함께 이동합니다.
|
|
72
|
+
* **🤝 사람이 소유하고 에이전트가 따르는 계약:** 유지관리자가 저장소 계약을 소유하고, 에이전트는 코딩 중 설치된 지침을 따릅니다.
|
|
73
|
+
* **✅ 검증을 통한 신뢰:** 동작을 바꾸는 작업에는 사람이 검토할 수 있는 truth-doc 결정 또는 diff가 포함되므로 AI 작업을 더 쉽게 신뢰할 수 있습니다.
|
|
74
|
+
|
|
75
|
+
## 🔄 작동 방식
|
|
76
|
+
|
|
77
|
+
AI 에이전트가 코드를 수정해도 작업은 끝난 것이 아닙니다. Truthmark는 인계 전에 에이전트가 따르는 완료 시점 워크플로 보호 장치를 설치합니다:
|
|
78
|
+
|
|
79
|
+
1. 💻 **코드:** 에이전트가 기능 코드를 수정합니다.
|
|
80
|
+
2. 🧪 **테스트:** 관련 테스트가 실행됩니다.
|
|
81
|
+
3. 🔍 **확인:** Truthmark는 설치된 마무리 검토의 일부로 매핑된 문서를 확인합니다.
|
|
82
|
+
4. 📝 **문서화:** 저장소 truth가 변경되면 에이전트가 문서를 업데이트합니다.
|
|
83
|
+
5. 👀 **검토:** 사람이 *코드 diff* + *truth diff*를 검토합니다.
|
|
84
|
+
|
|
85
|
+
## 🛠 Truthmark와 상호작용하는 방식
|
|
86
|
+
|
|
87
|
+
Truthmark에는 저장소 로컬 계약 하나와 그것을 사용하는 두 가지 방식이 있습니다.
|
|
88
|
+
|
|
89
|
+
### 사람은 계약을 설치하고 검증합니다
|
|
90
|
+
|
|
91
|
+
유지관리자와 CI는 CLI를 사용합니다:
|
|
92
|
+
|
|
93
|
+
* `truthmark config` - 초기 설정을 만듭니다.
|
|
94
|
+
* `truthmark init` - 라우팅, truth-doc 스캐폴드, AI 호스트 지침을 설치하거나 새로 고칩니다.
|
|
95
|
+
* `truthmark check` - 터미널에서 저장소 truth를 검증합니다.
|
|
96
|
+
|
|
97
|
+
### 에이전트는 코딩하는 동안 계약을 따릅니다
|
|
98
|
+
|
|
99
|
+
Truthmark는 Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, Cursor 같은 지원 AI 코딩 호스트를 위해 저장소 로컬 지침을 설치합니다.
|
|
100
|
+
|
|
101
|
+
일반적인 루프는 단순합니다:
|
|
102
|
+
|
|
103
|
+
1. 에이전트에게 코드 변경을 요청하거나 기존 동작을 문서화해 달라고 요청합니다.
|
|
104
|
+
2. 설치된 지침은 에이전트에게 언제 테스트하고, 언제 truth docs를 업데이트하고, 언제 사람 검토를 위해 멈출지 알려 줍니다.
|
|
105
|
+
3. 당신은 일반 Git diff를 검토합니다. 코드와 필요한 truth-doc 변경입니다.
|
|
106
|
+
|
|
107
|
+
사용자가 시작하는 에이전트 요청은 의도적으로 적습니다:
|
|
108
|
+
|
|
109
|
+
* `/truthmark-document` - 코드와 테스트에서 기존 구현 동작을 문서화합니다.
|
|
110
|
+
* `/truthmark-realize` - 기존 truth docs에서 코드를 구현합니다.
|
|
111
|
+
* `/truthmark-check` - 저장소 truth를 감사합니다.
|
|
112
|
+
|
|
113
|
+
Truth Sync는 작업을 시작하는 일반적인 방법이 아니라, 기능 코드 변경 후의 마무리 검토입니다.
|
|
114
|
+
Truth Structure는 일상 명령이 아니라, 작업을 막는 경우에만 라우팅이나 소유권을 복구합니다.
|
|
115
|
+
|
|
116
|
+
## 얻는 것
|
|
117
|
+
|
|
118
|
+
| 역량 | 하는 일 |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| Git 네이티브 truth | 저장소 truth를 커밋된 Markdown과 설정에 보관합니다. |
|
|
121
|
+
| 브랜치 범위 문서화 | truth는 비공개 세션에 머무르지 않고 브랜치와 함께 이동합니다. |
|
|
122
|
+
| 사람용 CLI | 유지관리자에게 설정, 새로고침, 검증, 검사 명령을 제공합니다. |
|
|
123
|
+
| 설치된 에이전트 지침 | 코딩 에이전트에게 언제 문서화, 테스트, truth 동기화, 감사, 검토 중지를 할지 알려 줍니다. |
|
|
124
|
+
| 명시적 라우팅 | 코드 영역을 정식 truth 문서에 매핑합니다. |
|
|
125
|
+
| 검토 가능한 인계 | 코드와 truth 문서 모두에 대해 일반 Git diff를 생성합니다. |
|
|
126
|
+
| 로컬 우선 운영 | 호스팅 서비스, 데몬, 데이터베이스, MCP 서버가 필요 없습니다. |
|
|
127
|
+
| 더 안전한 쓰기 경계 | 코드 우선, 문서 우선, 읽기 전용, 문서 전용 워크플로를 분리합니다. |
|
|
128
|
+
| 검증 | 라우팅, 권한, frontmatter, 링크, 생성 표면, 브랜치 범위, 신선도, 커버리지 문제를 보고합니다. |
|
|
129
|
+
| 선택적 Portal | 명시적으로 활성화하고 요청한 경우 Markdown truth 문서에서 커밋된 정적 HTML 프레젠테이션 사이트를 생성합니다. |
|
|
130
|
+
|
|
131
|
+
## 시각적 개요
|
|
132
|
+
|
|
133
|
+

|
|
134
|
+
|
|
135
|
+
**기능:** Truthmark가 무엇을 설치하고 워크플로 표면이 어떻게 나뉘는지.
|
|
136
|
+
|
|
137
|
+

|
|
138
|
+
|
|
139
|
+
**위치:** Truthmark가 프롬프트, 메모리, 사양 워크플로와 비교해 어디에 들어맞는지.
|
|
140
|
+
|
|
141
|
+

|
|
142
|
+
|
|
143
|
+
**동기화 흐름:** Truth Sync가 일반적인 코드 변경을 인계 전에 어떻게 마무리하는지.
|
|
144
|
+
|
|
145
|
+
## 팀이 도입하는 이유
|
|
146
|
+
|
|
147
|
+
Truthmark는 AI 에이전트가 코드를 생성할 수 있음을 이미 아는 팀을 위한 것입니다.
|
|
148
|
+
|
|
149
|
+
다음 문제는 거버넌스입니다.
|
|
150
|
+
|
|
151
|
+
의식으로서의 거버넌스가 아닙니다. 거버넌스란 단순한 질문입니다:
|
|
152
|
+
|
|
153
|
+
> 이 AI 지원 변경 이후에도 저장소는 여전히 truth를 말하는가?
|
|
154
|
+
|
|
155
|
+
Truthmark는 커밋된 파일, 명시적 라우팅, 검토 가능한 diff로 팀이 그 질문에 답하도록 돕습니다.
|
|
156
|
+
|
|
157
|
+
다음이 필요할 때 유용합니다:
|
|
158
|
+
|
|
159
|
+
- 문서 드리프트 감소
|
|
160
|
+
- 더 나은 인계
|
|
161
|
+
- 브랜치별 제품 truth
|
|
162
|
+
- 지속 가능한 아키텍처 및 API 문서
|
|
163
|
+
- 문서와 코드 사이의 명시적 소유권
|
|
164
|
+
- 더 안전한 에이전트 쓰기 경계
|
|
165
|
+
- 숨겨진 메모리가 아닌 검토 가능한 문서
|
|
166
|
+
- 커밋된 저장소 파일에서 계속 작동하는 에이전트 지침
|
|
167
|
+
|
|
168
|
+
## Truthmark가 들어맞는 곳
|
|
169
|
+
|
|
170
|
+
Truthmark는 프롬프트, 메모리, 사양, 테스트, 코드 리뷰를 대체하지 않습니다.
|
|
171
|
+
|
|
172
|
+
그 워크플로들이 Git 안에 지속적으로 자리 잡을 수 있는 장소를 제공합니다.
|
|
173
|
+
|
|
174
|
+
| 필요 | 더 적합한 것 |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| 한 번의 에이전트 세션에서 더 나은 출력 | 더 나은 프롬프트 |
|
|
177
|
+
| 개인 또는 세션 수준의 연속성 | 메모리 도구 |
|
|
178
|
+
| 계획 우선 기능 작업 | 사양 워크플로 |
|
|
179
|
+
| 코드와 함께 이동하는 브랜치 범위 truth | 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
|
+
- 브랜치 범위 truth 문서와 파생된 저장소 인텔리전스 산출물
|
|
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
|
+
- [저장소 truth 유지관리 가이드](../standards/maintaining-repository-truth.md)
|
|
214
|
+
|
|
215
|
+
로컬 개발 및 기여 명령은 [CONTRIBUTING.md](../../CONTRIBUTING.md)를 참조하세요.
|
|
216
|
+
|
|
217
|
+
## 설계 경계
|
|
218
|
+
|
|
219
|
+
Truthmark는 의도적으로 작습니다. 로컬이고, 커밋되며, 브랜치 범위이고, 검토 가능합니다.
|
|
220
|
+
|
|
221
|
+
Truthmark는 호스팅 서비스, MCP 서버, 벡터 데이터베이스, 숨겨진 메모리 계층, CI 강제 제품, 자율 코드 재작성 엔진이 아닙니다. 저장소 truth가 보이도록 돕지만, 테스트, 코드 리뷰, 사람의 판단을 대체하지는 않습니다.
|
|
222
|
+
|
|
223
|
+
## 라이선스
|
|
224
|
+
|
|
225
|
+
MIT. [LICENSE](../../LICENSE)를 참조하세요.
|