truthmark 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,220 +1,194 @@
1
1
  # Truthmark
2
2
 
3
- **Twoi agenci piszą kod. Truthmark utrzymuje dokumentację dla ludzi, możliwą do przeglądu w Git.**
3
+ **Twoi agenci piszą kod. Truthmark dba o dokumentację dla ludzi, gotową do przeglądu w Git.**
4
4
 
5
- [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
5
+ Truthmark instaluje natywne dla Git przepływy pracy, dzięki którym agenci programistyczni AI tworzą nową dokumentację produktu i inżynierii na podstawie istniejącego kodu i testów, aktualizują po każdej zmianie kodu oraz przekazują Ci zwykłe diffy Markdown do przeglądu.
6
6
 
7
- ![Baner Truthmark](../assets/truthmark-banner.png)
7
+ [![wersja npm](https://img.shields.io/npm/v/truthmark?color=cb3837&label=npm)](https://www.npmjs.com/package/truthmark)
8
+ [![CI](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/merlinhu1/truthmark/actions/workflows/ci.yml)
9
+ [![Licencja: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../../LICENSE)
10
+ [![Node.js >=24](https://img.shields.io/badge/node-%3E%3D24-339933?logo=node.js&logoColor=white)](../../package.json)
8
11
 
9
- ## 🚀 Szybki start: lokalne uruchomienie w pięć minut
12
+ [Zacznij](#szybki-start-utwórz-swój-pierwszy-dokument-truth) · [Strona internetowa](https://merlinhu1.github.io/truthmark/) · [Przewodnik użytkownika](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md) · [GitHub](https://github.com/merlinhu1/truthmark)
10
13
 
11
- Uruchom to w repozytorium Git, którym ma zarządzać Truthmark:
14
+ <details>
15
+ <summary>Przeczytaj ten plik README w jednym z 16 języków</summary>
12
16
 
13
- ```bash
14
- cd /path/to/your-repo
15
- npm install -g truthmark
16
- truthmark init
17
- truthmark check
18
- git diff
19
- ```
17
+ [🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt.md) | [🇷🇺 Русский](README.ru.md) | [🇸🇦 العربية](README.ar.md) | [🇮🇹 Italiano](README.it.md) | [🇵🇱 Polski](README.pl.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇩 Bahasa Indonesia](README.id.md) | [🇬🇷 Ελληνικά](README.el.md)
20
18
 
21
- 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.
19
+ </details>
22
20
 
23
- W skryptach i CI powtarzaj `--platform`; `--json` nigdy nie wyświetla pytania:
21
+ ## Twórz dokumentację od podstaw. Dbaj, by pozostawała prawdziwa.
24
22
 
25
- ```bash
26
- truthmark init --platform codex --platform cursor
27
- truthmark init --json
28
- ```
23
+ Większość narzędzi do dokumentacji kończy pracę po jej wygenerowaniu. Truthmark zapewnia agentom pełny cykl życia dokumentacji wewnątrz repozytorium:
29
24
 
30
- Przy pierwszym nieinteraktywnym uruchomieniu bez `--platform` konfiguracja pozostaje neutralna; kolejne uruchomienia zachowują wybór zapisany w `.truthmark/config.yml`.
25
+ - **Twórz nową dokumentację na podstawie działającego oprogramowania.** Truth Document odczytuje kod i testy, a następnie tworzy precyzyjnie ograniczoną dokumentację produktu lub inżynierii.
26
+ - **Automatycznie utrzymuj zgodność dokumentacji.** Truth Sync uruchamia się przy przekazaniu pracy przez agenta po zmianach kodu funkcjonalnego i aktualizuje prawdę repozytorium przed zakończeniem zadania.
27
+ - **Zamieniaj dokumentację z powrotem w kod.** Truth Realize implementuje zatwierdzone dokumenty truth, zachowując przejrzysty przepływ pracy doc-first.
28
+ - **Naprawiaj własność wraz z rozwojem bazy kodu.** Truth Structure tworzy precyzyjne trasy i dokumenty startowe dla nowych lub przeciążonych obszarów.
29
+ - **Przeglądaj wszystko w Git.** Kod, decyzje, kontrakty, architektura, operacje i zachowanie podążają razem z gałęzią.
31
30
 
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:
31
+ Bez hostowanej bazy wiedzy. Bez prywatnej pamięci agenta. Bez dokumentacji uwięzionej w historii czatu.
33
32
 
34
- ```text
35
- /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
36
- ```
33
+ ## Szybki start: utwórz swój pierwszy dokument truth
37
34
 
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.
35
+ **Wymagania:** Node.js 24 lub nowszy, repozytorium Git oraz obsługiwany host programistyczny AI do przepływów pracy agentów.
39
36
 
40
- Jeśli chcesz tylko walidacji CLI, wybierz `none` i uruchom `truthmark check`; później możesz ponownie uruchomić `truthmark init`, aby wybrać platformy.
37
+ Uruchom poniższe polecenia w repozytorium, którym ma zarządzać Truthmark:
41
38
 
42
- ## 💡 Problem: luka w dokumentacji AI
39
+ ```bash
40
+ cd /path/to/your-repo
41
+ npm install -g truthmark
42
+ truthmark init
43
+ ```
43
44
 
44
- Agenci kodujący AI niezwykle dobrzy w szybkim pisaniu kodu. Ta prędkość tworzy jednak groźny nowy tryb awarii: **historia repozytorium zaczyna rozmijać się z rzeczywistością.**
45
+ `truthmark init` pozwala wybrać Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity, Cursor albo konfigurację interfejsu wiersza poleceń niezależną od hosta.
45
46
 
46
- * Zachowanie ginie w ulotnych historiach czatu.
47
- * Dokumenty architektoniczne szybko zostają w tyle.
48
- * Decyzje produktowe znikają po przekazaniu pracy.
49
- * Recenzenci kodu oglądają surowe diffy kodu bez zrozumienia „dlaczego”.
50
- * Każda nowa sesja AI musi od zera odkrywać truth repozytorium.
47
+ Teraz poproś skonfigurowanego agenta o udokumentowanie jednego rzeczywistego zachowania:
51
48
 
52
- ## 🎯 Rozwiązanie: Truthmark
49
+ ```text
50
+ /truthmark-document document the implemented session timeout behavior across src/auth/session.ts and tests/auth/session.test.ts
51
+ ```
53
52
 
54
- **Truthmark** instaluje w Twoim repozytorium warstwę workflow natywną dla Git. Naprawia część rozwoju z AI, która zwykle się psuje: pomaga utrzymać dokumentację w zgodzie z kodem.
53
+ Truth Document tworzy nowy, precyzyjnie ograniczony dokument truth, jeśli taki jeszcze nie istnieje, aktualizuje istniejącego właściciela, gdy już istnieje, i w razie potrzeby aktualizuje routing. Nie zmienia kodu funkcjonalnego.
55
54
 
56
- 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.
55
+ Przejrzyj rezultat:
57
56
 
58
- ### ✨ Dlaczego Truthmark jest wyjątkowy
57
+ ```bash
58
+ truthmark check
59
+ git status --short --untracked-files=all
60
+ git diff
61
+ ```
59
62
 
60
- Truthmark nie jest tylko kolejnym narzędziem do dokumentacji. Jest głęboko zintegrowany z workflow AI:
63
+ Powinny teraz istnieć:
61
64
 
62
- * **🚫 Zero zależności od dostawcy:** brak usług hostowanych, ukrytych baz danych i dodatkowych serwerów do utrzymywania.
63
- * **🌳 100% natywny dla Git:** wszystko mieszka w Twoim repozytorium. Truth porusza się razem z gałęzią.
64
- * **🤝 Kontrakt należący do ludzi i wykonywany przez agentów:** Opiekunowie posiadają kontrakt repozytorium; agenci podczas kodowania podążają za zainstalowanymi instrukcjami.
65
- * **✅ 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.
65
+ ```text
66
+ docs/truthmark/engineering/behaviors/session-timeout.md
67
+ docs/truthmark/routes/areas/authentication.md
68
+ ```
66
69
 
67
- ## 🔄 Jak to działa
70
+ Dokładne ścieżki wynikają ze struktury własności w Twoim repozytorium. Nowe pliki pojawiają się w `git status`, a zmiany w śledzonych plikach — w `git diff`.
68
71
 
69
- 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:
72
+ Sposób wywołania zależy od hosta. OpenCode używa `/skill truthmark-document`, Antigravity używa `@truthmark-document`, a pozostałe obsługiwane hosty korzystają ze swoich natywnych umiejętności lub poleceń z ukośnikiem. Dokładne polecenia znajdziesz w [tabeli platform](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md#supported-agent-platforms).
70
73
 
71
- 1. 💻 **Kod:** agent modyfikuje kod funkcjonalny.
72
- 2. 🧪 **Test:** wykonywane są odpowiednie testy.
73
- 3. 🔍 **Sprawdzenie:** Truthmark sprawdza zmapowaną dokumentację jako część zainstalowanego końcowego przeglądu.
74
- 4. 📝 **Dokumentacja:** agent aktualizuje dokumenty, gdy truth repozytorium się zmieniła.
75
- 5. 👀 **Przegląd:** człowiek przegląda *diff kodu* + *diff truth*.
74
+ W skryptach i ciągłej integracji jawnie przekaż wybrane platformy:
76
75
 
77
- ## 🛠 Jak używasz Truthmark
76
+ ```bash
77
+ truthmark init --platform codex --platform cursor
78
+ truthmark init --json
79
+ ```
78
80
 
79
- Truthmark ma jeden lokalny kontrakt repozytorium i dwa sposoby korzystania z niego.
81
+ Wybierz interaktywnie `none` albo uruchom `truthmark init --clear-platforms`, aby uzyskać repozytorium niezależne od hosta. Platformy agentów możesz dodać później, ponownie uruchamiając `truthmark init`.
80
82
 
81
- ### Ludzie instalują i walidują kontrakt
83
+ Aby uzyskać diagnostykę aktualności względem gałęzi, przekaż bazę Git:
82
84
 
83
- Opiekunowie i CI używają CLI:
85
+ ```bash
86
+ truthmark check --base <base-ref>
87
+ ```
84
88
 
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.
86
- * `truthmark check` - waliduje truth repozytorium z terminala.
89
+ ## Jak działa Truthmark
87
90
 
88
- ### Agenci podążają za kontraktem podczas kodowania
91
+ <picture>
92
+ <source media="(max-width: 700px)" srcset="../assets/truthmark-workflow-mobile.svg">
93
+ <img src="../assets/truthmark-workflow.svg" alt="Jak działa Truthmark" width="1440">
94
+ </picture>
89
95
 
90
- Truthmark instaluje lokalne instrukcje repozytorium dla obsługiwanych hostów kodowania AI, takich jak Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity i Cursor.
96
+ Interfejs wiersza poleceń Truthmark instaluje i sprawdza kontrakt repozytorium. Twój agent programistyczny analizuje dowody i wykonuje pracę dokumentacyjną za pomocą zainstalowanych, natywnych dla hosta przepływów pracy.
91
97
 
92
- Normalna pętla jest prosta:
98
+ Typowa zmiana kodu przebiega w jednej prostej pętli:
93
99
 
94
- 1. Poproś agenta o zmianę kodu albo o udokumentowanie istniejącego zachowania.
95
- 2. Zainstalowane instrukcje mówią agentowi, kiedy testować, kiedy aktualizować truth docs i kiedy zatrzymać się do ludzkiego przeglądu.
96
- 3. Przeglądasz zwykłe diffy Git: kod plus ewentualne zmiany w truth-doc.
100
+ 1. Agent zmienia kod funkcjonalny.
101
+ 2. Uruchamiane odpowiednie testy.
102
+ 3. Truth Sync sprawdza zmapowaną dokumentację.
103
+ 4. Gdy prawda repozytorium się zmieniła, agent tworzy lub aktualizuje dokumentację oraz routing.
104
+ 5. Wspólnie przeglądasz diff kodu i diff dokumentów truth.
97
105
 
98
- Żądania agenta uruchamiane przez użytkownika są celowo nieliczne:
106
+ ## Przepływy pracy
99
107
 
100
- * `/truthmark-document` - dokumentuje istniejące zaimplementowane zachowanie z kodu i testów.
101
- * `/truthmark-realize` - implementuje kod z istniejących truth docs.
102
- * `/truthmark-check` - audytuje truth repozytorium.
108
+ | Przepływ pracy | Kiedy go używać | Rezultat |
109
+ | -------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
110
+ | **Truth Document** | Istniejący kod wymaga dokumentacji | Tworzy lub aktualizuje opartą na dowodach dokumentację produktu i inżynierii |
111
+ | **Truth Sync** | Zmienił się kod funkcjonalny | Przed przekazaniem pracy utrzymuje zgodność zmapowanej dokumentacji i routingu |
112
+ | **Truth Structure** | Nowy obszar potrzebuje właściciela albo istniejąca dokumentacja jest zbyt szeroka | Tworzy precyzyjne trasy i szkieletowe dokumenty startowe |
113
+ | **Truth Realize** | Zatwierdzony dokument truth powinien stać się działającym oprogramowaniem | Aktualizuje kod funkcjonalny na podstawie dokumentacji |
114
+ | **Truth Check** | Prawda repozytorium wymaga audytu | Zgłasza problemy z routingiem, własnością, dowodami i dokumentacją |
115
+ | **Truthmark Portal** | Zespół potrzebuje witryny z dokumentacją do wygodnego przeglądania | Generuje zatwierdzoną statyczną prezentację HTML z dokumentów truth w Markdown |
103
116
 
104
- Truth Sync nie jest zwykłym sposobem rozpoczynania pracy; to końcowy przegląd po funkcjonalnych zmianach kodu.
105
- Truth Structure nie jest codzienną komendą; naprawia routing lub własność tylko wtedy, gdy blokuje to pracę.
117
+ Truthmark instaluje te przepływy pracy jako natywne powierzchnie repozytorium dla Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity i Cursor.
106
118
 
107
119
  ## Co otrzymujesz
108
120
 
109
- | Możliwość | Co robi |
110
- | --- | --- |
111
- | Truth natywny dla Git | Utrzymuje truth repozytorium w zatwierdzonych plikach Markdown i konfiguracji. |
112
- | Dokumentacja w zakresie gałęzi | Truth porusza się z gałęzią zamiast mieszkać w prywatnej sesji. |
113
- | CLI dla ludzi | Daje opiekunom komendy konfiguracji, odświeżania, walidacji i inspekcji. |
114
- | Zainstalowana instrukcja agenta | Mówi agentom kodującym, kiedy dokumentować, testować, synchronizować truth, audytować lub zatrzymać się do przeglądu. |
115
- | Jawny routing | Mapuje obszary kodu na kanoniczne dokumenty truth. |
116
- | Przekazania możliwe do przeglądu | Tworzy zwykłe diffy Git zarówno dla kodu, jak i dokumentów truth. |
117
- | Działanie local-first | Nie wymaga hostowanej usługi, demona, bazy danych ani serwera MCP. |
118
- | Bezpieczniejsze granice zapisu | Rozdziela workflow code-first, doc-first, read-only i doc-only. |
119
- | Walidacja | Raportuje problemy z routingiem, uprawnieniami, frontmatter, linkami, wygenerowaną powierzchnią, zakresem gałęzi, świeżością i pokryciem. |
120
- | Opcjonalny Portal | Generuje zatwierdzoną statyczną witrynę prezentacyjną HTML z dokumentów truth w Markdown, gdy jest wyraźnie włączony i zażądany. |
121
-
122
- ## Przegląd wizualny
123
-
124
- ![Funkcje Truthmark](../assets/truthmark-features.png)
125
-
126
- **Funkcje:** co Truthmark instaluje i jak podzielona jest powierzchnia workflow.
121
+ ### Dokumentację, która zaczyna od rzeczywistości
127
122
 
128
- ![Pozycja Truthmark](../assets/truthmark-position.png)
123
+ Truthmark potrafi tworzyć dokumentację możliwości produktu, zachowania implementacji, interfejsów programistycznych aplikacji, architektury, przepływów pracy, operacji i testów. Kod i testy dostarczają dowodów, a precyzyjnie ograniczone dokumenty Markdown utrwalają wynik.
129
124
 
130
- **Pozycja:** gdzie Truthmark mieści się względem promptów, pamięci i workflow specyfikacji.
125
+ ### Dokumentację, która przetrwa kolejną zmianę
131
126
 
132
- ![Przepływ synchronizacji Truthmark](../assets/truthmark-syncflow.png)
127
+ Trasy łączą obszary kodu z kanonicznymi dokumentami. Kiedy agenci zmieniają zachowanie, Truth Sync wie, gdzie należy zapisać odpowiadającą mu prawdę, i utrzymuje przekazanie pracy w formie gotowej do przeglądu.
133
128
 
134
- **Przepływ synchronizacji:** jak Truth Sync zamyka zwykłe zmiany kodu przed przekazaniem.
129
+ ### Prawdę produktu i inżynierii w osobnych obszarach
135
130
 
136
- ## Dlaczego zespoły go przyjmują
131
+ Prawda produktu obejmuje obietnice dla użytkowników, granice, decyzje i kryteria akceptacji. Prawda inżynierii obejmuje bieżące zachowanie, kontrakty, architekturę, przepływy pracy, operacje oraz zachowanie testów.
137
132
 
138
- Truthmark jest dla zespołów, które już wiedzą, że agenci AI potrafią generować kod.
133
+ ### Współpracę natywną dla Git
139
134
 
140
- Następnym problemem jest governance.
135
+ Wszystko, co ważne, znajduje się w zatwierdzonych plikach repozytorium. Prawda podąża za gałęzią, współpracuje ze zwykłymi pull requestami i pozostaje widoczna dla każdego opiekuna oraz agenta programistycznego.
141
136
 
142
- Nie governance jako ceremonia. Governance jako proste pytanie:
137
+ ### Działanie local-first
143
138
 
144
- > Czy po tej zmianie wspieranej przez AI repozytorium nadal mówi truth?
145
-
146
- Truthmark pomaga zespołom odpowiedzieć na to pytanie za pomocą zatwierdzonych plików, jawnego routingu i diffów możliwych do przeglądu.
147
-
148
- Jest przydatny, gdy potrzebujesz:
149
-
150
- - mniejszego rozjazdu dokumentacji
151
- - lepszych przekazań pracy
152
- - truth produktu specyficznego dla gałęzi
153
- - trwałej dokumentacji architektury i API
154
- - jawnej własności między dokumentami a kodem
155
- - bezpieczniejszych granic zapisu dla agentów
156
- - dokumentacji możliwej do przeglądu zamiast ukrytej pamięci
157
- - instrukcje agenta, które nadal działają z commitowanych plików repozytorium
139
+ Truthmark nie potrzebuje hostowanej usługi, demona, bazy danych, magazynu wektorowego ani serwera Model Context Protocol. Repozytorium zawiera własny przepływ pracy dokumentacyjnej.
158
140
 
159
141
  ## Gdzie pasuje Truthmark
160
142
 
161
- Truthmark nie zastępuje promptów, pamięci, specyfikacji, testów ani przeglądu kodu.
162
-
163
- Daje tym workflow trwałe miejsce w Git.
164
-
165
- | Potrzeba | Lepsze dopasowanie |
166
- | --- | --- |
167
- | Lepszy wynik z jednej sesji agenta | Lepszy prompt |
168
- | Ciągłość osobista lub na poziomie sesji | Narzędzie pamięci |
169
- | Praca nad funkcją zaczynająca się od planu | Workflow specyfikacji |
170
- | Truth w zakresie gałęzi, która podróżuje z kodem | Truthmark |
171
- | Walidacja poprawności zachowania | Testy i przegląd |
172
- | Przegląd zmian dokumentacji wspieranych przez AI | Truthmark plus przegląd Git |
173
-
174
- Zakres Truthmark jest celowo wąski:
143
+ | Potrzeba | Najlepsze rozwiązanie |
144
+ | ----------------------------------------------------- | ------------------------------ |
145
+ | Lepszy wynik z jednej sesji agenta | Lepszy prompt |
146
+ | Ciągłość osobista lub na poziomie sesji | Narzędzie pamięci |
147
+ | Praca nad funkcją rozpoczynana od planu | Przepływ pracy specyfikacji |
148
+ | Dokumentacja w zakresie gałęzi, która podąża za kodem | **Truthmark** |
149
+ | Poprawność zachowania | Testy i przegląd kodu |
150
+ | Dokumentacja wspierana przez AI i gotowa do przeglądu | **Truthmark + przegląd w Git** |
175
151
 
176
- ```text
177
- make repository truth explicit
178
- route it to code
179
- zainstalować wokół niej instrukcje agenta
180
- keep the result reviewable in Git
181
- ```
182
-
183
- ## Więcej szczegółów
152
+ Truthmark powstał dla opiekunów i zespołów inżynierskich, które już korzystają z agentów programistycznych AI i chcą, aby repozytorium nadążało z prawdą za każdą zmianą kodu.
184
153
 
185
- README jest witryną sklepową: szybki kontekst, szybki start i podstawowy model myślowy.
154
+ ## Obsługiwane hosty i wiersz poleceń
186
155
 
187
- 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).
156
+ Obsługiwane hosty agentów:
188
157
 
189
- ## Status projektu
158
+ - Codex
159
+ - Claude Code
160
+ - GitHub Copilot
161
+ - OpenCode
162
+ - Antigravity
163
+ - Cursor
190
164
 
191
- Obecne wydanie zapewnia:
165
+ <details>
166
+ <summary>Dokumentacja wiersza poleceń</summary>
192
167
 
193
- - lokalne komendy CLI dla init, check, index, impact i workflow status
194
- - wygenerowane lokalne instrukcje agenta dla Codex, Claude Code, GitHub Copilot, OpenCode, Antigravity i Cursor
195
- - diagnostykę route, authority, frontmatter, link, freshness, generated-surface, branch-scope i coverage
196
- - dokumenty truth w zakresie gałęzi oraz pochodne artefakty inteligencji repozytorium
168
+ | Polecenie | Zastosowanie |
169
+ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
170
+ | `truthmark init` | Tworzy lub odświeża konfigurację, routing, szablony i przepływy pracy wybranych hostów |
171
+ | `truthmark check [--base <ref>]` | Sprawdza prawdę repozytorium i opcjonalnie uruchamia diagnostykę aktualności gałęzi |
172
+ | `truthmark index --json` | Wyświetla pochodne metadane repozytorium i routingu |
173
+ | `truthmark impact --base <ref> --json` | Mapuje zmienione pliki na dokumentację, właścicieli i pobliskie testy |
174
+ | `truthmark workflow status --workflow <id> [--base <ref>] --json` | Wyświetla zastosowanie przepływu pracy i jego cele |
175
+ | `truthmark validate ...` | Sprawdza raporty przepływów pracy i dzierżawy zapisu |
176
+ | `truthmark uninstall --dry-run\|--apply` | Wyświetla podgląd lub usuwa wygenerowane powierzchnie hosta, zachowując utworzone dokumenty truth |
197
177
 
198
- ## Dokumentacja
178
+ Strukturyzowane dane wyjściowe JSON są dostępne w całym interfejsie wiersza poleceń na potrzeby skryptów i ciągłej integracji.
199
179
 
200
- - [Przewodnik użytkownika](../user-guide.md)
201
- - [Indeks dokumentacji](../README.md)
202
- - [Przegląd architektury](../truthmark/engineering/architecture/overview.md)
203
- - [Kontrakty API i CLI](../truthmark/engineering/contracts/config-route-and-check-contracts.md)
204
- - [Przewodnik utrzymania repository truth](../standards/maintaining-repository-truth.md)
180
+ </details>
205
181
 
206
- Komendy lokalnego rozwoju i kontrybuowania znajdziesz w [CONTRIBUTING.md](../../CONTRIBUTING.md).
182
+ ## Dowiedz się więcej
207
183
 
208
- ## Granice projektu
184
+ - [Przewodnik użytkownika Truthmark](https://github.com/merlinhu1/truthmark/blob/main/docs/user-guide.md)
185
+ - [Indeks dokumentacji](https://github.com/merlinhu1/truthmark/blob/main/docs/README.md)
186
+ - [Przegląd architektury](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/architecture/overview.md)
187
+ - [Kontrakty konfiguracji, routingu i poleceń](https://github.com/merlinhu1/truthmark/blob/main/docs/truthmark/engineering/contracts/config-route-and-check-contracts.md)
188
+ - [Współtworzenie](https://github.com/merlinhu1/truthmark/blob/main/CONTRIBUTING.md)
209
189
 
210
- Truthmark jest celowo mały: lokalny, zatwierdzony, ograniczony do gałęzi i możliwy do przeglądu.
211
-
212
- 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.
190
+ **Zainstaluj Truthmark, wybierz host programistyczny i już dziś zamień jedno rzeczywiste zachowanie w dokumentację.**
213
191
 
214
192
  ## Licencja
215
193
 
216
194
  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.