truthmark 2.2.6 → 2.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.md +14 -22
- package/dist/main.js +2776 -2303
- package/dist/main.js.map +1 -1
- package/docs/README.md +18 -16
- package/docs/readmes/README.ar.md +16 -21
- package/docs/readmes/README.de.md +16 -21
- package/docs/readmes/README.el.md +16 -21
- package/docs/readmes/README.es.md +16 -21
- package/docs/readmes/README.fr.md +16 -21
- package/docs/readmes/README.id.md +16 -21
- package/docs/readmes/README.it.md +16 -21
- package/docs/readmes/README.ja.md +16 -21
- package/docs/readmes/README.ko.md +16 -21
- package/docs/readmes/README.pl.md +16 -21
- package/docs/readmes/README.pt.md +16 -21
- package/docs/readmes/README.ru.md +16 -21
- package/docs/readmes/README.tr.md +16 -21
- package/docs/readmes/README.vi.md +16 -21
- package/docs/readmes/README.zh.md +16 -21
- package/package.json +7 -7
|
@@ -13,30 +13,22 @@ Truthmark に管理させたい Git リポジトリ内でこれを実行しま
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
対話型ターミナルでは、`truthmark init` が番号付きの複数選択を表示します。0 個以上のプラットフォームを選ぶか、`none` を入力してホスト非依存の CLI 専用セットアップにします。
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
スクリプトや CI では `--platform` を繰り返します。`--json` は決してプロンプトを表示しません:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
初回の非対話実行で `--platform` がなければホスト非依存のままです。以後の実行では `.truthmark/config.yml` に保存済みの選択を維持します。
|
|
31
|
+
|
|
40
32
|
次に、最も一般的な導入パスを試します。コードとテストから既存の振る舞いを 1 つドキュメント化します。AI コーディングホストで、インストール済みワークフローに依頼してください:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ git diff
|
|
|
45
37
|
|
|
46
38
|
その後、通常ユーザーが Truth Sync を直接呼び出す必要はありません。AI ホストを通じてコーディングを続けてください。インストールされたリポジトリ指示が、機能コードの変更時に関連テストを実行し、引き渡し前に Truth Sync レビューを行うようエージェントに伝えます。あなたは結果のコード diff と truth-doc diff をレビューします。
|
|
47
39
|
|
|
48
|
-
CLI
|
|
40
|
+
CLI 検証だけが必要なら `none` を選び、`truthmark check` を実行してください。後から `truthmark init` を再実行してプラットフォームを選択できます。
|
|
49
41
|
|
|
50
42
|
## 💡 問題:AI ドキュメントギャップ
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark には、リポジトリローカルな契約が 1 つあり、それ
|
|
|
90
82
|
|
|
91
83
|
メンテナーと CI は CLI を使います:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - ルーティング、truth-doc の足場、AI ホスト向け指示をインストールまたは更新します。
|
|
85
|
+
* `truthmark init` - 設定を作成または更新し、0 個以上のプラットフォームを選択して、ルーティング、truth-doc の足場、選択した AI ホスト向け指示をインストールします。
|
|
95
86
|
* `truthmark check` - ターミナルからリポジトリ truth を検証します。
|
|
96
87
|
|
|
97
88
|
### エージェントはコーディング中に契約に従う
|
|
@@ -199,7 +190,7 @@ README は店頭のようなものです。素早い文脈、クイックスタ
|
|
|
199
190
|
|
|
200
191
|
現在のリリースは次を提供します:
|
|
201
192
|
|
|
202
|
-
-
|
|
193
|
+
- init、check、index、impact、workflow status のためのローカル CLI コマンド
|
|
203
194
|
- Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity、Cursor 向けに生成されるリポジトリローカルなエージェント指示
|
|
204
195
|
- ルーティング、権限、frontmatter、リンク、鮮度、生成サーフェス、ブランチスコープ、カバレッジの診断
|
|
205
196
|
- ブランチ単位の truth ドキュメントと、派生したリポジトリインテリジェンス成果物
|
|
@@ -223,3 +214,7 @@ Truthmark は意図的に小さく保たれています:ローカル、コミ
|
|
|
223
214
|
## ライセンス
|
|
224
215
|
|
|
225
216
|
MIT。[LICENSE](../../LICENSE) を参照してください。
|
|
217
|
+
|
|
218
|
+
## 安全な削除
|
|
219
|
+
|
|
220
|
+
`truthmark uninstall --dry-run` を使用して正確に生成されたホストサーフェスを確認し、次に `truthmark uninstall --apply` でそれらを削除します。作成した truth、設定、テンプレート、Portal の出力、Gemini ファイル、関連のないユーザーファイルは保持されます。npm のグローバルインストールはパッケージマネージャーで別途削除してください。
|
|
@@ -13,30 +13,22 @@ Truthmark가 관리하길 원하는 Git 저장소 안에서 실행하세요:
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
대화형 터미널에서 `truthmark init`은 번호가 붙은 다중 선택을 표시합니다. 플랫폼을 0개 이상 선택하거나 `none`을 입력해 호스트 중립적인 CLI 전용 설정을 사용하세요.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
스크립트와 CI에서는 `--platform`을 반복해서 사용합니다. `--json`은 절대 입력을 요청하지 않습니다:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
처음 비대화형으로 실행할 때 `--platform`이 없으면 호스트 중립 상태를 유지하고, 이후 실행에서는 `.truthmark/config.yml`에 저장된 선택을 유지합니다.
|
|
31
|
+
|
|
40
32
|
이제 가장 흔한 도입 경로를 시도해 보세요. 코드와 테스트에서 기존 동작 하나를 문서화합니다. AI 코딩 호스트에서 설치된 워크플로에 요청하세요:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ git diff
|
|
|
45
37
|
|
|
46
38
|
그 이후에는 사용자가 일반적으로 Truth Sync를 직접 호출할 필요가 없습니다. AI 호스트를 통해 계속 코딩하세요. 설치된 저장소 지침이 기능 코드가 변경될 때 에이전트에게 관련 테스트를 실행하고 인계 전에 Truth Sync 검토를 수행하라고 알려줍니다. 사용자는 결과 코드 diff와 truth-doc diff를 함께 검토합니다.
|
|
47
39
|
|
|
48
|
-
|
|
40
|
+
CLI 검증만 원한다면 `none`을 선택하고 `truthmark check`를 실행하세요. 나중에 `truthmark init`을 다시 실행해 플랫폼을 선택할 수 있습니다.
|
|
49
41
|
|
|
50
42
|
## 💡 문제: AI 문서화 격차
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark에는 저장소 로컬 계약 하나와 그것을 사용하는 두 가
|
|
|
90
82
|
|
|
91
83
|
유지관리자와 CI는 CLI를 사용합니다:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - 라우팅, truth-doc 스캐폴드, AI 호스트 지침을 설치하거나 새로 고칩니다.
|
|
85
|
+
* `truthmark init` - 설정을 만들거나 새로 고치고, 플랫폼을 0개 이상 선택하며, 라우팅, truth-doc 스캐폴드와 선택한 AI 호스트 지침을 설치합니다.
|
|
95
86
|
* `truthmark check` - 터미널에서 저장소 truth를 검증합니다.
|
|
96
87
|
|
|
97
88
|
### 에이전트는 코딩하는 동안 계약을 따릅니다
|
|
@@ -199,7 +190,7 @@ README는 쇼윈도입니다. 빠른 맥락, 빠른 시작, 핵심 사고 모델
|
|
|
199
190
|
|
|
200
191
|
현재 릴리스는 다음을 제공합니다:
|
|
201
192
|
|
|
202
|
-
-
|
|
193
|
+
- init, check, index, impact, workflow status를 위한 로컬 CLI 명령
|
|
203
194
|
- Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, Cursor용으로 생성된 저장소 로컬 에이전트 지침
|
|
204
195
|
- 라우팅, 권한, frontmatter, 링크, 신선도, 생성 표면, 브랜치 범위, 커버리지 진단
|
|
205
196
|
- 브랜치 범위 truth 문서와 파생된 저장소 인텔리전스 산출물
|
|
@@ -223,3 +214,7 @@ Truthmark는 호스팅 서비스, MCP 서버, 벡터 데이터베이스, 숨겨
|
|
|
223
214
|
## 라이선스
|
|
224
215
|
|
|
225
216
|
MIT. [LICENSE](../../LICENSE)를 참조하세요.
|
|
217
|
+
|
|
218
|
+
## 안전한 제거
|
|
219
|
+
|
|
220
|
+
`truthmark uninstall --dry-run`을(를) 사용하여 정확히 생성된 호스트 표면을 검토한 후 `truthmark uninstall --apply`를 사용해 제거하세요. 작성된 truth, 구성, 템플릿, Portal 출력, Gemini 파일 및 관련 없는 사용자 파일은 보존되며, npm 전역 설치는 패키지 관리자에서 별도로 제거하십시오.
|
|
@@ -13,30 +13,22 @@ Uruchom to w repozytorium Git, którym ma zarządzać Truthmark:
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
W terminalu interaktywnym `truthmark init` wyświetla numerowany wybór wielokrotny. Wybierz zero lub więcej platform albo wpisz `none`, aby skonfigurować tryb neutralny wobec hosta i tylko CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
W skryptach i CI powtarzaj `--platform`; `--json` nigdy nie wyświetla pytania:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
Przy pierwszym nieinteraktywnym uruchomieniu bez `--platform` konfiguracja pozostaje neutralna; kolejne uruchomienia zachowują wybór zapisany w `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
Teraz wypróbuj najczęstszą ścieżkę adopcji: udokumentuj jedno istniejące zachowanie na podstawie kodu i testów. W swoim hoście kodowania AI poproś zainstalowany workflow:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Teraz wypróbuj najczęstszą ścieżkę adopcji: udokumentuj jedno istniejące
|
|
|
45
37
|
|
|
46
38
|
Po tym użytkownicy zwykle nie powinni wywoływać Truth Sync bezpośrednio. Kontynuuj kodowanie przez swojego hosta AI; zainstalowane instrukcje repozytorium mówią agentowi, aby przy zmianach kodu funkcjonalnego uruchomił odpowiednie testy i wykonał przegląd Truth Sync przed przekazaniem pracy. Ty przeglądasz wynikowy diff kodu oraz diff truth-doc.
|
|
47
39
|
|
|
48
|
-
Jeśli chcesz tylko walidacji CLI
|
|
40
|
+
Jeśli chcesz tylko walidacji CLI, wybierz `none` i uruchom `truthmark check`; później możesz ponownie uruchomić `truthmark init`, aby wybrać platformy.
|
|
49
41
|
|
|
50
42
|
## 💡 Problem: luka w dokumentacji AI
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark ma jeden lokalny kontrakt repozytorium i dwa sposoby korzystania z nie
|
|
|
90
82
|
|
|
91
83
|
Opiekunowie i CI używają CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - instaluje lub odświeża routing, szkielety truth-doc i instrukcje dla hostów AI.
|
|
85
|
+
* `truthmark init` - tworzy lub odświeża konfigurację, pozwala wybrać zero lub więcej platform oraz instaluje routing, szkielety truth-doc i instrukcje dla wybranych hostów AI.
|
|
95
86
|
* `truthmark check` - waliduje truth repozytorium z terminala.
|
|
96
87
|
|
|
97
88
|
### Agenci podążają za kontraktem podczas kodowania
|
|
@@ -199,7 +190,7 @@ Aby poznać użycie komenda po komendzie, porównanie powierzchni, szczegóły o
|
|
|
199
190
|
|
|
200
191
|
Obecne wydanie zapewnia:
|
|
201
192
|
|
|
202
|
-
- lokalne komendy CLI dla
|
|
193
|
+
- lokalne komendy CLI dla init, check, index, impact i workflow status
|
|
203
194
|
- wygenerowane lokalne instrukcje agenta dla Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity i Cursor
|
|
204
195
|
- diagnostykę route, authority, frontmatter, link, freshness, generated-surface, branch-scope i coverage
|
|
205
196
|
- dokumenty truth w zakresie gałęzi oraz pochodne artefakty inteligencji repozytorium
|
|
@@ -223,3 +214,7 @@ Nie jest usługą hostowaną, serwerem MCP, wektorową bazą danych, ukrytą war
|
|
|
223
214
|
## Licencja
|
|
224
215
|
|
|
225
216
|
MIT. Zobacz [LICENSE](../../LICENSE).
|
|
217
|
+
|
|
218
|
+
## Bezpieczne usuwanie
|
|
219
|
+
|
|
220
|
+
Użyj `truthmark uninstall --dry-run`, aby przejrzeć dokładnie wygenerowane powierzchnie hosta, a następnie `truthmark uninstall --apply`, aby je usunąć. Utworzone truth, konfiguracja, szablony, wyjście Portalu, pliki Gemini i niezwiązane pliki użytkownika są zachowane; globalną instalację npm usuń oddzielnie za pomocą swojego menedżera pakietów.
|
|
@@ -13,30 +13,22 @@ Execute isto dentro do repositório Git que você quer que o Truthmark gerencie:
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
Em um terminal interativo, `truthmark init` mostra uma seleção múltipla numerada. Escolha zero ou mais plataformas, ou `none` para uma configuração neutra em relação a host e somente de CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Para scripts e CI, repita `--platform`; `--json` nunca exibe uma solicitação interativa:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
Na primeira execução não interativa sem `--platform`, a configuração permanece neutra; execuções posteriores mantêm a seleção salva em `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
Agora experimente o caminho de adoção mais comum: documentar, a partir do código e dos testes, um comportamento existente. No seu host de codificação com IA, peça ao workflow instalado:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Agora experimente o caminho de adoção mais comum: documentar, a partir do cód
|
|
|
45
37
|
|
|
46
38
|
Depois disso, usuários normalmente não devem invocar o Truth Sync diretamente. Continue codificando por meio do seu host de IA; as instruções instaladas no repositório dizem ao agente para executar os testes relevantes e realizar a revisão Truth Sync antes da entrega quando houver mudanças em código funcional. Você revisa o diff de código resultante junto com o diff dos documentos de verdade.
|
|
47
39
|
|
|
48
|
-
Se você quer apenas validação por CLI
|
|
40
|
+
Se você quer apenas validação por CLI, escolha `none` e continue com `truthmark check`; depois você pode executar `truthmark init` novamente para selecionar plataformas.
|
|
49
41
|
|
|
50
42
|
## 💡 O problema: a lacuna de documentação da IA
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark tem um contrato local do repositório e duas formas de usá-lo.
|
|
|
90
82
|
|
|
91
83
|
Mantenedores e CI usam a CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - instala ou atualiza roteamento, scaffolds de documentos de verdade e instruções para hosts de IA.
|
|
85
|
+
* `truthmark init` - cria ou atualiza a configuração, permite escolher zero ou mais plataformas e instala roteamento, scaffolds de documentos de verdade e instruções dos hosts selecionados.
|
|
95
86
|
* `truthmark check` - valida a verdade do repositório pelo terminal.
|
|
96
87
|
|
|
97
88
|
### Agentes seguem o contrato enquanto programam
|
|
@@ -199,7 +190,7 @@ Para uso comando por comando, comparações de superfícies, detalhes de platafo
|
|
|
199
190
|
|
|
200
191
|
A versão atual fornece:
|
|
201
192
|
|
|
202
|
-
- comandos CLI locais para
|
|
193
|
+
- comandos CLI locais para init, check, index, impact e status de workflows
|
|
203
194
|
- instruções de agente locais do repositório geradas para Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor
|
|
204
195
|
- diagnósticos de roteamento, autoridade, frontmatter, links, frescor, superfícies geradas, escopo de branch e cobertura
|
|
205
196
|
- documentos de verdade com escopo de branch e artefatos derivados de inteligência do repositório
|
|
@@ -223,3 +214,7 @@ Ele não é um serviço hospedado, servidor MCP, banco de dados vetorial, camada
|
|
|
223
214
|
## Licença
|
|
224
215
|
|
|
225
216
|
MIT. Veja [LICENSE](../../LICENSE).
|
|
217
|
+
|
|
218
|
+
## Remoção segura
|
|
219
|
+
|
|
220
|
+
Use `truthmark uninstall --dry-run` para revisar as superfícies de host geradas com precisão, e depois `truthmark uninstall --apply` para removê-las. Truth criada, configuração, templates, saída do Portal, arquivos Gemini e arquivos de usuário não relacionados são preservados; remova uma instalação global de npm separadamente com seu gerenciador de pacotes.
|
|
@@ -13,30 +13,22 @@
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
В интерактивном терминале `truthmark init` показывает нумерованный множественный выбор. Выберите ноль или несколько платформ либо введите `none` для нейтральной к хосту настройки только с CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
В скриптах и CI повторяйте `--platform`; `--json` никогда не показывает запрос:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
При первом неинтерактивном запуске без `--platform` настройка остаётся нейтральной; последующие запуски сохраняют выбор из `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
Теперь попробуйте самый распространенный путь внедрения: задокументируйте одно существующее поведение по коду и тестам. В вашем AI-хосте для разработки попросите установленный рабочий процесс:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ git diff
|
|
|
45
37
|
|
|
46
38
|
После этого пользователям обычно не следует напрямую вызывать Truth Sync. Продолжайте писать код через ваш AI-хост; установленные инструкции репозитория скажут агенту запускать релевантные тесты и выполнять проверку Truth Sync перед передачей, когда меняется функциональный код. Вы просматриваете получившийся diff кода вместе с diff truth-документов.
|
|
47
39
|
|
|
48
|
-
Если
|
|
40
|
+
Если нужна только CLI-валидация, выберите `none` и выполните `truthmark check`; позже можно снова выполнить `truthmark init` и выбрать платформы.
|
|
49
41
|
|
|
50
42
|
## 💡 Проблема: разрыв в AI-документации
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark — не просто очередной инструмент доку
|
|
|
90
82
|
|
|
91
83
|
Мейнтейнеры и CI используют CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - устанавливает или обновляет маршруты, scaffold для truth-doc и инструкции для AI-хостов.
|
|
85
|
+
* `truthmark init` - создаёт или обновляет конфигурацию, позволяет выбрать ноль или несколько платформ и устанавливает маршруты, scaffold для truth-doc и инструкции выбранных AI-хостов.
|
|
95
86
|
* `truthmark check` - проверяет truth репозитория из терминала.
|
|
96
87
|
|
|
97
88
|
### Агенты следуют контракту во время кодинга
|
|
@@ -199,7 +190,7 @@ README — это витрина: быстрый контекст, быстры
|
|
|
199
190
|
|
|
200
191
|
Текущий релиз предоставляет:
|
|
201
192
|
|
|
202
|
-
- локальные CLI-команды для
|
|
193
|
+
- локальные CLI-команды для init, check, index, impact и workflow status
|
|
203
194
|
- сгенерированные локальные инструкции агента для Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity и Cursor
|
|
204
195
|
- диагностику route, authority, frontmatter, links, freshness, generated-surface, branch-scope и coverage
|
|
205
196
|
- branch-scoped truth docs и производные артефакты repository intelligence
|
|
@@ -223,3 +214,7 @@ Truthmark намеренно мал: локальный, закоммиченн
|
|
|
223
214
|
## Лицензия
|
|
224
215
|
|
|
225
216
|
MIT. См. [LICENSE](../../LICENSE).
|
|
217
|
+
|
|
218
|
+
## Безопасное удаление
|
|
219
|
+
|
|
220
|
+
Используйте `truthmark uninstall --dry-run` для проверки точно сгенерированных host-поверхностей, затем `truthmark uninstall --apply` для их удаления. Сформированные truth, конфигурация, шаблоны, вывод Portal, файлы Gemini и несвязанные пользовательские файлы сохраняются; глобальную установку npm удаляйте отдельно через менеджер пакетов.
|
|
@@ -13,30 +13,22 @@ Bunu Truthmark tarafından yönetilmesini istediğiniz Git deposunun içinde ça
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
Etkileşimli bir terminalde `truthmark init`, numaralı bir çoklu seçim gösterir. Sıfır veya daha fazla platform seçin ya da ana makineden bağımsız, yalnızca CLI kurulumu için `none` girin.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Betikler ve CI için `--platform` seçeneğini tekrarlayın; `--json` hiçbir zaman istem göstermez:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
`--platform` olmadan ilk etkileşimsiz çalıştırmada kurulum ana makineden bağımsız kalır; sonraki çalıştırmalar `.truthmark/config.yml` içinde kayıtlı seçimi korur.
|
|
31
|
+
|
|
40
32
|
Şimdi en yaygın benimseme yolunu deneyin: kod ve testlerden mevcut bir davranışı belgeleyin. AI kodlama ana makinenizde, kurulu iş akışına şunu isteyin:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ git diff
|
|
|
45
37
|
|
|
46
38
|
Bundan sonra kullanıcılar normalde Truth Sync'i doğrudan çağırmamalıdır. AI ana makineniz üzerinden kod yazmaya devam edin; kurulu depo yönergeleri, işlevsel kod değiştiğinde teslimden önce ajana ilgili testleri çalıştırmasını ve Truth Sync incelemesini yapmasını söyler. Siz ortaya çıkan kod farkını ve truth-belge farkını incelersiniz.
|
|
47
39
|
|
|
48
|
-
Yalnızca CLI doğrulaması
|
|
40
|
+
Yalnızca CLI doğrulaması istiyorsanız `none` seçip `truthmark check` çalıştırın; platform seçmek için daha sonra `truthmark init` komutunu yeniden çalıştırabilirsiniz.
|
|
49
41
|
|
|
50
42
|
## 💡 Sorun: AI dokümantasyon boşluğu
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark’ın depo yerelinde tek bir sözleşmesi ve onu kullanmanın iki yolu
|
|
|
90
82
|
|
|
91
83
|
Bakımcılar ve CI, CLI kullanır:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - yönlendirmeyi, truth-doc iskelelerini ve AI ana makine talimatlarını kurar veya yeniler.
|
|
85
|
+
* `truthmark init` - yapılandırmayı oluşturur veya yeniler, sıfır ya da daha fazla platform seçtirir ve yönlendirmeyi, truth-doc iskelelerini ve seçilen AI ana makine talimatlarını kurar.
|
|
95
86
|
* `truthmark check` - depo gerçeğini terminalden doğrular.
|
|
96
87
|
|
|
97
88
|
### Ajanlar kod yazarken sözleşmeyi izler
|
|
@@ -199,7 +190,7 @@ Komut komut kullanım, yüzey karşılaştırmaları, desteklenen platform ayrı
|
|
|
199
190
|
|
|
200
191
|
Mevcut sürüm şunları sağlar:
|
|
201
192
|
|
|
202
|
-
-
|
|
193
|
+
- init, check, index, impact ve iş akışı durumu için yerel CLI komutları
|
|
203
194
|
- Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity ve Cursor için oluşturulan depo yerelinde ajan talimatları
|
|
204
195
|
- yönlendirme, yetki, frontmatter, bağlantı, güncellik, üretilmiş yüzey, dal kapsamı ve kapsam tanıları
|
|
205
196
|
- dal kapsamlı gerçeklik belgeleri ve türetilmiş depo zekâsı artefaktları
|
|
@@ -223,3 +214,7 @@ Barındırılan bir hizmet, MCP sunucusu, vektör veritabanı, gizli bellek katm
|
|
|
223
214
|
## Lisans
|
|
224
215
|
|
|
225
216
|
MIT. Bkz. [LICENSE](../../LICENSE).
|
|
217
|
+
|
|
218
|
+
## Güvenli kaldırma
|
|
219
|
+
|
|
220
|
+
`truthmark uninstall --dry-run` komutunu kullanarak tam olarak oluşturulan ana bilgisayar yüzeylerini inceleyin, ardından kaldırmak için `truthmark uninstall --apply` komutunu çalıştırın. Oluşturulan truth, yapılandırma, şablonlar, Portal çıktısı, Gemini dosyaları ve alakasız kullanıcı dosyaları korunur; global npm kurulumunu paket yöneticinizle ayrı olarak kaldırın.
|
|
@@ -13,30 +13,22 @@ Chạy lệnh này bên trong kho Git mà bạn muốn Truthmark quản lý:
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
Trong terminal tương tác, `truthmark init` hiển thị danh sách đa lựa chọn được đánh số. Chọn không, một hoặc nhiều nền tảng, hoặc nhập `none` để thiết lập chỉ dùng CLI và không gắn với host.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Với script và CI, hãy lặp lại `--platform`; `--json` không bao giờ hiển thị lời nhắc:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
Ở lần chạy không tương tác đầu tiên mà không có `--platform`, thiết lập vẫn trung lập với host; các lần chạy sau giữ lựa chọn đã lưu trong `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
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
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Bây giờ hãy thử lộ trình áp dụng phổ biến nhất: ghi tài liệ
|
|
|
45
37
|
|
|
46
38
|
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
39
|
|
|
48
|
-
Nếu bạn chỉ muốn xác thực bằng CLI
|
|
40
|
+
Nếu bạn chỉ muốn xác thực bằng CLI, hãy chọn `none` rồi chạy `truthmark check`; bạn có thể chạy lại `truthmark init` sau để chọn nền tảng.
|
|
49
41
|
|
|
50
42
|
## 💡 Vấn đề: khoảng trống tài liệu AI
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark có một hợp đồng cục bộ trong kho và hai cách sử dụng
|
|
|
90
82
|
|
|
91
83
|
Người bảo trì và CI dùng CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
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.
|
|
85
|
+
* `truthmark init` - tạo hoặc làm mới cấu hình, cho phép chọn không, một hoặc nhiều nền tảng, rồi cài đặt định tuyến, scaffold truth-doc và hướng dẫn cho các AI host đã chọn.
|
|
95
86
|
* `truthmark check` - xác thực sự thật của kho từ terminal.
|
|
96
87
|
|
|
97
88
|
### Tác tử tuân theo hợp đồng khi viết mã
|
|
@@ -199,7 +190,7 @@ README là mặt tiền: ngữ cảnh nhanh, bắt đầu nhanh và mô hình t
|
|
|
199
190
|
|
|
200
191
|
Bản phát hành hiện tại cung cấp:
|
|
201
192
|
|
|
202
|
-
- các lệnh CLI cục bộ cho
|
|
193
|
+
- các lệnh CLI cục bộ cho init, check, index, impact và trạng thái quy trình
|
|
203
194
|
- 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
195
|
- 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
196
|
- 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
|
|
@@ -223,3 +214,7 @@ Nó không phải dịch vụ lưu trữ, máy chủ MCP, cơ sở dữ liệu v
|
|
|
223
214
|
## Giấy phép
|
|
224
215
|
|
|
225
216
|
MIT. Xem [LICENSE](../../LICENSE).
|
|
217
|
+
|
|
218
|
+
## Gỡ cài đặt an toàn
|
|
219
|
+
|
|
220
|
+
Sử dụng `truthmark uninstall --dry-run` để xem lại chính xác các bề mặt host đã tạo ra, rồi `truthmark uninstall --apply` để loại bỏ chúng. Các truth đã tạo, cấu hình, mẫu, đầu ra Portal, tệp Gemini và các tệp người dùng không liên quan sẽ được giữ nguyên; hãy gỡ bỏ cài đặt npm toàn cục riêng biệt bằng trình quản lý gói của bạn.
|
|
@@ -13,30 +13,22 @@
|
|
|
13
13
|
```bash
|
|
14
14
|
cd /path/to/your-repo
|
|
15
15
|
npm install -g truthmark
|
|
16
|
-
truthmark
|
|
16
|
+
truthmark init
|
|
17
|
+
truthmark check
|
|
18
|
+
git diff
|
|
17
19
|
```
|
|
18
20
|
|
|
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
|
-
```
|
|
21
|
+
在交互式终端中,`truthmark init` 会显示带编号的多选列表。可选择零个或多个平台,也可输入 `none`,仅进行与宿主无关的 CLI 设置。
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
在脚本和 CI 中可重复使用 `--platform`;`--json` 永远不会提示输入:
|
|
33
24
|
|
|
34
25
|
```bash
|
|
35
|
-
truthmark init
|
|
36
|
-
truthmark
|
|
37
|
-
git diff
|
|
26
|
+
truthmark init --platform codex --platform cursor
|
|
27
|
+
truthmark init --json
|
|
38
28
|
```
|
|
39
29
|
|
|
30
|
+
首次非交互运行且没有 `--platform` 时,初始化保持宿主中立;之后的运行会保留 `.truthmark/config.yml` 中保存的选择。
|
|
31
|
+
|
|
40
32
|
现在尝试最常见的采用路径:根据代码和测试记录一个已有行为。在你的 AI 编码宿主中,请求已安装的工作流:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ git diff
|
|
|
45
37
|
|
|
46
38
|
之后,用户通常不应直接调用 Truth Sync。继续通过你的 AI 宿主编写代码;已安装的仓库指令会告诉代理:当功能代码发生变化时,在交接前运行相关测试并执行 Truth Sync 审查。你审查最终的代码 diff 和事实文档 diff。
|
|
47
39
|
|
|
48
|
-
|
|
40
|
+
如果暂时只需要 CLI 验证,请选择 `none`,然后运行 `truthmark check`;之后可重新运行 `truthmark init` 来选择平台。
|
|
49
41
|
|
|
50
42
|
## 💡 问题:AI 文档缺口
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark 有一个仓库本地契约,以及两种使用方式。
|
|
|
90
82
|
|
|
91
83
|
维护者和 CI 使用 CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - 安装或刷新路由、事实文档脚手架和 AI 宿主指令。
|
|
85
|
+
* `truthmark init` - 创建或刷新配置,选择零个或多个平台,并安装路由、事实文档脚手架及所选 AI 宿主的指令。
|
|
95
86
|
* `truthmark check` - 从终端验证仓库事实。
|
|
96
87
|
|
|
97
88
|
### 代理在编码时遵循契约
|
|
@@ -199,7 +190,7 @@ README 是门面:快速背景、快速开始和核心心智模型。
|
|
|
199
190
|
|
|
200
191
|
当前版本提供:
|
|
201
192
|
|
|
202
|
-
- 用于
|
|
193
|
+
- 用于 init、check、index、impact 和 workflow status 的本地 CLI 命令
|
|
203
194
|
- 为 Codex、Claude Code、GitHub Copilot、OpenCode、Antigravity 和 Cursor 生成的仓库本地代理指令
|
|
204
195
|
- 路由、权限、frontmatter、链接、新鲜度、生成界面、分支范围和覆盖率诊断
|
|
205
196
|
- 按分支生效的事实文档和派生的仓库智能产物
|
|
@@ -223,3 +214,7 @@ Truthmark 有意保持小而明确:本地、已提交、按分支生效、可
|
|
|
223
214
|
## 许可证
|
|
224
215
|
|
|
225
216
|
MIT。见 [LICENSE](../../LICENSE)。
|
|
217
|
+
|
|
218
|
+
## 安全移除
|
|
219
|
+
|
|
220
|
+
使用 `truthmark uninstall --dry-run` 查看精确生成的主机表面(host surfaces),然后使用 `truthmark uninstall --apply` 将其移除。已创建的 truth、配置、模板、Portal 输出、Gemini 文件以及不相关的用户文件将被保留;请使用包管理器单独移除全局 npm 安装。
|