truthmark 2.2.2 → 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 -682
- package/dist/main.js +524 -754
- 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 -824
- package/README.es.md +0 -824
- package/README.ru.md +0 -824
- package/README.zh.md +0 -824
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
# Truthmark
|
|
2
|
+
|
|
3
|
+
**Twoi agenci piszą kod. Truthmark utrzymuje dokumentację dla ludzi, możliwą do przeglądu w 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
|
+
## 🚀 Szybki start: lokalne uruchomienie w pięć minut
|
|
10
|
+
|
|
11
|
+
Uruchom to w repozytorium Git, którym ma zarządzać Truthmark:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
cd /path/to/your-repo
|
|
15
|
+
npm install -g truthmark
|
|
16
|
+
truthmark config
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Włącz hosta AI, którego faktycznie używasz. Nowe konfiguracje są neutralne wobec hosta, więc przed inicjalizacją dodaj listę najwyższego poziomu `platforms` do `.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
|
+
Następnie zainstaluj lokalne dla repozytorium dokumenty truth, routing i powierzchnie workflow agentów:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
truthmark init
|
|
36
|
+
truthmark check
|
|
37
|
+
git diff
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
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
|
+
|
|
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
|
+
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
|
+
|
|
48
|
+
Jeśli chcesz tylko walidacji CLI i nie potrzebujesz jeszcze workflow AI specyficznych dla hosta, pozostaw `platforms` pominięte i uruchom `truthmark init && truthmark check`; później możesz dodać platformę i ponownie uruchomić `truthmark init`.
|
|
49
|
+
|
|
50
|
+
## 💡 Problem: luka w dokumentacji AI
|
|
51
|
+
|
|
52
|
+
Agenci kodujący AI są niezwykle dobrzy w szybkim pisaniu kodu. Ta prędkość tworzy jednak groźny nowy tryb awarii: **historia repozytorium zaczyna rozmijać się z rzeczywistością.**
|
|
53
|
+
|
|
54
|
+
* Zachowanie ginie w ulotnych historiach czatu.
|
|
55
|
+
* Dokumenty architektoniczne szybko zostają w tyle.
|
|
56
|
+
* Decyzje produktowe znikają po przekazaniu pracy.
|
|
57
|
+
* Recenzenci kodu oglądają surowe diffy kodu bez zrozumienia „dlaczego”.
|
|
58
|
+
* Każda nowa sesja AI musi od zera odkrywać truth repozytorium.
|
|
59
|
+
|
|
60
|
+
## 🎯 Rozwiązanie: Truthmark
|
|
61
|
+
|
|
62
|
+
**Truthmark** instaluje w Twoim repozytorium warstwę workflow natywną dla Git. Naprawia tę część rozwoju z AI, która zwykle się psuje: pomaga utrzymać dokumentację w zgodzie z kodem.
|
|
63
|
+
|
|
64
|
+
Zamiast liczyć, że ludzie i agenci AI będą pamiętać o aktualizowaniu dokumentów, Truthmark zamienia dokumentację w systematyczny, możliwy do przeglądu nawyk wewnątrz repozytorium.
|
|
65
|
+
|
|
66
|
+
### ✨ Dlaczego Truthmark jest wyjątkowy
|
|
67
|
+
|
|
68
|
+
Truthmark nie jest tylko kolejnym narzędziem do dokumentacji. Jest głęboko zintegrowany z workflow AI:
|
|
69
|
+
|
|
70
|
+
* **🚫 Zero zależności od dostawcy:** brak usług hostowanych, ukrytych baz danych i dodatkowych serwerów do utrzymywania.
|
|
71
|
+
* **🌳 100% natywny dla Git:** wszystko mieszka w Twoim repozytorium. Truth porusza się razem z gałęzią.
|
|
72
|
+
* **🤝 Kontrakt należący do ludzi i wykonywany przez agentów:** Opiekunowie posiadają kontrakt repozytorium; agenci podczas kodowania podążają za zainstalowanymi instrukcjami.
|
|
73
|
+
* **✅ Zaufanie przez weryfikację:** pracy AI łatwiej zaufać, ponieważ zmiany wpływające na zachowanie zawierają decyzję lub diff truth-doc możliwy do przeglądu przez człowieka.
|
|
74
|
+
|
|
75
|
+
## 🔄 Jak to działa
|
|
76
|
+
|
|
77
|
+
Gdy agent AI modyfikuje Twój kod, praca nie jest skończona. Truthmark instaluje strażnika workflow na zakończenie pracy, którego agenci przestrzegają przed przekazaniem:
|
|
78
|
+
|
|
79
|
+
1. 💻 **Kod:** agent modyfikuje kod funkcjonalny.
|
|
80
|
+
2. 🧪 **Test:** wykonywane są odpowiednie testy.
|
|
81
|
+
3. 🔍 **Sprawdzenie:** Truthmark sprawdza zmapowaną dokumentację jako część zainstalowanego końcowego przeglądu.
|
|
82
|
+
4. 📝 **Dokumentacja:** agent aktualizuje dokumenty, gdy truth repozytorium się zmieniła.
|
|
83
|
+
5. 👀 **Przegląd:** człowiek przegląda *diff kodu* + *diff truth*.
|
|
84
|
+
|
|
85
|
+
## 🛠 Jak używasz Truthmark
|
|
86
|
+
|
|
87
|
+
Truthmark ma jeden lokalny kontrakt repozytorium i dwa sposoby korzystania z niego.
|
|
88
|
+
|
|
89
|
+
### Ludzie instalują i walidują kontrakt
|
|
90
|
+
|
|
91
|
+
Opiekunowie i CI używają CLI:
|
|
92
|
+
|
|
93
|
+
* `truthmark config` - tworzy początkową konfigurację.
|
|
94
|
+
* `truthmark init` - instaluje lub odświeża routing, szkielety truth-doc i instrukcje dla hostów AI.
|
|
95
|
+
* `truthmark check` - waliduje truth repozytorium z terminala.
|
|
96
|
+
|
|
97
|
+
### Agenci podążają za kontraktem podczas kodowania
|
|
98
|
+
|
|
99
|
+
Truthmark instaluje lokalne instrukcje repozytorium dla obsługiwanych hostów kodowania AI, takich jak Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity i Cursor.
|
|
100
|
+
|
|
101
|
+
Normalna pętla jest prosta:
|
|
102
|
+
|
|
103
|
+
1. Poproś agenta o zmianę kodu albo o udokumentowanie istniejącego zachowania.
|
|
104
|
+
2. Zainstalowane instrukcje mówią agentowi, kiedy testować, kiedy aktualizować truth docs i kiedy zatrzymać się do ludzkiego przeglądu.
|
|
105
|
+
3. Przeglądasz zwykłe diffy Git: kod plus ewentualne zmiany w truth-doc.
|
|
106
|
+
|
|
107
|
+
Żądania agenta uruchamiane przez użytkownika są celowo nieliczne:
|
|
108
|
+
|
|
109
|
+
* `/truthmark-document` - dokumentuje istniejące zaimplementowane zachowanie z kodu i testów.
|
|
110
|
+
* `/truthmark-realize` - implementuje kod z istniejących truth docs.
|
|
111
|
+
* `/truthmark-check` - audytuje truth repozytorium.
|
|
112
|
+
|
|
113
|
+
Truth Sync nie jest zwykłym sposobem rozpoczynania pracy; to końcowy przegląd po funkcjonalnych zmianach kodu.
|
|
114
|
+
Truth Structure nie jest codzienną komendą; naprawia routing lub własność tylko wtedy, gdy blokuje to pracę.
|
|
115
|
+
|
|
116
|
+
## Co otrzymujesz
|
|
117
|
+
|
|
118
|
+
| Możliwość | Co robi |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| Truth natywny dla Git | Utrzymuje truth repozytorium w zatwierdzonych plikach Markdown i konfiguracji. |
|
|
121
|
+
| Dokumentacja w zakresie gałęzi | Truth porusza się z gałęzią zamiast mieszkać w prywatnej sesji. |
|
|
122
|
+
| CLI dla ludzi | Daje opiekunom komendy konfiguracji, odświeżania, walidacji i inspekcji. |
|
|
123
|
+
| Zainstalowana instrukcja agenta | Mówi agentom kodującym, kiedy dokumentować, testować, synchronizować truth, audytować lub zatrzymać się do przeglądu. |
|
|
124
|
+
| Jawny routing | Mapuje obszary kodu na kanoniczne dokumenty truth. |
|
|
125
|
+
| Przekazania możliwe do przeglądu | Tworzy zwykłe diffy Git zarówno dla kodu, jak i dokumentów truth. |
|
|
126
|
+
| Działanie local-first | Nie wymaga hostowanej usługi, demona, bazy danych ani serwera MCP. |
|
|
127
|
+
| Bezpieczniejsze granice zapisu | Rozdziela workflow code-first, doc-first, read-only i doc-only. |
|
|
128
|
+
| Walidacja | Raportuje problemy z routingiem, uprawnieniami, frontmatter, linkami, wygenerowaną powierzchnią, zakresem gałęzi, świeżością i pokryciem. |
|
|
129
|
+
| Opcjonalny Portal | Generuje zatwierdzoną statyczną witrynę prezentacyjną HTML z dokumentów truth w Markdown, gdy jest wyraźnie włączony i zażądany. |
|
|
130
|
+
|
|
131
|
+
## Przegląd wizualny
|
|
132
|
+
|
|
133
|
+

|
|
134
|
+
|
|
135
|
+
**Funkcje:** co Truthmark instaluje i jak podzielona jest powierzchnia workflow.
|
|
136
|
+
|
|
137
|
+

|
|
138
|
+
|
|
139
|
+
**Pozycja:** gdzie Truthmark mieści się względem promptów, pamięci i workflow specyfikacji.
|
|
140
|
+
|
|
141
|
+

|
|
142
|
+
|
|
143
|
+
**Przepływ synchronizacji:** jak Truth Sync zamyka zwykłe zmiany kodu przed przekazaniem.
|
|
144
|
+
|
|
145
|
+
## Dlaczego zespoły go przyjmują
|
|
146
|
+
|
|
147
|
+
Truthmark jest dla zespołów, które już wiedzą, że agenci AI potrafią generować kod.
|
|
148
|
+
|
|
149
|
+
Następnym problemem jest governance.
|
|
150
|
+
|
|
151
|
+
Nie governance jako ceremonia. Governance jako proste pytanie:
|
|
152
|
+
|
|
153
|
+
> Czy po tej zmianie wspieranej przez AI repozytorium nadal mówi truth?
|
|
154
|
+
|
|
155
|
+
Truthmark pomaga zespołom odpowiedzieć na to pytanie za pomocą zatwierdzonych plików, jawnego routingu i diffów możliwych do przeglądu.
|
|
156
|
+
|
|
157
|
+
Jest przydatny, gdy potrzebujesz:
|
|
158
|
+
|
|
159
|
+
- mniejszego rozjazdu dokumentacji
|
|
160
|
+
- lepszych przekazań pracy
|
|
161
|
+
- truth produktu specyficznego dla gałęzi
|
|
162
|
+
- trwałej dokumentacji architektury i API
|
|
163
|
+
- jawnej własności między dokumentami a kodem
|
|
164
|
+
- bezpieczniejszych granic zapisu dla agentów
|
|
165
|
+
- dokumentacji możliwej do przeglądu zamiast ukrytej pamięci
|
|
166
|
+
- instrukcje agenta, które nadal działają z commitowanych plików repozytorium
|
|
167
|
+
|
|
168
|
+
## Gdzie pasuje Truthmark
|
|
169
|
+
|
|
170
|
+
Truthmark nie zastępuje promptów, pamięci, specyfikacji, testów ani przeglądu kodu.
|
|
171
|
+
|
|
172
|
+
Daje tym workflow trwałe miejsce w Git.
|
|
173
|
+
|
|
174
|
+
| Potrzeba | Lepsze dopasowanie |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| Lepszy wynik z jednej sesji agenta | Lepszy prompt |
|
|
177
|
+
| Ciągłość osobista lub na poziomie sesji | Narzędzie pamięci |
|
|
178
|
+
| Praca nad funkcją zaczynająca się od planu | Workflow specyfikacji |
|
|
179
|
+
| Truth w zakresie gałęzi, która podróżuje z kodem | Truthmark |
|
|
180
|
+
| Walidacja poprawności zachowania | Testy i przegląd |
|
|
181
|
+
| Przegląd zmian dokumentacji wspieranych przez AI | Truthmark plus przegląd Git |
|
|
182
|
+
|
|
183
|
+
Zakres Truthmark jest celowo wąski:
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
make repository truth explicit
|
|
187
|
+
route it to code
|
|
188
|
+
zainstalować wokół niej instrukcje agenta
|
|
189
|
+
keep the result reviewable in Git
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
## Więcej szczegółów
|
|
193
|
+
|
|
194
|
+
README jest witryną sklepową: szybki kontekst, szybki start i podstawowy model myślowy.
|
|
195
|
+
|
|
196
|
+
Aby poznać użycie komenda po komendzie, porównanie powierzchni, szczegóły obsługiwanych platform, konfigurację, routing, Portal i przykłady, przeczytaj [Przewodnik użytkownika Truthmark](../user-guide.md).
|
|
197
|
+
|
|
198
|
+
## Status projektu
|
|
199
|
+
|
|
200
|
+
Obecne wydanie zapewnia:
|
|
201
|
+
|
|
202
|
+
- lokalne komendy CLI dla config, init, check, index, impact i workflow status
|
|
203
|
+
- wygenerowane lokalne instrukcje agenta dla Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity i Cursor
|
|
204
|
+
- diagnostykę route, authority, frontmatter, link, freshness, generated-surface, branch-scope i coverage
|
|
205
|
+
- dokumenty truth w zakresie gałęzi oraz pochodne artefakty inteligencji repozytorium
|
|
206
|
+
|
|
207
|
+
## Dokumentacja
|
|
208
|
+
|
|
209
|
+
- [Przewodnik użytkownika](../user-guide.md)
|
|
210
|
+
- [Indeks dokumentacji](../README.md)
|
|
211
|
+
- [Przegląd architektury](../truthmark/engineering/architecture/overview.md)
|
|
212
|
+
- [Kontrakty API i CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
213
|
+
- [Przewodnik utrzymania repository truth](../standards/maintaining-repository-truth.md)
|
|
214
|
+
|
|
215
|
+
Komendy lokalnego rozwoju i kontrybuowania znajdziesz w [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
|
216
|
+
|
|
217
|
+
## Granice projektu
|
|
218
|
+
|
|
219
|
+
Truthmark jest celowo mały: lokalny, zatwierdzony, ograniczony do gałęzi i możliwy do przeglądu.
|
|
220
|
+
|
|
221
|
+
Nie jest usługą hostowaną, serwerem MCP, wektorową bazą danych, ukrytą warstwą pamięci, produktem wymuszającym CI ani autonomicznym silnikiem przepisywania kodu. Pomaga utrzymać widoczność truth repozytorium; nie zastępuje testów, przeglądu kodu ani ludzkiego osądu.
|
|
222
|
+
|
|
223
|
+
## Licencja
|
|
224
|
+
|
|
225
|
+
MIT. Zobacz [LICENSE](../../LICENSE).
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
# Truthmark
|
|
2
|
+
|
|
3
|
+
**Seus agentes escrevem código. O Truthmark mantém documentação voltada para humanos e revisável no 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
|
+
## 🚀 Início rápido: rodando localmente em cinco minutos
|
|
10
|
+
|
|
11
|
+
Execute isto dentro do repositório Git que você quer que o Truthmark gerencie:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
cd /path/to/your-repo
|
|
15
|
+
npm install -g truthmark
|
|
16
|
+
truthmark config
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Ative o host de IA que você realmente usa. Configurações novas são neutras em relação a host; portanto, adicione uma lista `platforms` de nível superior a `.truthmark/config.yml` antes da inicialização:
|
|
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
|
+
Em seguida, instale os documentos de verdade locais do repositório, o roteamento e as instruções para hosts de IA:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
truthmark init
|
|
36
|
+
truthmark check
|
|
37
|
+
git diff
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
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
|
+
|
|
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
|
+
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
|
+
|
|
48
|
+
Se você quer apenas validação por CLI e ainda não quer workflows de IA específicos de host, deixe `platforms` omitido e execute `truthmark init && truthmark check`; você pode adicionar uma plataforma depois e executar `truthmark init` novamente.
|
|
49
|
+
|
|
50
|
+
## 💡 O problema: a lacuna de documentação da IA
|
|
51
|
+
|
|
52
|
+
Agentes de codificação com IA são incríveis para escrever código rapidamente. Mas essa velocidade cria um novo modo de falha perigoso: **a história do repositório se afasta da realidade.**
|
|
53
|
+
|
|
54
|
+
* Comportamentos se perdem em históricos de chat efêmeros.
|
|
55
|
+
* Documentos de arquitetura ficam desatualizados rapidamente.
|
|
56
|
+
* Decisões de produto desaparecem após a entrega.
|
|
57
|
+
* Revisores de código acabam examinando diffs de código crus sem entender o “porquê”.
|
|
58
|
+
* Cada nova sessão de IA é forçada a redescobrir do zero a verdade do seu repositório.
|
|
59
|
+
|
|
60
|
+
## 🎯 A solução: Truthmark
|
|
61
|
+
|
|
62
|
+
**Truthmark** instala no seu repositório uma camada de workflow nativa do Git. Ele corrige a parte do desenvolvimento com IA que geralmente quebra: ajudar a documentação a permanecer alinhada com o código.
|
|
63
|
+
|
|
64
|
+
Em vez de esperar que humanos e agentes de IA se lembrem de atualizar a documentação, o Truthmark transforma a documentação em um hábito sistemático e revisável dentro do próprio repositório.
|
|
65
|
+
|
|
66
|
+
### ✨ Por que o Truthmark é único
|
|
67
|
+
|
|
68
|
+
Truthmark não é apenas mais uma ferramenta de documentação. Ele é profundamente integrado ao workflow de IA:
|
|
69
|
+
|
|
70
|
+
* **🚫 Sem dependência de fornecedor:** nenhum serviço hospedado, nenhum banco de dados oculto, nenhum servidor extra para operar.
|
|
71
|
+
* **🌳 100% nativo do Git:** tudo vive no seu repositório. A verdade se move com a sua branch.
|
|
72
|
+
* **🤝 Contrato pertencente a humanos e seguido por agentes:** Mantenedores possuem o contrato do repositório; agentes seguem as instruções instaladas enquanto programam.
|
|
73
|
+
* **✅ Confiança por verificação:** o trabalho da IA fica mais fácil de confiar porque trabalhos que mudam comportamento incluem uma decisão ou diff de documento de verdade revisável por humanos.
|
|
74
|
+
|
|
75
|
+
## 🔄 Como funciona
|
|
76
|
+
|
|
77
|
+
Quando um agente de IA modifica seu código, o trabalho não está terminado. O Truthmark instala uma proteção de workflow no fim da tarefa que os agentes seguem antes da entrega:
|
|
78
|
+
|
|
79
|
+
1. 💻 **Código:** o agente modifica código funcional.
|
|
80
|
+
2. 🧪 **Teste:** testes relevantes são executados.
|
|
81
|
+
3. 🔍 **Verificar:** Truthmark verifica a documentação mapeada como parte da revisão de encerramento instalada.
|
|
82
|
+
4. 📝 **Documentação:** os docs são atualizados pelo agente quando a verdade do repositório mudou.
|
|
83
|
+
5. 👀 **Revisão:** uma pessoa revisa o *diff de código* + o *diff de verdade*.
|
|
84
|
+
|
|
85
|
+
## 🛠 Como você interage com o Truthmark
|
|
86
|
+
|
|
87
|
+
Truthmark tem um contrato local do repositório e duas formas de usá-lo.
|
|
88
|
+
|
|
89
|
+
### Pessoas instalam e validam o contrato
|
|
90
|
+
|
|
91
|
+
Mantenedores e CI usam a CLI:
|
|
92
|
+
|
|
93
|
+
* `truthmark config` - cria a configuração inicial.
|
|
94
|
+
* `truthmark init` - instala ou atualiza roteamento, scaffolds de documentos de verdade e instruções para hosts de IA.
|
|
95
|
+
* `truthmark check` - valida a verdade do repositório pelo terminal.
|
|
96
|
+
|
|
97
|
+
### Agentes seguem o contrato enquanto programam
|
|
98
|
+
|
|
99
|
+
Truthmark instala instruções locais do repositório para hosts de codificação com IA compatíveis, como Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor.
|
|
100
|
+
|
|
101
|
+
O ciclo normal é simples:
|
|
102
|
+
|
|
103
|
+
1. Peça ao seu agente uma mudança de código ou que documente um comportamento existente.
|
|
104
|
+
2. As instruções instaladas dizem ao agente quando testar, quando atualizar documentos de verdade e quando parar para revisão humana.
|
|
105
|
+
3. Você revisa diffs Git comuns: código mais quaisquer mudanças em documentos de verdade.
|
|
106
|
+
|
|
107
|
+
As solicitações de agente iniciadas pelo usuário são intencionalmente poucas:
|
|
108
|
+
|
|
109
|
+
* `/truthmark-document` - documenta comportamento implementado existente a partir de código e testes.
|
|
110
|
+
* `/truthmark-realize` - implementa código a partir de documentos de verdade existentes.
|
|
111
|
+
* `/truthmark-check` - audita a verdade do repositório.
|
|
112
|
+
|
|
113
|
+
Truth Sync não é o modo usual de começar trabalho; é a revisão de encerramento após mudanças funcionais de código.
|
|
114
|
+
Truth Structure não é um comando cotidiano; ele repara roteamento ou propriedade somente quando isso bloqueia o trabalho.
|
|
115
|
+
|
|
116
|
+
## O que você recebe
|
|
117
|
+
|
|
118
|
+
| Capacidade | O que faz |
|
|
119
|
+
| --- | --- |
|
|
120
|
+
| Verdade nativa do Git | Mantém a verdade do repositório em Markdown e configuração commitados. |
|
|
121
|
+
| Documentação com escopo de branch | A verdade se move com a branch em vez de viver em uma sessão privada. |
|
|
122
|
+
| CLI humana | Dá aos mantenedores comandos de configuração, atualização, validação e inspeção. |
|
|
123
|
+
| Orientação de agente instalada | Diz aos agentes de codificação quando documentar, testar, sincronizar verdade, auditar ou parar para revisão. |
|
|
124
|
+
| Roteamento explícito | Mapeia áreas de código para documentos de verdade canônicos. |
|
|
125
|
+
| Entregas revisáveis | Produz diffs Git comuns tanto para código quanto para documentos de verdade. |
|
|
126
|
+
| Operação local-first | Não requer serviço hospedado, daemon, banco de dados nem servidor MCP. |
|
|
127
|
+
| Limites de escrita mais seguros | Separa workflows code-first, doc-first, read-only e doc-only. |
|
|
128
|
+
| Validação | Relata problemas de roteamento, autoridade, frontmatter, links, superfícies geradas, escopo de branch, frescor e cobertura. |
|
|
129
|
+
| Portal opcional | Gera, quando explicitamente ativado e solicitado, um site estático HTML commitado a partir de documentos de verdade em Markdown. |
|
|
130
|
+
|
|
131
|
+
## Visão geral visual
|
|
132
|
+
|
|
133
|
+

|
|
134
|
+
|
|
135
|
+
**Recursos:** o que o Truthmark instala e como a superfície de workflow é dividida.
|
|
136
|
+
|
|
137
|
+

|
|
138
|
+
|
|
139
|
+
**Posição:** onde o Truthmark se encaixa em relação a prompts, memória e workflows de especificação.
|
|
140
|
+
|
|
141
|
+

|
|
142
|
+
|
|
143
|
+
**Fluxo de sincronização:** como o Truth Sync conclui mudanças normais de código antes da entrega.
|
|
144
|
+
|
|
145
|
+
## Por que equipes o adotam
|
|
146
|
+
|
|
147
|
+
Truthmark é para equipes que já sabem que agentes de IA podem gerar código.
|
|
148
|
+
|
|
149
|
+
O próximo problema é governança.
|
|
150
|
+
|
|
151
|
+
Não governança como cerimônia. Governança como uma pergunta simples:
|
|
152
|
+
|
|
153
|
+
> Depois desta mudança assistida por IA, o repositório ainda diz a verdade?
|
|
154
|
+
|
|
155
|
+
Truthmark ajuda equipes a responder isso com arquivos commitados, roteamento explícito e diffs revisáveis.
|
|
156
|
+
|
|
157
|
+
Ele é útil quando você precisa de:
|
|
158
|
+
|
|
159
|
+
- menos desvio de documentação
|
|
160
|
+
- melhores entregas
|
|
161
|
+
- verdade de produto específica por branch
|
|
162
|
+
- documentação duradoura de arquitetura e API
|
|
163
|
+
- ownership explícito entre docs e código
|
|
164
|
+
- limites de escrita de agentes mais seguros
|
|
165
|
+
- documentação revisável em vez de memória oculta
|
|
166
|
+
- orientação de agente que ainda funciona a partir de arquivos commitados no repositório
|
|
167
|
+
|
|
168
|
+
## Onde o Truthmark se encaixa
|
|
169
|
+
|
|
170
|
+
Truthmark não substitui prompts, memória, specs, testes nem revisão de código.
|
|
171
|
+
|
|
172
|
+
Ele dá a esses workflows um lugar durável para pousar no Git.
|
|
173
|
+
|
|
174
|
+
| Necessidade | Melhor encaixe |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| Melhor saída de uma sessão de agente | Prompt melhor |
|
|
177
|
+
| Continuidade pessoal ou no nível da sessão | Ferramenta de memória |
|
|
178
|
+
| Trabalho de funcionalidade com plano primeiro | Workflow de especificação |
|
|
179
|
+
| Verdade com escopo de branch que viaja com o código | Truthmark |
|
|
180
|
+
| Validar correção de comportamento | Testes e revisão |
|
|
181
|
+
| Revisar mudanças de documentação assistidas por IA | Truthmark mais revisão Git |
|
|
182
|
+
|
|
183
|
+
A faixa de atuação do Truthmark é estreita por design:
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
make repository truth explicit
|
|
187
|
+
route it to code
|
|
188
|
+
instalar orientação de agente ao redor dela
|
|
189
|
+
keep the result reviewable in Git
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
## Aprofunde-se
|
|
193
|
+
|
|
194
|
+
O README é a vitrine: contexto rápido, início rápido e o modelo mental central.
|
|
195
|
+
|
|
196
|
+
Para uso comando por comando, comparações de superfícies, detalhes de plataformas compatíveis, configuração, roteamento, Portal e exemplos, leia o [guia do usuário do Truthmark](../user-guide.md).
|
|
197
|
+
|
|
198
|
+
## Status do projeto
|
|
199
|
+
|
|
200
|
+
A versão atual fornece:
|
|
201
|
+
|
|
202
|
+
- comandos CLI locais para config, init, check, index, impact e status de workflows
|
|
203
|
+
- instruções de agente locais do repositório geradas para Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity e Cursor
|
|
204
|
+
- diagnósticos de roteamento, autoridade, frontmatter, links, frescor, superfícies geradas, escopo de branch e cobertura
|
|
205
|
+
- documentos de verdade com escopo de branch e artefatos derivados de inteligência do repositório
|
|
206
|
+
|
|
207
|
+
## Documentação
|
|
208
|
+
|
|
209
|
+
- [Guia do usuário](../user-guide.md)
|
|
210
|
+
- [Índice de docs](../README.md)
|
|
211
|
+
- [Visão geral da arquitetura](../truthmark/engineering/architecture/overview.md)
|
|
212
|
+
- [Contratos de API e CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
|
|
213
|
+
- [Guia de manutenção da verdade do repositório](../standards/maintaining-repository-truth.md)
|
|
214
|
+
|
|
215
|
+
Para comandos de desenvolvimento local e contribuição, consulte [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
|
216
|
+
|
|
217
|
+
## Limites de design
|
|
218
|
+
|
|
219
|
+
Truthmark é intencionalmente pequeno: local, commitado, com escopo de branch e revisável.
|
|
220
|
+
|
|
221
|
+
Ele não é um serviço hospedado, servidor MCP, banco de dados vetorial, camada de memória oculta, produto de enforcement de CI nem motor autônomo de reescrita de código. Ele ajuda a verdade do repositório a permanecer visível; não substitui testes, revisão de código nem julgamento humano.
|
|
222
|
+
|
|
223
|
+
## Licença
|
|
224
|
+
|
|
225
|
+
MIT. Veja [LICENSE](../../LICENSE).
|