truthmark 2.2.7 → 2.3.1
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 +119 -166
- package/dist/main.js +2156 -1914
- package/dist/main.js.map +1 -1
- package/docs/README.md +49 -37
- package/docs/assets/truthmark-workflow-mobile.svg +118 -0
- package/docs/assets/truthmark-workflow.svg +182 -0
- package/docs/readmes/README.ar.md +125 -160
- package/docs/readmes/README.de.md +127 -162
- package/docs/readmes/README.el.md +127 -162
- package/docs/readmes/README.es.md +125 -160
- package/docs/readmes/README.fr.md +125 -160
- package/docs/readmes/README.id.md +126 -161
- package/docs/readmes/README.it.md +125 -160
- package/docs/readmes/README.ja.md +126 -161
- package/docs/readmes/README.ko.md +127 -162
- package/docs/readmes/README.pl.md +125 -160
- package/docs/readmes/README.pt.md +126 -161
- package/docs/readmes/README.ru.md +124 -159
- package/docs/readmes/README.tr.md +125 -160
- package/docs/readmes/README.vi.md +126 -161
- package/docs/readmes/README.zh.md +128 -163
- package/package.json +3 -1
|
@@ -1,229 +1,194 @@
|
|
|
1
1
|
# Truthmark
|
|
2
2
|
|
|
3
|
-
**あなたのエージェントはコードを書きます。Truthmark
|
|
3
|
+
**あなたのエージェントはコードを書きます。Truthmark は、人が読み、Git でレビューできるドキュメントを維持します。**
|
|
4
|
+
|
|
5
|
+
Truthmark は Git ネイティブなワークフローをインストールし、AI コーディングエージェントが既存のコードとテストから新しいプロダクトおよびエンジニアリングドキュメントを作成し、コードが変更されるたびに最新の状態を保ち、通常の Markdown diff としてレビューできるようにします。
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/truthmark)
|
|
8
|
+
[](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml)
|
|
9
|
+
[](../../LICENSE)
|
|
10
|
+
[](../../package.json)
|
|
11
|
+
|
|
12
|
+
[今すぐ始める](#クイックスタート最初の-truth-ドキュメントを作成する) · [ウェブサイト](https://merlinhu1.github.io/truthmark/) · [ユーザーガイド](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md) · [GitHub](https://github.com/merlinhu1/truthmark)
|
|
13
|
+
|
|
14
|
+
<details>
|
|
15
|
+
<summary>この README を 16 言語で読む</summary>
|
|
4
16
|
|
|
5
17
|
[🇺🇸 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
18
|
|
|
7
|
-
|
|
19
|
+
</details>
|
|
8
20
|
|
|
9
|
-
##
|
|
21
|
+
## 最初のドキュメントを作り、常に真実に保つ
|
|
10
22
|
|
|
11
|
-
Truthmark
|
|
23
|
+
多くのドキュメントツールは生成した時点で役目を終えます。Truthmark は、リポジトリ内でエージェントに完全なドキュメントライフサイクルを提供します。
|
|
12
24
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
25
|
+
- **動作するソフトウェアから新しいドキュメントを作成。** Truth Document がコードとテストを読み、範囲の明確なプロダクトまたはエンジニアリングドキュメントを作成します。
|
|
26
|
+
- **ドキュメントを自動的に整合。** 機能コードの変更後、Truth Sync がエージェントの引き渡し時に実行され、作業完了前にリポジトリの事実を更新します。
|
|
27
|
+
- **ドキュメントをコードに戻す。** Truth Realize が承認済みの truth ドキュメントを実装し、明快なドキュメントファーストのワークフローを維持します。
|
|
28
|
+
- **コードベースの成長に合わせて所有範囲を修復。** Truth Structure が、新しい領域や肥大化した領域に、範囲の明確なルートと初期ドキュメントを作成します。
|
|
29
|
+
- **すべてを Git でレビュー。** コード、意思決定、契約、アーキテクチャ、運用、振る舞いがブランチと一緒に移動します。
|
|
18
30
|
|
|
19
|
-
|
|
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
|
+
ホスト型ナレッジベースは不要。非公開のエージェントメモリも不要。チャット履歴に閉じ込められるドキュメントもありません。
|
|
31
32
|
|
|
32
|
-
|
|
33
|
+
## クイックスタート：最初の Truth ドキュメントを作成する
|
|
34
|
+
|
|
35
|
+
**要件：** Node.js 24 以降、Git リポジトリ、エージェントワークフローに対応する AI コーディングホスト。
|
|
36
|
+
|
|
37
|
+
Truthmark に管理させたいリポジトリ内で実行します。
|
|
33
38
|
|
|
34
39
|
```bash
|
|
40
|
+
cd /path/to/your-repo
|
|
41
|
+
npm install -g truthmark
|
|
35
42
|
truthmark init
|
|
36
|
-
truthmark check
|
|
37
|
-
git diff
|
|
38
43
|
```
|
|
39
44
|
|
|
40
|
-
|
|
45
|
+
`truthmark init` では、Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor、またはホストに依存しないコマンドラインインターフェース設定を選択できます。
|
|
46
|
+
|
|
47
|
+
次に、設定済みのエージェントへ、実際の振る舞いを 1 つドキュメント化するよう依頼します。
|
|
41
48
|
|
|
42
49
|
```text
|
|
43
50
|
/truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
|
|
44
51
|
```
|
|
45
52
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
CLI 検証だけが必要で、ホスト固有の AI ワークフローをまだ使わない場合は、`platforms` を省略したまま `truthmark init && truthmark check` を実行してください。後からプラットフォームを追加し、`truthmark init` を再実行できます。
|
|
49
|
-
|
|
50
|
-
## 💡 問題：AI ドキュメントギャップ
|
|
53
|
+
対応するドキュメントがなければ、Truth Document は範囲の明確な truth ドキュメントを新規作成します。既存の所有ドキュメントがあれば更新し、必要に応じてルーティングも更新します。機能コードは変更しません。
|
|
51
54
|
|
|
52
|
-
|
|
55
|
+
結果をレビューします。
|
|
53
56
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
## 🎯 解決策：Truthmark
|
|
61
|
-
|
|
62
|
-
**Truthmark** は、Git ネイティブなワークフロー層をリポジトリにインストールします。AI 開発で通常壊れやすい部分、つまりドキュメントをコードと整合させ続けることを修復します。
|
|
63
|
-
|
|
64
|
-
人間や AI エージェントがドキュメント更新を忘れないことに期待するのではなく、Truthmark はドキュメントを体系的でレビュー可能な習慣としてリポジトリ内に組み込みます。
|
|
65
|
-
|
|
66
|
-
### ✨ Truthmark が独自である理由
|
|
57
|
+
```bash
|
|
58
|
+
truthmark check
|
|
59
|
+
git status --short --untracked-files=all
|
|
60
|
+
git diff
|
|
61
|
+
```
|
|
67
62
|
|
|
68
|
-
|
|
63
|
+
これで、次のファイルが作成されているはずです。
|
|
69
64
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
65
|
+
```text
|
|
66
|
+
docs/truthmark/engineering/behaviors/session-timeout.md
|
|
67
|
+
docs/truthmark/routes/areas/authentication.md
|
|
68
|
+
```
|
|
74
69
|
|
|
75
|
-
|
|
70
|
+
正確なパスは、リポジトリの所有構造に従います。新規ファイルは `git status` に表示され、追跡済みファイルへの変更は `git diff` に表示されます。
|
|
76
71
|
|
|
77
|
-
|
|
72
|
+
呼び出し方法はホストによって異なります。OpenCode は `/skill truthmark-document`、Antigravity は `@truthmark-document`、その他の対応ホストは各ホスト固有のスキルまたはスラッシュコマンドを使用します。正確なコマンドは[プラットフォーム表](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md#supported-agent-platforms)を参照してください。
|
|
78
73
|
|
|
79
|
-
|
|
80
|
-
2. 🧪 **テスト：** 関連テストを実行します。
|
|
81
|
-
3. 🔍 **チェック:** Truthmark は、インストール済みの終了時レビューの一部として、対応するドキュメントを確認します。
|
|
82
|
-
4. 📝 **ドキュメント化：** リポジトリの truth が変わった場合、エージェントがドキュメントを更新します。
|
|
83
|
-
5. 👀 **レビュー：** 人間が*コード diff* + *truth diff*をレビューします。
|
|
74
|
+
スクリプトと継続的インテグレーションでは、選択するプラットフォームを明示的に渡します。
|
|
84
75
|
|
|
85
|
-
|
|
76
|
+
```bash
|
|
77
|
+
truthmark init --platform codex --platform cursor
|
|
78
|
+
truthmark init --json
|
|
79
|
+
```
|
|
86
80
|
|
|
87
|
-
|
|
81
|
+
対話形式で `none` を選択するか、`truthmark init --clear-platforms` を実行すると、ホストに依存しないリポジトリになります。後から `truthmark init` を再実行して、エージェントプラットフォームを追加できます。
|
|
88
82
|
|
|
89
|
-
|
|
83
|
+
ブランチを基準とした鮮度診断には、Git のベースを渡します。
|
|
90
84
|
|
|
91
|
-
|
|
85
|
+
```bash
|
|
86
|
+
truthmark check --base <base-ref>
|
|
87
|
+
```
|
|
92
88
|
|
|
93
|
-
|
|
94
|
-
* `truthmark init` - ルーティング、truth-doc の足場、AI ホスト向け指示をインストールまたは更新します。
|
|
95
|
-
* `truthmark check` - ターミナルからリポジトリ truth を検証します。
|
|
89
|
+
## Truthmark の仕組み
|
|
96
90
|
|
|
97
|
-
|
|
91
|
+
<picture>
|
|
92
|
+
<source media="(max-width: 700px)" srcset="../assets/truthmark-workflow-mobile.svg">
|
|
93
|
+
<img src="../assets/truthmark-workflow.svg" alt="Truthmark の仕組み" width="1440">
|
|
94
|
+
</picture>
|
|
98
95
|
|
|
99
|
-
Truthmark
|
|
96
|
+
Truthmark のコマンドラインインターフェースがリポジトリ契約をインストールして検証します。コーディングエージェントは、インストール済みのホストネイティブなワークフローを通じて、証拠の確認とドキュメント作業を実行します。
|
|
100
97
|
|
|
101
|
-
|
|
98
|
+
通常のコード変更は、次のシンプルなループに従います。
|
|
102
99
|
|
|
103
|
-
1.
|
|
104
|
-
2.
|
|
105
|
-
3.
|
|
100
|
+
1. エージェントが機能コードを変更します。
|
|
101
|
+
2. 関連するテストを実行します。
|
|
102
|
+
3. Truth Sync が対応付けられたドキュメントを確認します。
|
|
103
|
+
4. リポジトリの事実が変わった場合、エージェントがドキュメントとルーティングを作成または更新します。
|
|
104
|
+
5. コード diff と truth diff を一緒にレビューします。
|
|
106
105
|
|
|
107
|
-
|
|
106
|
+
## ワークフロー
|
|
108
107
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
108
|
+
| ワークフロー | 使用する場面 | 結果 |
|
|
109
|
+
| -------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
|
110
|
+
| **Truth Document** | 既存のコードにドキュメントが必要 | 証拠に基づくプロダクトおよびエンジニアリングドキュメントを作成または更新 |
|
|
111
|
+
| **Truth Sync** | 機能コードが変更された | 引き渡し前に、対応付けられたドキュメントとルーティングを整合 |
|
|
112
|
+
| **Truth Structure** | 新しい領域に所有範囲が必要、または既存ドキュメントの範囲が広すぎる | 範囲の明確なルートと骨組みとなる初期ドキュメントを作成 |
|
|
113
|
+
| **Truth Realize** | 承認済みの truth ドキュメントを動作するソフトウェアにする | ドキュメントに基づいて機能コードを更新 |
|
|
114
|
+
| **Truth Check** | リポジトリの事実を監査する必要がある | ルーティング、所有範囲、証拠、ドキュメントの問題を報告 |
|
|
115
|
+
| **Truthmark Portal** | チームが閲覧可能なドキュメントサイトを必要としている | Markdown の truth ドキュメントから、コミットされる静的 HTML プレゼンテーションを生成 |
|
|
112
116
|
|
|
113
|
-
|
|
114
|
-
Truth Structure は日常コマンドではありません。作業をブロックしている場合にだけ、ルーティングや所有者情報を修復します。
|
|
117
|
+
Truthmark は、Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor 向けのネイティブなリポジトリサーフェスとして、これらのワークフローをインストールします。
|
|
115
118
|
|
|
116
119
|
## 得られるもの
|
|
117
120
|
|
|
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
|
-
## ビジュアル概要
|
|
121
|
+
### 現実から始まるドキュメント
|
|
132
122
|
|
|
133
|
-
|
|
123
|
+
Truthmark は、プロダクト機能、実装の振る舞い、アプリケーションプログラミングインターフェース、アーキテクチャ、ワークフロー、運用、テストのドキュメントを作成できます。コードとテストが証拠を提供し、範囲の明確な Markdown ドキュメントが結果を保持します。
|
|
134
124
|
|
|
135
|
-
|
|
125
|
+
### 次の変更にも耐えるドキュメント
|
|
136
126
|
|
|
137
|
-
|
|
127
|
+
ルートがコード領域と正規ドキュメントを結び付けます。エージェントが振る舞いを変更すると、Truth Sync は対応する事実の格納先を把握し、引き渡しをレビュー可能な状態に保ちます。
|
|
138
128
|
|
|
139
|
-
|
|
129
|
+
### プロダクトの事実とエンジニアリングの事実を別レーンで管理
|
|
140
130
|
|
|
141
|
-
|
|
131
|
+
プロダクトの事実は、ユーザー向けの約束、境界、意思決定、受け入れ基準を記録します。エンジニアリングの事実は、現在の振る舞い、契約、アーキテクチャ、ワークフロー、運用、テストの振る舞いを記録します。
|
|
142
132
|
|
|
143
|
-
|
|
133
|
+
### Git ネイティブなコラボレーション
|
|
144
134
|
|
|
145
|
-
|
|
135
|
+
重要なものはすべて、コミットされたリポジトリファイルに存在します。事実はブランチに従い、通常のプルリクエストで機能し、すべてのメンテナーとコーディングエージェントから確認できます。
|
|
146
136
|
|
|
147
|
-
|
|
137
|
+
### ローカルファーストの運用
|
|
148
138
|
|
|
149
|
-
|
|
139
|
+
Truthmark に、ホスト型サービス、デーモン、データベース、ベクトルストア、Model Context Protocol サーバーは不要です。リポジトリ自体がドキュメントワークフローを保持します。
|
|
150
140
|
|
|
151
|
-
|
|
141
|
+
## Truthmark が適する領域
|
|
152
142
|
|
|
153
|
-
|
|
143
|
+
| ニーズ | 最適な選択肢 |
|
|
144
|
+
| -------------------------------------------------- | ---------------------------- |
|
|
145
|
+
| 1 回のエージェントセッションからより良い出力を得る | より良いプロンプト |
|
|
146
|
+
| 個人またはセッション単位の継続性 | メモリツール |
|
|
147
|
+
| 計画優先の機能開発 | 仕様ワークフロー |
|
|
148
|
+
| コードと一緒に移動するブランチ単位のドキュメント | **Truthmark** |
|
|
149
|
+
| 振る舞いの正しさ | テストとコードレビュー |
|
|
150
|
+
| レビュー可能な AI 支援ドキュメント | **Truthmark + Git レビュー** |
|
|
154
151
|
|
|
155
|
-
Truthmark
|
|
152
|
+
Truthmark は、すでに AI コーディングエージェントを利用し、コードの変化と同じ速さでリポジトリが真実を伝え続けることを求めるメンテナーとエンジニアリングチームのために作られています。
|
|
156
153
|
|
|
157
|
-
|
|
154
|
+
## 対応ホストとコマンドライン
|
|
158
155
|
|
|
159
|
-
|
|
160
|
-
- より良い引き渡し
|
|
161
|
-
- ブランチ固有のプロダクト truth
|
|
162
|
-
- 長持ちするアーキテクチャおよび API ドキュメント
|
|
163
|
-
- ドキュメントとコードの間の明示的な所有関係
|
|
164
|
-
- より安全なエージェントの書き込み境界
|
|
165
|
-
- 隠れたメモリではなく、レビュー可能なドキュメント
|
|
166
|
-
- コミット済みリポジトリファイルから引き続き動作する AI ワークフロー
|
|
156
|
+
対応するエージェントホスト：
|
|
167
157
|
|
|
168
|
-
|
|
158
|
+
- Codex
|
|
159
|
+
- Claude Code
|
|
160
|
+
- GitHub Copilot
|
|
161
|
+
- OpenCode
|
|
162
|
+
- Antigravity
|
|
163
|
+
- Cursor
|
|
169
164
|
|
|
170
|
-
|
|
165
|
+
<details>
|
|
166
|
+
<summary>コマンドラインリファレンス</summary>
|
|
171
167
|
|
|
172
|
-
|
|
168
|
+
| コマンド | 目的 |
|
|
169
|
+
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
|
170
|
+
| `truthmark init` | 設定、ルーティング、テンプレート、選択したホストのワークフローを作成または更新 |
|
|
171
|
+
| `truthmark check [--base <ref>]` | リポジトリの事実を検証し、必要に応じてブランチの鮮度診断を実行 |
|
|
172
|
+
| `truthmark index --json` | 導出されたリポジトリおよびルーティングのメタデータを確認 |
|
|
173
|
+
| `truthmark impact --base <ref> --json` | 変更されたファイルをドキュメント、所有者、近隣のテストに対応付け |
|
|
174
|
+
| `truthmark workflow status --workflow <id> [--base <ref>] --json` | ワークフローの適用可否と対象を確認 |
|
|
175
|
+
| `truthmark validate ...` | ワークフローレポートと書き込みリースを検証 |
|
|
176
|
+
| `truthmark uninstall --dry-run` / `truthmark uninstall --apply` | 作成済みの事実を保持したまま、生成されたホストサーフェスをプレビューまたは削除 |
|
|
173
177
|
|
|
174
|
-
|
|
175
|
-
| --- | --- |
|
|
176
|
-
| 1 回のエージェントセッションからより良い出力を得る | より良いプロンプト |
|
|
177
|
-
| 個人またはセッション単位の継続性 | メモリツール |
|
|
178
|
-
| 計画ファーストの機能開発 | 仕様ワークフロー |
|
|
179
|
-
| コードと一緒に移動するブランチ単位の truth | Truthmark |
|
|
180
|
-
| 振る舞いの正しさを検証する | テストとレビュー |
|
|
181
|
-
| AI 支援によるドキュメント変更をレビューする | Truthmark と Git レビュー |
|
|
178
|
+
スクリプトと継続的インテグレーション向けに、コマンドラインインターフェース全体で構造化 JSON 出力を利用できます。
|
|
182
179
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
```text
|
|
186
|
-
make repository truth explicit
|
|
187
|
-
route it to code
|
|
188
|
-
その周囲にエージェント指示をインストールする
|
|
189
|
-
keep the result reviewable in Git
|
|
190
|
-
```
|
|
180
|
+
</details>
|
|
191
181
|
|
|
192
|
-
##
|
|
182
|
+
## 詳細情報
|
|
193
183
|
|
|
194
|
-
|
|
184
|
+
- [Truthmark ユーザーガイド](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md)
|
|
185
|
+
- [ドキュメント索引](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
|
|
186
|
+
- [アーキテクチャ概要](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
|
|
187
|
+
- [設定、ルーティング、コマンドの契約](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
188
|
+
- [コントリビューション](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
|
|
195
189
|
|
|
196
|
-
|
|
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 を見える状態に保つのを助けますが、テスト、コードレビュー、人間の判断を置き換えるものではありません。
|
|
190
|
+
**Truthmark をインストールし、コーディングホストを選び、今日から実際の振る舞いをドキュメントに変えましょう。**
|
|
222
191
|
|
|
223
192
|
## ライセンス
|
|
224
193
|
|
|
225
194
|
MIT。[LICENSE](../../LICENSE) を参照してください。
|
|
226
|
-
|
|
227
|
-
## 安全な削除
|
|
228
|
-
|
|
229
|
-
`truthmark uninstall --dry-run` を使用して正確に生成されたホストサーフェスを確認し、次に `truthmark uninstall --apply` でそれらを削除します。作成した truth、設定、テンプレート、Portal の出力、Gemini ファイル、関連のないユーザーファイルは保持されます。npm のグローバルインストールはパッケージマネージャーで別途削除してください。
|