truthmark 2.3.0 → 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.
@@ -1,220 +1,194 @@
1
1
  # Truthmark
2
2
 
3
- **あなたのエージェントはコードを書きます。Truthmark は、人間向けで Git 上でレビュー可能なドキュメントを維持します。**
3
+ **あなたのエージェントはコードを書きます。Truthmark は、人が読み、Git でレビューできるドキュメントを維持します。**
4
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)
5
+ Truthmark Git ネイティブなワークフローをインストールし、AI コーディングエージェントが既存のコードとテストから新しいプロダクトおよびエンジニアリングドキュメントを作成し、コードが変更されるたびに最新の状態を保ち、通常の Markdown diff としてレビューできるようにします。
6
6
 
7
- ![Truthmark バナー](../assets/truthmark-banner.png)
7
+ [![npm version](https://img.shields.io/npm/v/truthmark?color=cb3837&label=npm)](https://www.npmjs.com/package/truthmark)
8
+ [![CI](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml)
9
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../../LICENSE)
10
+ [![Node.js >=24](https://img.shields.io/badge/node-%3E%3D24-339933?logo=node.js&logoColor=white)](../../package.json)
8
11
 
9
- ## 🚀 クイックスタート:5 分でローカル実行
12
+ [今すぐ始める](#クイックスタート最初の-truth-ドキュメントを作成する) · [ウェブサイト](https://merlinhu1.github.io/truthmark/) · [ユーザーガイド](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md) · [GitHub](https://github.com/merlinhu1/truthmark)
10
13
 
11
- Truthmark に管理させたい Git リポジトリ内でこれを実行します:
14
+ <details>
15
+ <summary>この README を 16 言語で読む</summary>
12
16
 
13
- ```bash
14
- cd /path/to/your-repo
15
- npm install -g truthmark
16
- truthmark init
17
- truthmark check
18
- git diff
19
- ```
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)
20
18
 
21
- 対話型ターミナルでは、`truthmark init` が番号付きの複数選択を表示します。0 個以上のプラットフォームを選ぶか、`none` を入力してホスト非依存の CLI 専用セットアップにします。
19
+ </details>
22
20
 
23
- スクリプトや CI では `--platform` を繰り返します。`--json` は決してプロンプトを表示しません:
21
+ ## 最初のドキュメントを作り、常に真実に保つ
24
22
 
25
- ```bash
26
- truthmark init --platform codex --platform cursor
27
- truthmark init --json
28
- ```
23
+ 多くのドキュメントツールは生成した時点で役目を終えます。Truthmark は、リポジトリ内でエージェントに完全なドキュメントライフサイクルを提供します。
29
24
 
30
- 初回の非対話実行で `--platform` がなければホスト非依存のままです。以後の実行では `.truthmark/config.yml` に保存済みの選択を維持します。
25
+ - **動作するソフトウェアから新しいドキュメントを作成。** Truth Document がコードとテストを読み、範囲の明確なプロダクトまたはエンジニアリングドキュメントを作成します。
26
+ - **ドキュメントを自動的に整合。** 機能コードの変更後、Truth Sync がエージェントの引き渡し時に実行され、作業完了前にリポジトリの事実を更新します。
27
+ - **ドキュメントをコードに戻す。** Truth Realize が承認済みの truth ドキュメントを実装し、明快なドキュメントファーストのワークフローを維持します。
28
+ - **コードベースの成長に合わせて所有範囲を修復。** Truth Structure が、新しい領域や肥大化した領域に、範囲の明確なルートと初期ドキュメントを作成します。
29
+ - **すべてを Git でレビュー。** コード、意思決定、契約、アーキテクチャ、運用、振る舞いがブランチと一緒に移動します。
31
30
 
32
- 次に、最も一般的な導入パスを試します。コードとテストから既存の振る舞いを 1 つドキュメント化します。AI コーディングホストで、インストール済みワークフローに依頼してください:
31
+ ホスト型ナレッジベースは不要。非公開のエージェントメモリも不要。チャット履歴に閉じ込められるドキュメントもありません。
33
32
 
34
- ```text
35
- /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
36
- ```
33
+ ## クイックスタート:最初の Truth ドキュメントを作成する
37
34
 
38
- その後、通常ユーザーが Truth Sync を直接呼び出す必要はありません。AI ホストを通じてコーディングを続けてください。インストールされたリポジトリ指示が、機能コードの変更時に関連テストを実行し、引き渡し前に Truth Sync レビューを行うようエージェントに伝えます。あなたは結果のコード diff と truth-doc diff をレビューします。
35
+ **要件:** Node.js 24 以降、Git リポジトリ、エージェントワークフローに対応する AI コーディングホスト。
39
36
 
40
- CLI 検証だけが必要なら `none` を選び、`truthmark check` を実行してください。後から `truthmark init` を再実行してプラットフォームを選択できます。
37
+ Truthmark に管理させたいリポジトリ内で実行します。
41
38
 
42
- ## 💡 問題:AI ドキュメントギャップ
39
+ ```bash
40
+ cd /path/to/your-repo
41
+ npm install -g truthmark
42
+ truthmark init
43
+ ```
43
44
 
44
- AI コーディングエージェントは、コードを高速に書くことに非常に優れています。しかしその速度は、危険な新しい失敗モードを生みます:**リポジトリの物語が現実からずれていく**ことです。
45
+ `truthmark init` では、Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor、またはホストに依存しないコマンドラインインターフェース設定を選択できます。
45
46
 
46
- * 振る舞いが一時的なチャット履歴の中に失われます。
47
- * アーキテクチャ文書はすぐに遅れます。
48
- * プロダクト上の決定は引き渡し後に消えます。
49
- * コードレビュー担当者は「なぜ」を理解できないまま生のコード diff を見ることになります。
50
- * 新しい AI セッションのたびに、リポジトリの truth を一から再発見しなければなりません。
47
+ 次に、設定済みのエージェントへ、実際の振る舞いを 1 つドキュメント化するよう依頼します。
51
48
 
52
- ## 🎯 解決策:Truthmark
49
+ ```text
50
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
51
+ ```
53
52
 
54
- **Truthmark** は、Git ネイティブなワークフロー層をリポジトリにインストールします。AI 開発で通常壊れやすい部分、つまりドキュメントをコードと整合させ続けることを修復します。
53
+ 対応するドキュメントがなければ、Truth Document は範囲の明確な truth ドキュメントを新規作成します。既存の所有ドキュメントがあれば更新し、必要に応じてルーティングも更新します。機能コードは変更しません。
55
54
 
56
- 人間や AI エージェントがドキュメント更新を忘れないことに期待するのではなく、Truthmark はドキュメントを体系的でレビュー可能な習慣としてリポジトリ内に組み込みます。
55
+ 結果をレビューします。
57
56
 
58
- ### ✨ Truthmark が独自である理由
57
+ ```bash
58
+ truthmark check
59
+ git status --short --untracked-files=all
60
+ git diff
61
+ ```
59
62
 
60
- Truthmark は単なる別のドキュメントツールではありません。AI ワークフローに深く統合されています:
63
+ これで、次のファイルが作成されているはずです。
61
64
 
62
- * **🚫 ベンダーロックインなし:** ホステッドサービスも、隠れたデータベースも、運用すべき追加サーバーもありません。
63
- * **🌳 100% Git ネイティブ:** すべてがリポジトリ内にあります。truth はブランチと一緒に移動します。
64
- * **🤝 人間が所有し、エージェントが従う契約:** メンテナーがリポジトリ契約を所有し、エージェントはコーディング中にインストール済み指示に従います。
65
- * **✅ 検証による信頼:** 振る舞いを変える作業には、人間がレビューできる truth-doc の判断または diff が含まれるため、AI の作業を信頼しやすくなります。
65
+ ```text
66
+ docs/truthmark/engineering/behaviors/session-timeout.md
67
+ docs/truthmark/routes/areas/authentication.md
68
+ ```
66
69
 
67
- ## 🔄 仕組み
70
+ 正確なパスは、リポジトリの所有構造に従います。新規ファイルは `git status` に表示され、追跡済みファイルへの変更は `git diff` に表示されます。
68
71
 
69
- AI エージェントがコードを変更しても、仕事はまだ終わりではありません。Truthmark は、引き渡し前にエージェントが従う完了時ワークフローガードをインストールします:
72
+ 呼び出し方法はホストによって異なります。OpenCode `/skill truthmark-document`、Antigravity は `@truthmark-document`、その他の対応ホストは各ホスト固有のスキルまたはスラッシュコマンドを使用します。正確なコマンドは[プラットフォーム表](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md#supported-agent-platforms)を参照してください。
70
73
 
71
- 1. 💻 **コード:** エージェントが機能コードを変更します。
72
- 2. 🧪 **テスト:** 関連テストを実行します。
73
- 3. 🔍 **チェック:** Truthmark は、インストール済みの終了時レビューの一部として、対応するドキュメントを確認します。
74
- 4. 📝 **ドキュメント化:** リポジトリの truth が変わった場合、エージェントがドキュメントを更新します。
75
- 5. 👀 **レビュー:** 人間が*コード diff* + *truth diff*をレビューします。
74
+ スクリプトと継続的インテグレーションでは、選択するプラットフォームを明示的に渡します。
76
75
 
77
- ## 🛠 Truthmark との関わり方
76
+ ```bash
77
+ truthmark init --platform codex --platform cursor
78
+ truthmark init --json
79
+ ```
78
80
 
79
- Truthmark には、リポジトリローカルな契約が 1 つあり、それを使う方法が 2 つあります。
81
+ 対話形式で `none` を選択するか、`truthmark init --clear-platforms` を実行すると、ホストに依存しないリポジトリになります。後から `truthmark init` を再実行して、エージェントプラットフォームを追加できます。
80
82
 
81
- ### 人間が契約をインストールして検証する
83
+ ブランチを基準とした鮮度診断には、Git のベースを渡します。
82
84
 
83
- メンテナーと CI は CLI を使います:
85
+ ```bash
86
+ truthmark check --base <base-ref>
87
+ ```
84
88
 
85
- * `truthmark init` - 設定を作成または更新し、0 個以上のプラットフォームを選択して、ルーティング、truth-doc の足場、選択した AI ホスト向け指示をインストールします。
86
- * `truthmark check` - ターミナルからリポジトリ truth を検証します。
89
+ ## Truthmark の仕組み
87
90
 
88
- ### エージェントはコーディング中に契約に従う
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>
89
95
 
90
- Truthmark は、Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor などの対応 AI コーディングホスト向けに、リポジトリローカルな指示をインストールします。
96
+ Truthmark のコマンドラインインターフェースがリポジトリ契約をインストールして検証します。コーディングエージェントは、インストール済みのホストネイティブなワークフローを通じて、証拠の確認とドキュメント作業を実行します。
91
97
 
92
- 通常の流れは単純です:
98
+ 通常のコード変更は、次のシンプルなループに従います。
93
99
 
94
- 1. エージェントにコード変更を依頼するか、既存の振る舞いの文書化を依頼します。
95
- 2. インストール済みの指示が、いつテストし、いつ truth docs を更新し、いつ人間レビューのために止まるかをエージェントに伝えます。
96
- 3. あなたは通常の Git diff をレビューします。コードと、必要なら truth-doc の変更です。
100
+ 1. エージェントが機能コードを変更します。
101
+ 2. 関連するテストを実行します。
102
+ 3. Truth Sync が対応付けられたドキュメントを確認します。
103
+ 4. リポジトリの事実が変わった場合、エージェントがドキュメントとルーティングを作成または更新します。
104
+ 5. コード diff と truth diff を一緒にレビューします。
97
105
 
98
- ユーザーが開始するエージェント依頼は意図的に少なくしています:
106
+ ## ワークフロー
99
107
 
100
- * `/truthmark-document` - コードとテストから既存の実装済み振る舞いを文書化します。
101
- * `/truthmark-realize` - 既存の truth docs からコードを実装します。
102
- * `/truthmark-check` - リポジトリ truth を監査します。
108
+ | ワークフロー | 使用する場面 | 結果 |
109
+ | -------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
110
+ | **Truth Document** | 既存のコードにドキュメントが必要 | 証拠に基づくプロダクトおよびエンジニアリングドキュメントを作成または更新 |
111
+ | **Truth Sync** | 機能コードが変更された | 引き渡し前に、対応付けられたドキュメントとルーティングを整合 |
112
+ | **Truth Structure** | 新しい領域に所有範囲が必要、または既存ドキュメントの範囲が広すぎる | 範囲の明確なルートと骨組みとなる初期ドキュメントを作成 |
113
+ | **Truth Realize** | 承認済みの truth ドキュメントを動作するソフトウェアにする | ドキュメントに基づいて機能コードを更新 |
114
+ | **Truth Check** | リポジトリの事実を監査する必要がある | ルーティング、所有範囲、証拠、ドキュメントの問題を報告 |
115
+ | **Truthmark Portal** | チームが閲覧可能なドキュメントサイトを必要としている | Markdown の truth ドキュメントから、コミットされる静的 HTML プレゼンテーションを生成 |
103
116
 
104
- Truth Sync は作業を始める通常の方法ではありません。機能コード変更後の終了時レビューです。
105
- Truth Structure は日常コマンドではありません。作業をブロックしている場合にだけ、ルーティングや所有者情報を修復します。
117
+ Truthmark は、Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor 向けのネイティブなリポジトリサーフェスとして、これらのワークフローをインストールします。
106
118
 
107
119
  ## 得られるもの
108
120
 
109
- | 機能 | 内容 |
110
- | --- | --- |
111
- | Git ネイティブな truth | リポジトリの truth をコミット済み Markdown と設定に保持します。 |
112
- | ブランチ単位のドキュメント | truth はプライベートセッションではなく、ブランチと一緒に移動します。 |
113
- | 人間向け CLI | メンテナーにセットアップ、更新、検証、確認のコマンドを提供します。 |
114
- | インストール済みエージェント契約 | ドキュメント化、実現、監査、終了時 sync、限定的なルーティング修復のためのホストネイティブなガイダンスをエージェントに提供します。 |
115
- | 明示的なルーティング | コード領域を正規の truth ドキュメントに対応付けます。 |
116
- | レビュー可能な引き渡し | コードと truth ドキュメントの両方について通常の Git diff を生成します。 |
117
- | ローカルファースト運用 | ホステッドサービス、デーモン、データベース、MCP サーバーを必要としません。 |
118
- | より安全な書き込み境界 | コードファースト、ドキュメントファースト、読み取り専用、ドキュメント専用のワークフローを分離します。 |
119
- | 検証 | ルーティング、権限、frontmatter、リンク、生成サーフェス、ブランチスコープ、鮮度、カバレッジの問題を報告します。 |
120
- | 任意の Portal | 明示的に有効化され要求された場合、Markdown truth ドキュメントからコミット済みの静的 HTML プレゼンテーションサイトを生成します。 |
121
+ ### 現実から始まるドキュメント
121
122
 
122
- ## ビジュアル概要
123
+ Truthmark は、プロダクト機能、実装の振る舞い、アプリケーションプログラミングインターフェース、アーキテクチャ、ワークフロー、運用、テストのドキュメントを作成できます。コードとテストが証拠を提供し、範囲の明確な Markdown ドキュメントが結果を保持します。
123
124
 
124
- ![Truthmark の機能](../assets/truthmark-features.png)
125
+ ### 次の変更にも耐えるドキュメント
125
126
 
126
- **機能:** Truthmark が何をインストールし、ワークフローサーフェスがどのように分割されるか。
127
+ ルートがコード領域と正規ドキュメントを結び付けます。エージェントが振る舞いを変更すると、Truth Sync は対応する事実の格納先を把握し、引き渡しをレビュー可能な状態に保ちます。
127
128
 
128
- ![Truthmark の位置づけ](../assets/truthmark-position.png)
129
+ ### プロダクトの事実とエンジニアリングの事実を別レーンで管理
129
130
 
130
- **位置づけ:** Truthmark がプロンプト、メモリ、仕様ワークフローに対してどこに位置するか。
131
+ プロダクトの事実は、ユーザー向けの約束、境界、意思決定、受け入れ基準を記録します。エンジニアリングの事実は、現在の振る舞い、契約、アーキテクチャ、ワークフロー、運用、テストの振る舞いを記録します。
131
132
 
132
- ![Truthmark の同期フロー](../assets/truthmark-syncflow.png)
133
+ ### Git ネイティブなコラボレーション
133
134
 
134
- **同期フロー:** Truth Sync が通常のコード変更を引き渡し前にどのように締めくくるか。
135
+ 重要なものはすべて、コミットされたリポジトリファイルに存在します。事実はブランチに従い、通常のプルリクエストで機能し、すべてのメンテナーとコーディングエージェントから確認できます。
135
136
 
136
- ## チームが採用する理由
137
+ ### ローカルファーストの運用
137
138
 
138
- Truthmark は、AI エージェントがコードを生成できることをすでに理解しているチームのためのものです。
139
+ Truthmark に、ホスト型サービス、デーモン、データベース、ベクトルストア、Model Context Protocol サーバーは不要です。リポジトリ自体がドキュメントワークフローを保持します。
139
140
 
140
- 次の問題はガバナンスです。
141
+ ## Truthmark が適する領域
141
142
 
142
- 儀式としてのガバナンスではありません。ガバナンスとは、単純な問いです:
143
+ | ニーズ | 最適な選択肢 |
144
+ | -------------------------------------------------- | ---------------------------- |
145
+ | 1 回のエージェントセッションからより良い出力を得る | より良いプロンプト |
146
+ | 個人またはセッション単位の継続性 | メモリツール |
147
+ | 計画優先の機能開発 | 仕様ワークフロー |
148
+ | コードと一緒に移動するブランチ単位のドキュメント | **Truthmark** |
149
+ | 振る舞いの正しさ | テストとコードレビュー |
150
+ | レビュー可能な AI 支援ドキュメント | **Truthmark + Git レビュー** |
143
151
 
144
- > この AI 支援の変更後も、リポジトリはまだ真実を伝えているか?
152
+ Truthmark は、すでに AI コーディングエージェントを利用し、コードの変化と同じ速さでリポジトリが真実を伝え続けることを求めるメンテナーとエンジニアリングチームのために作られています。
145
153
 
146
- Truthmark は、コミット済みファイル、明示的なルーティング、レビュー可能な diff によって、チームがこの問いに答えるのを助けます。
154
+ ## 対応ホストとコマンドライン
147
155
 
148
- 次のようなものが必要なときに有用です:
156
+ 対応するエージェントホスト:
149
157
 
150
- - ドキュメントのずれを減らす
151
- - より良い引き渡し
152
- - ブランチ固有のプロダクト truth
153
- - 長持ちするアーキテクチャおよび API ドキュメント
154
- - ドキュメントとコードの間の明示的な所有関係
155
- - より安全なエージェントの書き込み境界
156
- - 隠れたメモリではなく、レビュー可能なドキュメント
157
- - コミット済みリポジトリファイルから引き続き動作する AI ワークフロー
158
+ - Codex
159
+ - Claude Code
160
+ - GitHub Copilot
161
+ - OpenCode
162
+ - Antigravity
163
+ - Cursor
158
164
 
159
- ## Truthmark の適用範囲
165
+ <details>
166
+ <summary>コマンドラインリファレンス</summary>
160
167
 
161
- Truthmark は、プロンプト、メモリ、仕様、テスト、コードレビューを置き換えません。
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` | 作成済みの事実を保持したまま、生成されたホストサーフェスをプレビューまたは削除 |
162
177
 
163
- それらのワークフローが Git に永続的に着地する場所を提供します。
178
+ スクリプトと継続的インテグレーション向けに、コマンドラインインターフェース全体で構造化 JSON 出力を利用できます。
164
179
 
165
- | ニーズ | より適したもの |
166
- | --- | --- |
167
- | 1 回のエージェントセッションからより良い出力を得る | より良いプロンプト |
168
- | 個人またはセッション単位の継続性 | メモリツール |
169
- | 計画ファーストの機能開発 | 仕様ワークフロー |
170
- | コードと一緒に移動するブランチ単位の truth | Truthmark |
171
- | 振る舞いの正しさを検証する | テストとレビュー |
172
- | AI 支援によるドキュメント変更をレビューする | Truthmark と Git レビュー |
180
+ </details>
173
181
 
174
- Truthmark のレーンは意図的に狭く設計されています:
175
-
176
- ```text
177
- make repository truth explicit
178
- route it to code
179
- その周囲にエージェント指示をインストールする
180
- keep the result reviewable in Git
181
- ```
182
+ ## 詳細情報
182
183
 
183
- ## さらに詳しく
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)
184
189
 
185
- README は店頭のようなものです。素早い文脈、クイックスタート、核となるメンタルモデルを提供します。
186
-
187
- コマンドごとの使い方、サーフェス比較、対応プラットフォームの詳細、設定、ルーティング、Portal、例については、[Truthmark ユーザーガイド](../user-guide.md)を読んでください。
188
-
189
- ## プロジェクトの状態
190
-
191
- 現在のリリースは次を提供します:
192
-
193
- - init、check、index、impact、workflow status のためのローカル CLI コマンド
194
- - Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor 向けに生成されるリポジトリローカルなエージェント指示
195
- - ルーティング、権限、frontmatter、リンク、鮮度、生成サーフェス、ブランチスコープ、カバレッジの診断
196
- - ブランチ単位の truth ドキュメントと、派生したリポジトリインテリジェンス成果物
197
-
198
- ## ドキュメント
199
-
200
- - [ユーザーガイド](../user-guide.md)
201
- - [ドキュメント索引](../README.md)
202
- - [アーキテクチャ概要](../truthmark/engineering/architecture/overview.md)
203
- - [API と CLI の契約](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
204
- - [リポジトリ truth メンテナンスガイド](../standards/maintaining-repository-truth.md)
205
-
206
- ローカル開発とコントリビューション用コマンドについては、[CONTRIBUTING.md](../../CONTRIBUTING.md)を参照してください。
207
-
208
- ## 設計上の境界
209
-
210
- Truthmark は意図的に小さく保たれています:ローカル、コミット済み、ブランチ単位、レビュー可能。
211
-
212
- これはホステッドサービス、MCP サーバー、ベクトルデータベース、隠れたメモリ層、CI 強制製品、自律的なコード書き換えエンジンではありません。リポジトリの truth を見える状態に保つのを助けますが、テスト、コードレビュー、人間の判断を置き換えるものではありません。
190
+ **Truthmark をインストールし、コーディングホストを選び、今日から実際の振る舞いをドキュメントに変えましょう。**
213
191
 
214
192
  ## ライセンス
215
193
 
216
194
  MIT。[LICENSE](../../LICENSE) を参照してください。
217
-
218
- ## 安全な削除
219
-
220
- `truthmark uninstall --dry-run` を使用して正確に生成されたホストサーフェスを確認し、次に `truthmark uninstall --apply` でそれらを削除します。作成した truth、設定、テンプレート、Portal の出力、Gemini ファイル、関連のないユーザーファイルは保持されます。npm のグローバルインストールはパッケージマネージャーで別途削除してください。