truthmark 2.2.7 → 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 +13 -22
- package/dist/main.js +1985 -1897
- package/dist/main.js.map +1 -1
- package/docs/README.md +7 -7
- package/docs/readmes/README.ar.md +12 -21
- package/docs/readmes/README.de.md +12 -21
- package/docs/readmes/README.el.md +12 -21
- package/docs/readmes/README.es.md +12 -21
- package/docs/readmes/README.fr.md +12 -21
- package/docs/readmes/README.id.md +12 -21
- package/docs/readmes/README.it.md +12 -21
- package/docs/readmes/README.ja.md +12 -21
- package/docs/readmes/README.ko.md +12 -21
- package/docs/readmes/README.pl.md +12 -21
- package/docs/readmes/README.pt.md +12 -21
- package/docs/readmes/README.ru.md +12 -21
- package/docs/readmes/README.tr.md +12 -21
- package/docs/readmes/README.vi.md +12 -21
- package/docs/readmes/README.zh.md +12 -21
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
status: active
|
|
3
3
|
doc_type: index
|
|
4
|
-
last_reviewed: 2026-
|
|
4
|
+
last_reviewed: 2026-07-30
|
|
5
5
|
source_of_truth:
|
|
6
6
|
- docs/ai/repo-rules.md
|
|
7
7
|
- ../.truthmark/config.yml
|
|
@@ -35,7 +35,7 @@ Repository-wide conflict order and completion policy live in [docs/ai/repo-rules
|
|
|
35
35
|
- `docs/truthmark/product/` for product capability promises, boundaries, and acceptance criteria
|
|
36
36
|
- `docs/truthmark/engineering/` for current implementation behavior, architecture, contracts, workflows, and operations
|
|
37
37
|
- `docs/architecture/` for repository-specific architecture guardrails
|
|
38
|
-
- `docs/research/` for non-canonical research and
|
|
38
|
+
- `docs/research/` for non-canonical research evidence, evaluations, and comparisons
|
|
39
39
|
- `docs/truthmark/templates/` for editable scaffold templates used to create new docs
|
|
40
40
|
- `docs/truthmark/engineering/contracts/` for stable contracts the CLI exposes
|
|
41
41
|
|
|
@@ -54,7 +54,7 @@ Repository-wide conflict order and completion policy live in [docs/ai/repo-rules
|
|
|
54
54
|
| `docs/truthmark/product/` | product truth | agent | Product capability promises, boundaries, decisions, and acceptance criteria |
|
|
55
55
|
| `docs/truthmark/engineering/` | engineering truth | agent | Current implementation behavior for init, check, contracts, workflows, and operations |
|
|
56
56
|
| `docs/architecture/` | architecture | agent | Repository-specific architecture guardrails |
|
|
57
|
-
| `docs/research/` | research | human | Non-canonical research,
|
|
57
|
+
| `docs/research/` | research | human | Non-canonical research evidence, evaluations, and comparisons |
|
|
58
58
|
| `docs/truthmark/templates/` | template | both | Editable templates for scaffolded docs; templates are not Truth Sync targets |
|
|
59
59
|
| `docs/user-guide.md` | guide | human | Detailed usage guide kept out of the root README so onboarding stays concise |
|
|
60
60
|
|
|
@@ -76,13 +76,13 @@ Canonical docs should include frontmatter and keep these fields current:
|
|
|
76
76
|
- When `truthmark init` or scaffolded files change, update the relevant truth or architecture doc, not only [README.md](../README.md).
|
|
77
77
|
- When `truthmark check` changes what it validates or how it reports diagnostics, update both the current truth doc and the contract doc.
|
|
78
78
|
- When major product, onboarding, install, command, positioning, or workflow behavior changes, review the root [README.md](../README.md) and update it if the human entry point would otherwise be stale.
|
|
79
|
-
- Keep
|
|
80
|
-
- When current behavior changes for architecture, contracts, or lane-separated truth docs, update the owning
|
|
79
|
+
- Keep active docs current-state focused; promote necessary accepted rationale into the owning decision section and rely on Git history for superseded plans.
|
|
80
|
+
- When current behavior changes for architecture, contracts, or lane-separated truth docs, update the owning current-behavior and Product Decisions or Engineering Decisions sections in the same change.
|
|
81
81
|
- Do not keep parallel documentation trees for the same subject.
|
|
82
82
|
|
|
83
83
|
## Important Truthmark-Specific Caveat
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
`truthmark init` is the only setup command. In a TTY it offers a numbered zero-or-more platform selection; repeatable `--platform <id>` values provide noninteractive selection, while `--json` never prompts. A first noninteractive run without platform flags remains host-neutral. Init creates or updates the version-2 `.truthmark/config.yml`, then writes a root route index plus one child route file under the configured routing root.
|
|
86
86
|
|
|
87
87
|
## Recommended Reading Order
|
|
88
88
|
|
|
@@ -107,7 +107,7 @@ Use the route files under [docs/truthmark/routes/](truthmark/routes/) when desig
|
|
|
107
107
|
|
|
108
108
|
## Maintenance Principle
|
|
109
109
|
|
|
110
|
-
The canonical tree should stay small, explicit, and current.
|
|
110
|
+
The canonical tree should stay small, explicit, and current. Git history provides traceability for superseded context; active docs keep current behavior in the owning current-state section and accepted rationale in the owning decision section.
|
|
111
111
|
|
|
112
112
|
## Product Decisions
|
|
113
113
|
|
|
@@ -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
|
جرّب الآن مسار الاعتماد الأكثر شيوعاً: توثيق سلوك موجود من الكود والاختبارات. في مضيف البرمجة بالذكاء الاصطناعي، اطلب من سير العمل المثبّت:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ git diff
|
|
|
45
37
|
|
|
46
38
|
بعد ذلك، لا ينبغي للمستخدمين عادةً استدعاء Truth Sync مباشرة. واصل البرمجة عبر مضيف الذكاء الاصطناعي؛ فتعليمات المستودع المثبّتة تطلب من الوكيل تشغيل الاختبارات ذات الصلة وتنفيذ مراجعة Truth Sync قبل التسليم عندما تتغير الشيفرة الوظيفية. أنت تراجع فرق الكود الناتج مع فرق توثيق الحقيقة.
|
|
47
39
|
|
|
48
|
-
إذا كنت تريد
|
|
40
|
+
إذا كنت تريد التحقق عبر CLI فقط، فاختر `none` ثم شغّل `truthmark check`؛ ويمكنك إعادة تشغيل `truthmark init` لاحقاً لاختيار المنصات.
|
|
49
41
|
|
|
50
42
|
## 💡 المشكلة: فجوة توثيق الذكاء الاصطناعي
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark ليس مجرد أداة توثيق أخرى. إنه مدمج بعمق
|
|
|
90
82
|
|
|
91
83
|
يستخدم الصائنون وCI واجهة CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - تثبيت أو تحديث التوجيه، وقوالب وثائق الحقيقة، وتعليمات مضيف الذكاء الاصطناعي.
|
|
85
|
+
* `truthmark init` - إنشاء الإعدادات أو تحديثها، واختيار صفر أو أكثر من المنصات، وتثبيت التوجيه وقوالب وثائق الحقيقة وتعليمات المضيفات المختارة.
|
|
95
86
|
* `truthmark check` - التحقق من حقيقة المستودع من الطرفية.
|
|
96
87
|
|
|
97
88
|
### الوكلاء يتبعون العقد أثناء البرمجة
|
|
@@ -199,7 +190,7 @@ README هو الواجهة: سياق سريع، وبدء سريع، والنمو
|
|
|
199
190
|
|
|
200
191
|
يوفر الإصدار الحالي:
|
|
201
192
|
|
|
202
|
-
- أوامر CLI محلية
|
|
193
|
+
- أوامر CLI محلية للتهيئة والتحقق والفهرسة وتحليل الأثر وحالة سير العمل
|
|
203
194
|
- تعليمات وكلاء محلية مولّدة لـ Codex وClaude Code وGitHub Copilot وOpenCode وAntigravity وCursor
|
|
204
195
|
- تشخيصات للتوجيه والسلطة وfrontmatter والروابط والحداثة والأسطح المولّدة ونطاق الفرع والتغطية
|
|
205
196
|
- وثائق حقيقة مرتبطة بالفرع وعناصر مستمدة لاستخبارات المستودع
|
|
@@ -13,30 +13,22 @@ Führe dies in dem Git-Repository aus, das Truthmark verwalten soll:
|
|
|
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
|
+
In einem interaktiven Terminal zeigt `truthmark init` eine nummerierte Mehrfachauswahl. Wähle null oder mehr Plattformen oder `none` für eine host-neutrale, reine CLI-Einrichtung.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Für Skripte und CI kannst du `--platform` wiederholen; `--json` fragt niemals interaktiv nach:
|
|
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
|
+
Beim ersten nicht interaktiven Lauf ohne `--platform` bleibt die Einrichtung host-neutral; spätere Läufe behalten die in `.truthmark/config.yml` gespeicherte Auswahl bei.
|
|
31
|
+
|
|
40
32
|
Probiere nun den häufigsten Einstiegspfad: ein bestehendes Verhalten anhand von Code und Tests dokumentieren. Bitte in deinem KI-Coding-Host den installierten Workflow:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Probiere nun den häufigsten Einstiegspfad: ein bestehendes Verhalten anhand von
|
|
|
45
37
|
|
|
46
38
|
Danach sollten Nutzer Truth Sync normalerweise nicht direkt aufrufen. Programmiere weiter über deinen KI-Host; die installierten Repository-Anweisungen weisen den Agenten an, relevante Tests auszuführen und vor der Übergabe die Truth Sync-Prüfung durchzuführen, wenn funktionaler Code geändert wurde. Du prüfst den daraus entstehenden Code-Diff plus den Truth-Doc-Diff.
|
|
47
39
|
|
|
48
|
-
Wenn du nur CLI-Validierung möchtest
|
|
40
|
+
Wenn du nur CLI-Validierung möchtest, wähle `none` und fahre mit `truthmark check` fort; du kannst `truthmark init` später erneut ausführen und Plattformen auswählen.
|
|
49
41
|
|
|
50
42
|
## 💡 Das Problem: die KI-Dokumentationslücke
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark hat einen repo-lokalen Vertrag und zwei Arten, ihn zu nutzen.
|
|
|
90
82
|
|
|
91
83
|
Maintainer und CI nutzen die CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - installiert oder aktualisiert Routing, Truth-Doc-Scaffolds und Anweisungen für KI-Hosts.
|
|
85
|
+
* `truthmark init` - erstellt oder aktualisiert die Konfiguration, lässt null oder mehr Plattformen auswählen und installiert Routing, Truth-Doc-Scaffolds und die ausgewählten KI-Host-Anweisungen.
|
|
95
86
|
* `truthmark check` - validiert die Repository-Truth im Terminal.
|
|
96
87
|
|
|
97
88
|
### Agenten folgen dem Vertrag beim Coden
|
|
@@ -199,7 +190,7 @@ Für befehlsweise Nutzung, Oberflächenvergleiche, Details zu unterstützten Pla
|
|
|
199
190
|
|
|
200
191
|
Die aktuelle Version bietet:
|
|
201
192
|
|
|
202
|
-
- lokale CLI-Befehle für
|
|
193
|
+
- lokale CLI-Befehle für init, check, index, impact und Workflow-Status
|
|
203
194
|
- generierte repo-lokale Agentenanweisungen für Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity und Cursor
|
|
204
195
|
- Diagnosen für Routing, Autorität, Frontmatter, Links, Aktualität, generierte Oberflächen, Branch-Scope und Abdeckung
|
|
205
196
|
- branch-bezogene Truth-Dokumente und abgeleitete Repository-Intelligence-Artefakte
|
|
@@ -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` για ρύθμιση ουδέτερη ως προς τον host και μόνο με CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Για scripts και 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
|
Τώρα δοκιμάστε την πιο συνηθισμένη διαδρομή υιοθέτησης: τεκμηριώστε μια υπάρχουσα συμπεριφορά από κώδικα και tests. Στον AI coding host σας, ζητήστε από την εγκατεστημένη ροή εργασίας:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ git diff
|
|
|
45
37
|
|
|
46
38
|
Μετά από αυτό, οι χρήστες συνήθως δεν πρέπει να καλούν απευθείας το Truth Sync. Συνεχίστε να γράφετε κώδικα μέσω του AI host σας· οι εγκατεστημένες οδηγίες του αποθετηρίου λένε στον πράκτορα να εκτελεί τα σχετικά tests και να πραγματοποιεί την ανασκόπηση Truth Sync πριν από την παράδοση όταν αλλάζει λειτουργικός κώδικας. Εσείς ανασκοπείτε το προκύπτον code 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 @@ git diff
|
|
|
90
82
|
|
|
91
83
|
Οι συντηρητές και το CI χρησιμοποιούν το CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - εγκαθιστά ή ανανεώνει routing, truth-doc scaffolds και οδηγίες για AI hosts.
|
|
85
|
+
* `truthmark init` - δημιουργεί ή ανανεώνει τη διαμόρφωση, επιτρέπει επιλογή μηδέν ή περισσότερων πλατφορμών και εγκαθιστά routing, truth-doc scaffolds και οδηγίες για τους επιλεγμένους AI hosts.
|
|
95
86
|
* `truthmark check` - επικυρώνει την αλήθεια του αποθετηρίου από το τερματικό.
|
|
96
87
|
|
|
97
88
|
### Οι agents ακολουθούν το συμβόλαιο ενώ γράφουν κώδικα
|
|
@@ -199,7 +190,7 @@ keep the result reviewable in Git
|
|
|
199
190
|
|
|
200
191
|
Η τρέχουσα έκδοση παρέχει:
|
|
201
192
|
|
|
202
|
-
- τοπικές CLI commands για
|
|
193
|
+
- τοπικές CLI commands για init, check, index, impact και workflow status
|
|
203
194
|
- παραγόμενες repo-local οδηγίες για agents για Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity και Cursor
|
|
204
195
|
- diagnostics για route, authority, frontmatter, link, freshness, generated-surface, branch-scope και coverage
|
|
205
196
|
- έγγραφα αλήθειας με scope branch και παράγωγα τεχνουργήματα ευφυΐας αποθετηρίου
|
|
@@ -13,30 +13,22 @@ Ejecuta esto dentro del repositorio Git que quieres que Truthmark gestione:
|
|
|
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
|
+
En una terminal interactiva, `truthmark init` muestra una selección múltiple numerada. Elige cero o más plataformas, o `none` para una configuración neutral respecto al host y solo de CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Para scripts y CI, repite `--platform`; `--json` nunca solicita entrada interactiva:
|
|
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
|
+
En la primera ejecución no interactiva sin `--platform`, la configuración permanece neutral; las ejecuciones posteriores conservan la selección guardada en `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
Ahora prueba la ruta de adopción más común: documentar un comportamiento existente a partir del código y las pruebas. En tu host de codificación con IA, pídele al workflow instalado:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Ahora prueba la ruta de adopción más común: documentar un comportamiento exis
|
|
|
45
37
|
|
|
46
38
|
Después de eso, normalmente los usuarios no deberían invocar Truth Sync directamente. Sigue programando mediante tu host de IA; las instrucciones instaladas en el repositorio le dicen al agente que ejecute las pruebas pertinentes y realice la revisión de Truth Sync antes de la entrega cuando haya cambios de código funcional. Tú revisas el diff de código resultante junto con el diff de los documentos de verdad.
|
|
47
39
|
|
|
48
|
-
Si solo quieres validación por CLI
|
|
40
|
+
Si solo quieres validación por CLI, elige `none` y continúa con `truthmark check`; más tarde puedes volver a ejecutar `truthmark init` para seleccionar plataformas.
|
|
49
41
|
|
|
50
42
|
## 💡 El problema: la brecha de documentación de la IA
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark tiene un contrato local del repositorio y dos formas de usarlo.
|
|
|
90
82
|
|
|
91
83
|
Los mantenedores y CI usan la CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - instala o actualiza el enrutamiento, los andamios de documentos de verdad y las instrucciones para hosts de IA.
|
|
85
|
+
* `truthmark init` - crea o actualiza la configuración, permite elegir cero o más plataformas e instala el enrutamiento, los andamios de documentos de verdad y las instrucciones de los hosts elegidos.
|
|
95
86
|
* `truthmark check` - valida la verdad del repositorio desde la terminal.
|
|
96
87
|
|
|
97
88
|
### Los agentes siguen el contrato mientras programan
|
|
@@ -199,7 +190,7 @@ Para uso comando por comando, comparaciones de superficies, detalles de platafor
|
|
|
199
190
|
|
|
200
191
|
La versión actual proporciona:
|
|
201
192
|
|
|
202
|
-
- comandos CLI locales para
|
|
193
|
+
- comandos CLI locales para init, check, index, impact y estado de workflows
|
|
203
194
|
- instrucciones de agente locales del repositorio generadas para Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity y Cursor
|
|
204
195
|
- diagnósticos de enrutamiento, autoridad, frontmatter, enlaces, frescura, superficies generadas, alcance de rama y cobertura
|
|
205
196
|
- documentos de verdad con alcance de rama y artefactos derivados de inteligencia del repositorio
|
|
@@ -13,30 +13,22 @@ Exécutez ceci dans le dépôt Git que vous voulez faire gérer par 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
|
+
Dans un terminal interactif, `truthmark init` affiche une sélection multiple numérotée. Choisissez zéro ou plusieurs plateformes, ou `none` pour une installation neutre vis-à-vis des hôtes et limitée à la CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Pour les scripts et la CI, répétez `--platform` ; `--json` ne déclenche jamais d’invite :
|
|
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
|
+
Lors d’une première exécution non interactive sans `--platform`, l’installation reste neutre ; les exécutions suivantes conservent la sélection enregistrée dans `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
Essayez maintenant le chemin d’adoption le plus courant : documenter, à partir du code et des tests, un comportement existant. Dans votre hôte de codage IA, demandez au workflow installé :
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Essayez maintenant le chemin d’adoption le plus courant : documenter, à parti
|
|
|
45
37
|
|
|
46
38
|
Après cela, les utilisateurs ne devraient normalement pas invoquer Truth Sync directement. Continuez à coder dans votre hôte d’IA ; les instructions installées dans le dépôt indiquent à l’agent d’exécuter les tests pertinents et d’effectuer la revue Truth Sync avant la remise lorsqu’il y a des changements de code fonctionnel. Vous examinez le diff de code obtenu ainsi que le diff des documents de vérité.
|
|
47
39
|
|
|
48
|
-
Si vous voulez seulement la validation CLI
|
|
40
|
+
Si vous voulez seulement la validation CLI, choisissez `none` puis exécutez `truthmark check` ; vous pourrez relancer `truthmark init` plus tard pour sélectionner des plateformes.
|
|
49
41
|
|
|
50
42
|
## 💡 Le problème : l’écart de documentation avec l’IA
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark fournit un contrat local au dépôt, avec deux façons de l’utiliser
|
|
|
90
82
|
|
|
91
83
|
Les mainteneurs et la CI utilisent la CLI :
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - installe ou actualise le routage, les échafaudages de documents de vérité et les instructions pour les hôtes IA.
|
|
85
|
+
* `truthmark init` - crée ou actualise la configuration, permet de choisir zéro ou plusieurs plateformes et installe le routage, les échafaudages de documents de vérité et les instructions des hôtes sélectionnés.
|
|
95
86
|
* `truthmark check` - valide la vérité du dépôt depuis le terminal.
|
|
96
87
|
|
|
97
88
|
### Les agents suivent le contrat pendant qu’ils codent
|
|
@@ -199,7 +190,7 @@ Pour l’utilisation commande par commande, les comparaisons de surfaces, les d
|
|
|
199
190
|
|
|
200
191
|
La version actuelle fournit :
|
|
201
192
|
|
|
202
|
-
- des commandes CLI locales pour
|
|
193
|
+
- des commandes CLI locales pour init, check, index, impact et l’état des workflows
|
|
203
194
|
- instructions agent locales au dépôt générées pour Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity et Cursor
|
|
204
195
|
- des diagnostics de routage, d’autorité, de frontmatter, de liens, de fraîcheur, de surfaces générées, de portée de branche et de couverture
|
|
205
196
|
- des documents de vérité limités à la branche et des artefacts dérivés d’intelligence du dépôt
|
|
@@ -13,30 +13,22 @@ Jalankan ini di dalam repositori Git yang ingin Anda kelola dengan 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
|
+
Di terminal interaktif, `truthmark init` menampilkan pilihan ganda bernomor. Pilih nol atau lebih platform, atau masukkan `none` untuk penyiapan netral terhadap host yang hanya memakai CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Untuk skrip dan CI, ulangi `--platform`; `--json` tidak pernah menampilkan prompt:
|
|
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
|
+
Pada proses noninteraktif pertama tanpa `--platform`, penyiapan tetap netral terhadap host; proses berikutnya mempertahankan pilihan yang tersimpan di `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
Sekarang coba jalur adopsi yang paling umum: dokumentasikan satu perilaku yang sudah ada dari kode dan pengujian. Di host pengodean AI Anda, minta alur kerja yang terpasang:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Sekarang coba jalur adopsi yang paling umum: dokumentasikan satu perilaku yang s
|
|
|
45
37
|
|
|
46
38
|
Setelah itu, pengguna biasanya tidak perlu memanggil Truth Sync secara langsung. Teruslah membuat kode melalui host AI Anda; instruksi repositori yang terpasang memberi tahu agen untuk menjalankan pengujian yang relevan dan melakukan tinjauan Truth Sync sebelum serah terima ketika kode fungsional berubah. Anda meninjau diff kode yang dihasilkan beserta diff dokumen truth.
|
|
47
39
|
|
|
48
|
-
Jika Anda hanya menginginkan validasi CLI
|
|
40
|
+
Jika Anda hanya menginginkan validasi CLI, pilih `none` lalu jalankan `truthmark check`; Anda dapat menjalankan ulang `truthmark init` nanti untuk memilih platform.
|
|
49
41
|
|
|
50
42
|
## 💡 Masalah: kesenjangan dokumentasi AI
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark memiliki satu kontrak lokal repositori dengan dua cara pemakaian.
|
|
|
90
82
|
|
|
91
83
|
Pemelihara dan CI menggunakan CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - memasang atau menyegarkan perutean, scaffold dokumen kebenaran, dan instruksi host AI.
|
|
85
|
+
* `truthmark init` - membuat atau menyegarkan konfigurasi, memilih nol atau lebih platform, lalu memasang perutean, scaffold dokumen kebenaran, dan instruksi untuk host AI yang dipilih.
|
|
95
86
|
* `truthmark check` - memvalidasi kebenaran repositori dari terminal.
|
|
96
87
|
|
|
97
88
|
### Agen mengikuti kontrak saat membuat kode
|
|
@@ -199,7 +190,7 @@ Untuk penggunaan per perintah, perbandingan permukaan, detail platform yang didu
|
|
|
199
190
|
|
|
200
191
|
Rilis saat ini menyediakan:
|
|
201
192
|
|
|
202
|
-
- perintah CLI lokal untuk
|
|
193
|
+
- perintah CLI lokal untuk init, check, index, impact, dan status alur kerja
|
|
203
194
|
- instruksi agen lokal repositori yang dihasilkan untuk Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, dan Cursor
|
|
204
195
|
- diagnostik perutean, otoritas, frontmatter, tautan, kesegaran, permukaan yang dihasilkan, cakupan branch, dan coverage
|
|
205
196
|
- dokumen kebenaran berlingkup branch dan artefak kecerdasan repositori turunan
|
|
@@ -13,30 +13,22 @@ Esegui questo comando nel repository Git che vuoi far gestire a 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
|
+
In un terminale interattivo, `truthmark init` mostra una selezione multipla numerata. Scegli zero o più piattaforme, oppure `none` per una configurazione neutrale rispetto all’host e solo CLI.
|
|
31
22
|
|
|
32
|
-
|
|
23
|
+
Per script e CI, ripeti `--platform`; `--json` non mostra mai prompt:
|
|
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
|
+
Alla prima esecuzione non interattiva senza `--platform`, la configurazione resta neutrale; le esecuzioni successive mantengono la selezione salvata in `.truthmark/config.yml`.
|
|
31
|
+
|
|
40
32
|
Ora prova il percorso di adozione più comune: documentare un comportamento esistente a partire da codice e test. Nel tuo host di coding IA, chiedi al workflow installato:
|
|
41
33
|
|
|
42
34
|
```text
|
|
@@ -45,7 +37,7 @@ Ora prova il percorso di adozione più comune: documentare un comportamento esis
|
|
|
45
37
|
|
|
46
38
|
Dopo questo, di norma gli utenti non dovrebbero invocare Truth Sync direttamente. Continua a scrivere codice tramite il tuo host IA; le istruzioni installate nel repository dicono all’agente di eseguire i test pertinenti e svolgere la revisione Truth Sync prima della consegna quando cambiano parti di codice funzionale. Tu revisioni il diff di codice risultante insieme al diff dei documenti di verità.
|
|
47
39
|
|
|
48
|
-
Se vuoi solo la validazione CLI
|
|
40
|
+
Se vuoi solo la validazione CLI, scegli `none` e continua con `truthmark check`; potrai rieseguire `truthmark init` in seguito per selezionare le piattaforme.
|
|
49
41
|
|
|
50
42
|
## 💡 Il problema: il divario di documentazione dell’IA
|
|
51
43
|
|
|
@@ -90,8 +82,7 @@ Truthmark ha un contratto locale al repository e due modi per usarlo.
|
|
|
90
82
|
|
|
91
83
|
Maintainer e CI usano la CLI:
|
|
92
84
|
|
|
93
|
-
* `truthmark
|
|
94
|
-
* `truthmark init` - installa o aggiorna routing, scaffold dei documenti di verità e istruzioni per host IA.
|
|
85
|
+
* `truthmark init` - crea o aggiorna la configurazione, consente di scegliere zero o più piattaforme e installa routing, scaffold dei documenti di verità e istruzioni per gli host selezionati.
|
|
95
86
|
* `truthmark check` - valida la verità del repository dal terminale.
|
|
96
87
|
|
|
97
88
|
### Gli agenti seguono il contratto mentre scrivono codice
|
|
@@ -199,7 +190,7 @@ Per l’uso comando per comando, confronti tra superfici, dettagli sulle piattaf
|
|
|
199
190
|
|
|
200
191
|
La release attuale fornisce:
|
|
201
192
|
|
|
202
|
-
- comandi CLI locali per
|
|
193
|
+
- comandi CLI locali per init, check, index, impact e stato dei workflow
|
|
203
194
|
- istruzioni agente locali al repository generate per Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor
|
|
204
195
|
- diagnostica su routing, autorità, frontmatter, link, freschezza, superfici generate, ambito di branch e copertura
|
|
205
196
|
- documenti di verità con ambito di branch e artefatti derivati di intelligence del repository
|
|
@@ -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 ドキュメントと、派生したリポジトリインテリジェンス成果物
|