truthmark 2.2.3 → 2.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -681
- package/dist/main.js +303 -493
- package/dist/main.js.map +1 -1
- package/docs/README.md +119 -0
- package/docs/readmes/README.ar.md +225 -0
- package/docs/readmes/README.de.md +225 -0
- package/docs/readmes/README.el.md +225 -0
- package/docs/readmes/README.es.md +225 -0
- package/docs/readmes/README.fr.md +225 -0
- package/docs/readmes/README.id.md +225 -0
- package/docs/readmes/README.it.md +225 -0
- package/docs/readmes/README.ja.md +225 -0
- package/docs/readmes/README.ko.md +225 -0
- package/docs/readmes/README.pl.md +225 -0
- package/docs/readmes/README.pt.md +225 -0
- package/docs/readmes/README.ru.md +225 -0
- package/docs/readmes/README.tr.md +225 -0
- package/docs/readmes/README.vi.md +225 -0
- package/docs/readmes/README.zh.md +225 -0
- package/package.json +20 -3
- package/README.de.md +0 -823
- package/README.es.md +0 -823
- package/README.ru.md +0 -823
- package/README.zh.md +0 -823
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
# Truthmark
|
|
2
|
+
|
|
3
|
+
**Οι πράκτορές σας γράφουν κώδικα. Το Truthmark διατηρεί τεκμηρίωση προσανατολισμένη στον άνθρωπο και ελέγξιμη μέσω Git.**
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
|
|
6
|
+
|
|
7
|
+

|
|
8
|
+
|
|
9
|
+
## 🚀 Γρήγορη εκκίνηση: τοπική εκτέλεση σε πέντε λεπτά
|
|
10
|
+
|
|
11
|
+
Εκτελέστε το μέσα στο αποθετήριο Git που θέλετε να διαχειρίζεται το Truthmark:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
cd /path/to/your-repo
|
|
15
|
+
npm install -g truthmark
|
|
16
|
+
truthmark config
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Ενεργοποιήστε τον AI host που πραγματικά χρησιμοποιείτε. Οι νέες ρυθμίσεις είναι ουδέτερες ως προς τον host, οπότε προσθέστε μια λίστα `platforms` στο ανώτερο επίπεδο του `.truthmark/config.yml` πριν από την αρχικοποίηση:
|
|
20
|
+
|
|
21
|
+
```yaml
|
|
22
|
+
version: 2
|
|
23
|
+
platforms:
|
|
24
|
+
- codex # or: claude-code, github-copilot, opencode, antigravity, cursor
|
|
25
|
+
truthmark:
|
|
26
|
+
workspace: docs/truthmark
|
|
27
|
+
generated:
|
|
28
|
+
portal:
|
|
29
|
+
enabled: false
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Έπειτα εγκαταστήστε τοπικά τα έγγραφα αλήθειας του αποθετηρίου, τη δρομολόγηση και τις επιφάνειες ροής εργασίας πρακτόρων:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
truthmark init
|
|
36
|
+
truthmark check
|
|
37
|
+
git diff
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Τώρα δοκιμάστε την πιο συνηθισμένη διαδρομή υιοθέτησης: τεκμηριώστε μια υπάρχουσα συμπεριφορά από κώδικα και tests. Στον AI coding host σας, ζητήστε από την εγκατεστημένη ροή εργασίας:
|
|
41
|
+
|
|
42
|
+
```text
|
|
43
|
+
/truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Μετά από αυτό, οι χρήστες συνήθως δεν πρέπει να καλούν απευθείας το Truth Sync. Συνεχίστε να γράφετε κώδικα μέσω του AI host σας· οι εγκατεστημένες οδηγίες του αποθετηρίου λένε στον πράκτορα να εκτελεί τα σχετικά tests και να πραγματοποιεί την ανασκόπηση Truth Sync πριν από την παράδοση όταν αλλάζει λειτουργικός κώδικας. Εσείς ανασκοπείτε το προκύπτον code diff μαζί με το truth-doc diff.
|
|
47
|
+
|
|
48
|
+
Αν θέλετε μόνο επικύρωση CLI και δεν θέλετε ακόμη host-specific AI workflows, αφήστε το `platforms` εκτός και εκτελέστε `truthmark init && truthmark check`· μπορείτε να προσθέσετε πλατφόρμα αργότερα και να εκτελέσετε ξανά `truthmark init`.
|
|
49
|
+
|
|
50
|
+
## 💡 Το πρόβλημα: το κενό τεκμηρίωσης της AI
|
|
51
|
+
|
|
52
|
+
Οι AI coding agents είναι απίστευτοι στο να γράφουν κώδικα γρήγορα. Όμως αυτή η ταχύτητα δημιουργεί έναν επικίνδυνο νέο τρόπο αποτυχίας: **η ιστορία του αποθετηρίου απομακρύνεται από την πραγματικότητα.**
|
|
53
|
+
|
|
54
|
+
* Η συμπεριφορά χάνεται σε εφήμερα ιστορικά συνομιλιών.
|
|
55
|
+
* Τα έγγραφα αρχιτεκτονικής μένουν γρήγορα πίσω.
|
|
56
|
+
* Οι αποφάσεις προϊόντος εξαφανίζονται μετά την παράδοση.
|
|
57
|
+
* Οι reviewers κώδικα μένουν να εξετάζουν ωμά code diffs χωρίς να καταλαβαίνουν το «γιατί».
|
|
58
|
+
* Κάθε νέα AI session αναγκάζεται να ανακαλύψει ξανά την αλήθεια του αποθετηρίου σας από την αρχή.
|
|
59
|
+
|
|
60
|
+
## 🎯 Η λύση: Truthmark
|
|
61
|
+
|
|
62
|
+
Το **Truthmark** εγκαθιστά ένα Git-native επίπεδο ροής εργασίας μέσα στο αποθετήριό σας. Διορθώνει το μέρος της ανάπτυξης με AI που συνήθως σπάει: βοηθά την τεκμηρίωση να παραμένει ευθυγραμμισμένη με τον κώδικα.
|
|
63
|
+
|
|
64
|
+
Αντί να ελπίζετε ότι οι άνθρωποι και οι AI agents θα θυμηθούν να ενημερώσουν τα docs, το Truthmark κάνει την τεκμηρίωση μια συστηματική, ελέγξιμη συνήθεια ακριβώς μέσα στο repo σας.
|
|
65
|
+
|
|
66
|
+
### ✨ Γιατί το Truthmark είναι μοναδικό
|
|
67
|
+
|
|
68
|
+
Το Truthmark δεν είναι απλώς άλλο ένα εργαλείο τεκμηρίωσης. Είναι βαθιά ενσωματωμένο στη ροή εργασίας AI:
|
|
69
|
+
|
|
70
|
+
* **🚫 Μηδενικό κλείδωμα σε προμηθευτή:** Καμία hosted υπηρεσία, καμία κρυφή βάση δεδομένων, κανένας επιπλέον server προς λειτουργία.
|
|
71
|
+
* **🌳 100% Git-native:** Όλα ζουν στο αποθετήριό σας. Η αλήθεια κινείται μαζί με το branch σας.
|
|
72
|
+
* **🤝 Συμβόλαιο που ανήκει σε ανθρώπους και ακολουθείται από agents:** Οι συντηρητές κατέχουν το συμβόλαιο του αποθετηρίου· οι agents ακολουθούν τις εγκατεστημένες οδηγίες ενώ γράφουν κώδικα.
|
|
73
|
+
* **✅ Εμπιστοσύνη μέσω επαλήθευσης:** Η εργασία AI γίνεται ευκολότερο να εμπιστευτεί, επειδή η εργασία που αλλάζει συμπεριφορά περιλαμβάνει μια απόφαση ή ένα diff εγγράφου αλήθειας που μπορεί να ελεγχθεί από άνθρωπο.
|
|
74
|
+
|
|
75
|
+
## 🔄 Πώς λειτουργεί
|
|
76
|
+
|
|
77
|
+
Όταν ένας AI agent τροποποιεί τον κώδικά σας, η δουλειά δεν έχει τελειώσει. Το Truthmark εγκαθιστά έναν φραγμό ροής εργασίας στο τέλος, τον οποίο ακολουθούν οι πράκτορες πριν από την παράδοση:
|
|
78
|
+
|
|
79
|
+
1. 💻 **Κώδικας:** Ο πράκτορας τροποποιεί λειτουργικό κώδικα.
|
|
80
|
+
2. 🧪 **Test:** Εκτελούνται τα σχετικά tests.
|
|
81
|
+
3. 🔍 **Έλεγχος:** Το Truthmark ελέγχει τη χαρτογραφημένη τεκμηρίωση ως μέρος της εγκατεστημένης τελικής ανασκόπησης.
|
|
82
|
+
4. 📝 **Τεκμηρίωση:** Τα docs ενημερώνονται από τον πράκτορα όταν αλλάζει η αλήθεια του αποθετηρίου.
|
|
83
|
+
5. 👀 **Ανασκόπηση:** Ένας άνθρωπος ανασκοπεί το *code diff* + το *diff αλήθειας*.
|
|
84
|
+
|
|
85
|
+
## 🛠 Πώς αλληλεπιδράτε με το Truthmark
|
|
86
|
+
|
|
87
|
+
Το Truthmark έχει ένα repo-local συμβόλαιο και δύο τρόπους χρήσης του.
|
|
88
|
+
|
|
89
|
+
### Οι άνθρωποι εγκαθιστούν και επικυρώνουν το συμβόλαιο
|
|
90
|
+
|
|
91
|
+
Οι συντηρητές και το CI χρησιμοποιούν το CLI:
|
|
92
|
+
|
|
93
|
+
* `truthmark config` - δημιουργεί την αρχική διαμόρφωση.
|
|
94
|
+
* `truthmark init` - εγκαθιστά ή ανανεώνει routing, truth-doc scaffolds και οδηγίες για AI hosts.
|
|
95
|
+
* `truthmark check` - επικυρώνει την αλήθεια του αποθετηρίου από το τερματικό.
|
|
96
|
+
|
|
97
|
+
### Οι agents ακολουθούν το συμβόλαιο ενώ γράφουν κώδικα
|
|
98
|
+
|
|
99
|
+
Το Truthmark εγκαθιστά repo-local οδηγίες για υποστηριζόμενους AI coding hosts όπως Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity και Cursor.
|
|
100
|
+
|
|
101
|
+
Ο κανονικός κύκλος είναι απλός:
|
|
102
|
+
|
|
103
|
+
1. Ζητήστε από τον agent αλλαγή κώδικα ή τεκμηρίωση υπάρχουσας συμπεριφοράς.
|
|
104
|
+
2. Οι εγκατεστημένες οδηγίες λένε στον agent πότε να δοκιμάσει, πότε να ενημερώσει truth docs και πότε να σταματήσει για ανθρώπινη ανασκόπηση.
|
|
105
|
+
3. Εσείς ελέγχετε κανονικά Git diffs: κώδικα και τυχόν αλλαγές σε truth docs.
|
|
106
|
+
|
|
107
|
+
Τα user-started αιτήματα προς agents είναι σκόπιμα λίγα:
|
|
108
|
+
|
|
109
|
+
* `/truthmark-document` - τεκμηριώνει υπάρχουσα υλοποιημένη συμπεριφορά από κώδικα και tests.
|
|
110
|
+
* `/truthmark-realize` - υλοποιεί κώδικα από υπάρχοντα truth docs.
|
|
111
|
+
* `/truthmark-check` - ελέγχει την αλήθεια του αποθετηρίου.
|
|
112
|
+
|
|
113
|
+
Το Truth Sync δεν είναι ο συνηθισμένος τρόπος έναρξης εργασίας· είναι η τελική ανασκόπηση μετά από λειτουργικές αλλαγές κώδικα.
|
|
114
|
+
Το Truth Structure δεν είναι καθημερινή εντολή· επισκευάζει routing ή ownership μόνο όταν αυτό μπλοκάρει την εργασία.
|
|
115
|
+
|
|
116
|
+
## Τι παίρνετε
|
|
117
|
+
|
|
118
|
+
| Δυνατότητα | Τι κάνει |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| Git-native αλήθεια | Διατηρεί την αλήθεια του αποθετηρίου σε committed Markdown και config. |
|
|
121
|
+
| Τεκμηρίωση με scope branch | Η αλήθεια κινείται με το branch αντί να ζει σε ιδιωτική session. |
|
|
122
|
+
| Ανθρώπινο CLI | Δίνει στους συντηρητές εντολές setup, refresh, validation και inspection. |
|
|
123
|
+
| Εγκατεστημένη καθοδήγηση agent | Λέει στους coding agents πότε να τεκμηριώσουν, να δοκιμάσουν, να συγχρονίσουν truth, να κάνουν audit ή να σταματήσουν για review. |
|
|
124
|
+
| Ρητή δρομολόγηση | Αντιστοιχίζει περιοχές κώδικα σε κανονικά έγγραφα αλήθειας. |
|
|
125
|
+
| Ελέγξιμες παραδόσεις | Παράγει συνηθισμένα Git diffs τόσο για κώδικα όσο και για έγγραφα αλήθειας. |
|
|
126
|
+
| Local-first λειτουργία | Δεν απαιτεί hosted service, daemon, βάση δεδομένων ή MCP server. |
|
|
127
|
+
| Ασφαλέστερα όρια εγγραφής | Διαχωρίζει code-first, doc-first, read-only και doc-only workflows. |
|
|
128
|
+
| Επικύρωση | Αναφέρει ζητήματα routing, authority, frontmatter, links, generated surfaces, branch scope, freshness και coverage. |
|
|
129
|
+
| Προαιρετικό Portal | Δημιουργεί ένα committed στατικό HTML presentation site από έγγραφα αλήθειας Markdown όταν ενεργοποιηθεί και ζητηθεί ρητά. |
|
|
130
|
+
|
|
131
|
+
## Οπτική επισκόπηση
|
|
132
|
+
|
|
133
|
+

|
|
134
|
+
|
|
135
|
+
**Χαρακτηριστικά:** τι εγκαθιστά το Truthmark και πώς χωρίζεται η επιφάνεια ροής εργασίας.
|
|
136
|
+
|
|
137
|
+

|
|
138
|
+
|
|
139
|
+
**Θέση:** πού εντάσσεται το Truthmark σε σχέση με prompts, memory και spec workflows.
|
|
140
|
+
|
|
141
|
+

|
|
142
|
+
|
|
143
|
+
**Ροή συγχρονισμού:** πώς το Truth Sync κλείνει τις κανονικές αλλαγές κώδικα πριν από την παράδοση.
|
|
144
|
+
|
|
145
|
+
## Γιατί το υιοθετούν οι ομάδες
|
|
146
|
+
|
|
147
|
+
Το Truthmark είναι για ομάδες που ήδη γνωρίζουν ότι οι AI agents μπορούν να παράγουν κώδικα.
|
|
148
|
+
|
|
149
|
+
Το επόμενο πρόβλημα είναι η διακυβέρνηση.
|
|
150
|
+
|
|
151
|
+
Όχι διακυβέρνηση ως τελετουργία. Διακυβέρνηση ως μια απλή ερώτηση:
|
|
152
|
+
|
|
153
|
+
> Μετά από αυτή την AI-assisted αλλαγή, λέει ακόμη το αποθετήριο την αλήθεια;
|
|
154
|
+
|
|
155
|
+
Το Truthmark βοηθά τις ομάδες να απαντήσουν σε αυτό με committed files, ρητή δρομολόγηση και ελέγξιμα diffs.
|
|
156
|
+
|
|
157
|
+
Είναι χρήσιμο όταν χρειάζεστε:
|
|
158
|
+
|
|
159
|
+
- λιγότερη απόκλιση τεκμηρίωσης
|
|
160
|
+
- καλύτερες παραδόσεις
|
|
161
|
+
- αλήθεια προϊόντος ειδική ανά branch
|
|
162
|
+
- ανθεκτική τεκμηρίωση αρχιτεκτονικής και API
|
|
163
|
+
- ρητή ιδιοκτησία μεταξύ docs και code
|
|
164
|
+
- ασφαλέστερα όρια εγγραφής πρακτόρων
|
|
165
|
+
- ελέγξιμη τεκμηρίωση αντί για κρυφή μνήμη
|
|
166
|
+
- καθοδήγηση για agents που εξακολουθεί να λειτουργεί από committed αρχεία του repo
|
|
167
|
+
|
|
168
|
+
## Πού ταιριάζει το Truthmark
|
|
169
|
+
|
|
170
|
+
Το Truthmark δεν αντικαθιστά prompts, memory, specs, tests ή code review.
|
|
171
|
+
|
|
172
|
+
Δίνει σε αυτές τις ροές εργασίας ένα ανθεκτικό μέρος για να προσγειωθούν στο Git.
|
|
173
|
+
|
|
174
|
+
| Ανάγκη | Καλύτερη επιλογή |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| Καλύτερη έξοδος από μία session πράκτορα | Καλύτερο prompt |
|
|
177
|
+
| Προσωπική ή session-level συνέχεια | Εργαλείο μνήμης |
|
|
178
|
+
| Feature work με σχέδιο πρώτα | Spec workflow |
|
|
179
|
+
| Αλήθεια με scope branch που ταξιδεύει με τον κώδικα | Truthmark |
|
|
180
|
+
| Επικύρωση ορθότητας συμπεριφοράς | Tests και review |
|
|
181
|
+
| Ανασκόπηση AI-assisted αλλαγών τεκμηρίωσης | Truthmark μαζί με Git review |
|
|
182
|
+
|
|
183
|
+
Η λωρίδα του Truthmark είναι σκόπιμα στενή:
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
make repository truth explicit
|
|
187
|
+
route it to code
|
|
188
|
+
εγκατάσταση καθοδήγησης για agents γύρω από αυτή
|
|
189
|
+
keep the result reviewable in Git
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
## Πηγαίνετε βαθύτερα
|
|
193
|
+
|
|
194
|
+
Το README είναι η βιτρίνα: γρήγορο πλαίσιο, γρήγορη εκκίνηση και το βασικό νοητικό μοντέλο.
|
|
195
|
+
|
|
196
|
+
Για χρήση ανά εντολή, συγκρίσεις επιφανειών, λεπτομέρειες υποστηριζόμενων πλατφορμών, διαμόρφωση, δρομολόγηση, Portal και παραδείγματα, διαβάστε τον [Οδηγό χρήστη Truthmark](../user-guide.md).
|
|
197
|
+
|
|
198
|
+
## Κατάσταση έργου
|
|
199
|
+
|
|
200
|
+
Η τρέχουσα έκδοση παρέχει:
|
|
201
|
+
|
|
202
|
+
- τοπικές CLI commands για config, init, check, index, impact και workflow status
|
|
203
|
+
- παραγόμενες repo-local οδηγίες για agents για Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity και Cursor
|
|
204
|
+
- diagnostics για route, authority, frontmatter, link, freshness, generated-surface, branch-scope και coverage
|
|
205
|
+
- έγγραφα αλήθειας με scope branch και παράγωγα τεχνουργήματα ευφυΐας αποθετηρίου
|
|
206
|
+
|
|
207
|
+
## Τεκμηρίωση
|
|
208
|
+
|
|
209
|
+
- [Οδηγός χρήστη](../user-guide.md)
|
|
210
|
+
- [Ευρετήριο docs](../README.md)
|
|
211
|
+
- [Επισκόπηση αρχιτεκτονικής](../truthmark/engineering/architecture/overview.md)
|
|
212
|
+
- [Συμβάσεις API και CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
213
|
+
- [Οδηγός συντήρησης αλήθειας αποθετηρίου](../standards/maintaining-repository-truth.md)
|
|
214
|
+
|
|
215
|
+
Για εντολές τοπικής ανάπτυξης και συνεισφοράς, δείτε το [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
|
216
|
+
|
|
217
|
+
## Όρια σχεδιασμού
|
|
218
|
+
|
|
219
|
+
Το Truthmark είναι σκόπιμα μικρό: τοπικό, committed, με scope branch και ελέγξιμο.
|
|
220
|
+
|
|
221
|
+
Δεν είναι hosted service, MCP server, vector database, κρυφό memory layer, προϊόν επιβολής CI ή αυτόνομη μηχανή επανεγγραφής κώδικα. Βοηθά την αλήθεια του αποθετηρίου να παραμένει ορατή· δεν αντικαθιστά tests, code review ή ανθρώπινη κρίση.
|
|
222
|
+
|
|
223
|
+
## Άδεια
|
|
224
|
+
|
|
225
|
+
MIT. Δείτε [LICENSE](../../LICENSE).
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
# Truthmark
|
|
2
|
+
|
|
3
|
+
**Tus agentes escriben código. Truthmark mantiene documentación orientada a humanos y revisable en Git.**
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
|
|
6
|
+
|
|
7
|
+

|
|
8
|
+
|
|
9
|
+
## 🚀 Inicio rápido: ejecutarlo localmente en cinco minutos
|
|
10
|
+
|
|
11
|
+
Ejecuta esto dentro del repositorio Git que quieres que Truthmark gestione:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
cd /path/to/your-repo
|
|
15
|
+
npm install -g truthmark
|
|
16
|
+
truthmark config
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Activa el host de IA que realmente usas. Las configuraciones nuevas son neutrales respecto al host, así que añade una lista `platforms` de nivel superior a `.truthmark/config.yml` antes de la inicialización:
|
|
20
|
+
|
|
21
|
+
```yaml
|
|
22
|
+
version: 2
|
|
23
|
+
platforms:
|
|
24
|
+
- codex # or: claude-code, github-copilot, opencode, antigravity, cursor
|
|
25
|
+
truthmark:
|
|
26
|
+
workspace: docs/truthmark
|
|
27
|
+
generated:
|
|
28
|
+
portal:
|
|
29
|
+
enabled: false
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Después instala los documentos de verdad locales del repositorio, el enrutamiento y las instrucciones para hosts de IA:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
truthmark init
|
|
36
|
+
truthmark check
|
|
37
|
+
git diff
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
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
|
+
|
|
42
|
+
```text
|
|
43
|
+
/truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
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
|
+
|
|
48
|
+
Si solo quieres validación por CLI y todavía no quieres workflows de IA específicos de un host, deja `platforms` omitido y ejecuta `truthmark init && truthmark check`; puedes añadir una plataforma más tarde y volver a ejecutar `truthmark init`.
|
|
49
|
+
|
|
50
|
+
## 💡 El problema: la brecha de documentación de la IA
|
|
51
|
+
|
|
52
|
+
Los agentes de codificación con IA son increíbles escribiendo código rápidamente. Pero esa velocidad crea un nuevo modo de fallo peligroso: **la historia del repositorio se desvía de la realidad.**
|
|
53
|
+
|
|
54
|
+
* El comportamiento se pierde en historiales de chat efímeros.
|
|
55
|
+
* Los documentos de arquitectura se quedan atrás rápidamente.
|
|
56
|
+
* Las decisiones de producto desaparecen después de la entrega.
|
|
57
|
+
* Los revisores de código acaban examinando diffs de código sin procesar, sin entender el «por qué».
|
|
58
|
+
* Cada nueva sesión de IA se ve obligada a redescubrir desde cero la verdad de tu repositorio.
|
|
59
|
+
|
|
60
|
+
## 🎯 La solución: Truthmark
|
|
61
|
+
|
|
62
|
+
**Truthmark** instala en tu repositorio una capa de workflow nativa de Git. Arregla la parte del desarrollo con IA que normalmente se rompe: ayudar a que la documentación permanezca alineada con el código.
|
|
63
|
+
|
|
64
|
+
En lugar de esperar que humanos y agentes de IA recuerden actualizar la documentación, Truthmark convierte la documentación en un hábito sistemático y revisable dentro de tu propio repositorio.
|
|
65
|
+
|
|
66
|
+
### ✨ Por qué Truthmark es único
|
|
67
|
+
|
|
68
|
+
Truthmark no es simplemente otra herramienta de documentación. Está profundamente integrado en el workflow de IA:
|
|
69
|
+
|
|
70
|
+
* **🚫 Sin dependencia de proveedor:** no hay servicios alojados, bases de datos ocultas ni servidores adicionales que operar.
|
|
71
|
+
* **🌳 100 % nativo de Git:** todo vive en tu repositorio. La verdad se mueve con tu rama.
|
|
72
|
+
* **🤝 Contrato propiedad de humanos y seguido por agentes:** Los mantenedores poseen el contrato del repositorio; los agentes siguen las instrucciones instaladas mientras programan.
|
|
73
|
+
* **✅ Confianza mediante verificación:** el trabajo de la IA resulta más fácil de confiar porque el trabajo que cambia comportamiento incluye una decisión o un diff de documento de verdad revisable por humanos.
|
|
74
|
+
|
|
75
|
+
## 🔄 Cómo funciona
|
|
76
|
+
|
|
77
|
+
Cuando un agente de IA modifica tu código, el trabajo no ha terminado. Truthmark instala una protección de workflow al final de la tarea que los agentes siguen antes de la entrega:
|
|
78
|
+
|
|
79
|
+
1. 💻 **Código:** el agente modifica código funcional.
|
|
80
|
+
2. 🧪 **Prueba:** se ejecutan las pruebas pertinentes.
|
|
81
|
+
3. 🔍 **Comprobación:** Truthmark revisa la documentación mapeada como parte de la revisión de cierre instalada.
|
|
82
|
+
4. 📝 **Documentación:** el agente actualiza los docs cuando la verdad del repositorio ha cambiado.
|
|
83
|
+
5. 👀 **Revisión:** una persona revisa el *diff de código* + el *diff de verdad*.
|
|
84
|
+
|
|
85
|
+
## 🛠 Cómo interactúas con Truthmark
|
|
86
|
+
|
|
87
|
+
Truthmark tiene un contrato local del repositorio y dos formas de usarlo.
|
|
88
|
+
|
|
89
|
+
### Las personas instalan y validan el contrato
|
|
90
|
+
|
|
91
|
+
Los mantenedores y CI usan la CLI:
|
|
92
|
+
|
|
93
|
+
* `truthmark config` - crea la configuración inicial.
|
|
94
|
+
* `truthmark init` - instala o actualiza el enrutamiento, los andamios de documentos de verdad y las instrucciones para hosts de IA.
|
|
95
|
+
* `truthmark check` - valida la verdad del repositorio desde la terminal.
|
|
96
|
+
|
|
97
|
+
### Los agentes siguen el contrato mientras programan
|
|
98
|
+
|
|
99
|
+
Truthmark instala instrucciones locales del repositorio para hosts de codificación con IA compatibles, como Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity y Cursor.
|
|
100
|
+
|
|
101
|
+
El ciclo normal es simple:
|
|
102
|
+
|
|
103
|
+
1. Pide a tu agente un cambio de código o que documente un comportamiento existente.
|
|
104
|
+
2. Las instrucciones instaladas le dicen al agente cuándo probar, cuándo actualizar documentos de verdad y cuándo detenerse para revisión humana.
|
|
105
|
+
3. Revisas diffs Git normales: código más cualquier cambio en documentos de verdad.
|
|
106
|
+
|
|
107
|
+
Las solicitudes de agente iniciadas por el usuario son deliberadamente pocas:
|
|
108
|
+
|
|
109
|
+
* `/truthmark-document` - documenta comportamiento implementado existente a partir de código y tests.
|
|
110
|
+
* `/truthmark-realize` - implementa código a partir de documentos de verdad existentes.
|
|
111
|
+
* `/truthmark-check` - audita la verdad del repositorio.
|
|
112
|
+
|
|
113
|
+
Truth Sync no es la forma habitual de iniciar trabajo; es la revisión de cierre después de cambios funcionales de código.
|
|
114
|
+
Truth Structure no es un comando cotidiano; repara enrutamiento o propiedad solo cuando eso bloquea el trabajo.
|
|
115
|
+
|
|
116
|
+
## Lo que obtienes
|
|
117
|
+
|
|
118
|
+
| Capacidad | Qué hace |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| Verdad nativa de Git | Mantiene la verdad del repositorio en Markdown y configuración versionados. |
|
|
121
|
+
| Documentación con alcance de rama | La verdad se mueve con la rama en lugar de vivir en una sesión privada. |
|
|
122
|
+
| CLI humana | Da a los mantenedores comandos de configuración, actualización, validación e inspección. |
|
|
123
|
+
| Guía de agente instalada | Indica a los agentes de codificación cuándo documentar, probar, sincronizar verdad, auditar o detenerse para revisión. |
|
|
124
|
+
| Enrutamiento explícito | Mapea áreas de código a documentos de verdad canónicos. |
|
|
125
|
+
| Entregas revisables | Produce diffs Git ordinarios tanto para el código como para los documentos de verdad. |
|
|
126
|
+
| Operación local-first | No requiere servicio alojado, demonio, base de datos ni servidor MCP. |
|
|
127
|
+
| Límites de escritura más seguros | Separa workflows code-first, doc-first, read-only y doc-only. |
|
|
128
|
+
| Validación | Informa problemas de enrutamiento, autoridad, frontmatter, enlaces, superficies generadas, alcance de rama, frescura y cobertura. |
|
|
129
|
+
| Portal opcional | Genera, cuando se activa y solicita explícitamente, un sitio estático HTML versionado a partir de documentos de verdad Markdown. |
|
|
130
|
+
|
|
131
|
+
## Panorama visual
|
|
132
|
+
|
|
133
|
+

|
|
134
|
+
|
|
135
|
+
**Funciones:** lo que instala Truthmark y cómo se divide la superficie de workflow.
|
|
136
|
+
|
|
137
|
+

|
|
138
|
+
|
|
139
|
+
**Posición:** dónde encaja Truthmark en relación con prompts, memoria y workflows de especificación.
|
|
140
|
+
|
|
141
|
+

|
|
142
|
+
|
|
143
|
+
**Flujo de sincronización:** cómo Truth Sync cierra los cambios de código normales antes de la entrega.
|
|
144
|
+
|
|
145
|
+
## Por qué los equipos lo adoptan
|
|
146
|
+
|
|
147
|
+
Truthmark es para equipos que ya saben que los agentes de IA pueden generar código.
|
|
148
|
+
|
|
149
|
+
El siguiente problema es la gobernanza.
|
|
150
|
+
|
|
151
|
+
No la gobernanza como ceremonia. Gobernanza como una pregunta sencilla:
|
|
152
|
+
|
|
153
|
+
> Después de este cambio asistido por IA, ¿el repositorio sigue diciendo la verdad?
|
|
154
|
+
|
|
155
|
+
Truthmark ayuda a los equipos a responder con archivos versionados, enrutamiento explícito y diffs revisables.
|
|
156
|
+
|
|
157
|
+
Es útil cuando necesitas:
|
|
158
|
+
|
|
159
|
+
- menos deriva de documentación
|
|
160
|
+
- mejores entregas
|
|
161
|
+
- verdad de producto específica de la rama
|
|
162
|
+
- documentación duradera de arquitectura y API
|
|
163
|
+
- propiedad explícita entre docs y código
|
|
164
|
+
- límites de escritura de agentes más seguros
|
|
165
|
+
- documentación revisable en lugar de memoria oculta
|
|
166
|
+
- guía de agente que sigue funcionando desde archivos versionados del repositorio
|
|
167
|
+
|
|
168
|
+
## Dónde encaja Truthmark
|
|
169
|
+
|
|
170
|
+
Truthmark no reemplaza prompts, memoria, especificaciones, pruebas ni revisión de código.
|
|
171
|
+
|
|
172
|
+
Les da a esos workflows un lugar duradero donde aterrizar en Git.
|
|
173
|
+
|
|
174
|
+
| Necesidad | Mejor opción |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| Mejor salida de una sesión de agente | Mejor prompt |
|
|
177
|
+
| Continuidad personal o a nivel de sesión | Herramienta de memoria |
|
|
178
|
+
| Trabajo de funcionalidad con plan primero | Workflow de especificación |
|
|
179
|
+
| Verdad con alcance de rama que viaja con el código | Truthmark |
|
|
180
|
+
| Validar la corrección del comportamiento | Pruebas y revisión |
|
|
181
|
+
| Revisar cambios de documentación asistidos por IA | Truthmark más revisión Git |
|
|
182
|
+
|
|
183
|
+
El carril de Truthmark es estrecho por diseño:
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
make repository truth explicit
|
|
187
|
+
route it to code
|
|
188
|
+
instalar guía de agente alrededor de ella
|
|
189
|
+
keep the result reviewable in Git
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
## Profundizar
|
|
193
|
+
|
|
194
|
+
El README es el escaparate: contexto rápido, inicio rápido y el modelo mental central.
|
|
195
|
+
|
|
196
|
+
Para uso comando por comando, comparaciones de superficies, detalles de plataformas compatibles, configuración, enrutamiento, Portal y ejemplos, lee la [guía de usuario de Truthmark](../user-guide.md).
|
|
197
|
+
|
|
198
|
+
## Estado del proyecto
|
|
199
|
+
|
|
200
|
+
La versión actual proporciona:
|
|
201
|
+
|
|
202
|
+
- comandos CLI locales para config, init, check, index, impact y estado de workflows
|
|
203
|
+
- instrucciones de agente locales del repositorio generadas para Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity y Cursor
|
|
204
|
+
- diagnósticos de enrutamiento, autoridad, frontmatter, enlaces, frescura, superficies generadas, alcance de rama y cobertura
|
|
205
|
+
- documentos de verdad con alcance de rama y artefactos derivados de inteligencia del repositorio
|
|
206
|
+
|
|
207
|
+
## Documentación
|
|
208
|
+
|
|
209
|
+
- [Guía de usuario](../user-guide.md)
|
|
210
|
+
- [Índice de docs](../README.md)
|
|
211
|
+
- [Vista general de arquitectura](../truthmark/engineering/architecture/overview.md)
|
|
212
|
+
- [Contratos de API y CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
213
|
+
- [Guía de mantenimiento de la verdad del repositorio](../standards/maintaining-repository-truth.md)
|
|
214
|
+
|
|
215
|
+
Para comandos de desarrollo local y contribución, consulta [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
|
216
|
+
|
|
217
|
+
## Límites de diseño
|
|
218
|
+
|
|
219
|
+
Truthmark es intencionadamente pequeño: local, versionado, con alcance de rama y revisable.
|
|
220
|
+
|
|
221
|
+
No es un servicio alojado, servidor MCP, base de datos vectorial, capa de memoria oculta, producto de aplicación de CI ni motor autónomo de reescritura de código. Ayuda a que la verdad del repositorio permanezca visible; no reemplaza pruebas, revisión de código ni juicio humano.
|
|
222
|
+
|
|
223
|
+
## Licencia
|
|
224
|
+
|
|
225
|
+
MIT. Consulta [LICENSE](../../LICENSE).
|