xgauntlet 0.2.0 → 0.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.
Files changed (2) hide show
  1. package/README.md +70 -25
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -37,62 +37,107 @@
37
37
 
38
38
  **xGauntlet** omgiver AI-genereret kode med et kompromisløst verifikations-gauntlet (Linters, Type-checkere, Unit tests, Invariant-tests og Mutationsafprøvning), håndhæver en deterministisk **Zero Ambient Authority WebAssembly policy-kerne** (`wit/gauntlet_policy.wit`) og oversætter rå fejludskrifter til **Actionable Diagnostics** i et feedback-loop, som AI-agenter kan handle direkte på.
39
39
 
40
- Bygget i **Rust** for lynhurtig sub-3ms koldstart uden baggrundsdæmoner, og distribueret via **NPX** for øjeblikkelig brug på tværs af **Linux**, **macOS** og **Windows 11**.
40
+ Bygget i **Rust** for lynhurtig sub-3ms koldstart uden baggrundsdæmoner, og distribueret via **NPM** og **Cargo** for øjeblikkelig brug på tværs af **Linux**, **macOS** og **Windows 11**.
41
41
 
42
42
  ---
43
43
 
44
44
  ## 🚀 Hurtig Start & Installation
45
45
 
46
- Kom i gang på under 10 sekunder uden forudgående installation via NPX:
46
+ xGauntlet følger samme enkle model som `git`: Værktøjet installeres én gang globalt på maskinen, hvorefter du initialiserer det lokalt i de repositories, du ønsker at sætte under governance.
47
47
 
48
- ### 1. Initialiser dit projekt
49
- Stil dig i rodmappen på dit projekt (Rust, TypeScript, Python eller polyglot) og kør:
48
+ ### 1. Installer xGauntlet (én gang på din maskine)
49
+
50
+ Kør én enkelt kommando for at installere værktøjet globalt på tværs af alle programmeringssprog og platforme:
51
+
52
+ ```bash
53
+ npm install -g xgauntlet
54
+ ```
55
+
56
+ > [!TIP]
57
+ > **⚡ Hvorfor global installation frem for blot `npx`?**
58
+ > Når `xgauntlet` er installeret globalt i dit `$PATH`, kører gatekeeper-hooks (`xgauntlet hook ...`) direkte som maskinkode på **under 3 millisekunder** ved hvert eneste værktøjskald fra din AI-agent – helt uden Node.js koldstarts-overhead.
59
+ > *(Du kan dog stadig køre `npx xgauntlet init`, hvis du blot vil afprøve værktøjet flygtigt uden installation).*
60
+
61
+ ### 2. Initialiser dit projekt (In-Repo Governance)
62
+
63
+ Gå ind i dit projekt – uanset om det er skrevet i Python, Rust, Go eller TypeScript:
50
64
 
51
65
  ```bash
52
66
  # Åbn dit projektkatalog
53
67
  cd ~/sti/til/dit-projekt
54
68
 
55
- # Scaffold samtlige in-repo styringsfiler direkte via NPX
56
- npx xgauntlet init
69
+ # Scaffold in-repo styringsfiler:
70
+ xgauntlet init
57
71
  ```
58
72
 
73
+ `xgauntlet init` detekterer automatisk projektets programmeringssprog (via `package.json`, `Cargo.toml`, `pyproject.toml`, `go.mod` osv.) og opretter de deklarative styringsfiler.
74
+
59
75
  #### 📦 Hvad `xgauntlet init` opretter lokalt i projektet (In-Repo Single Source of Truth):
60
- | Fil / Mappe | Formål |
61
- |---|---|
62
- | [`gauntlet.toml`](gauntlet.toml) | Deklarativ konfiguration af lintere, typer, tests og verifikationslag |
63
- | [`CONTEXT.md`](CONTEXT.md) | Domæne-glossary for projektet (Aristoteles' *definitio per genus et differentiam*) |
64
- | [`CODING_STANDARDS.md`](CODING_STANDARDS.md) | Multi-stack kodestandarder og arkitekturinvarianter |
65
- | [`spec.md`](spec.md) | Makro-specifikation og system-invarianter |
66
- | [`tasks/001-bootstrap.md`](tasks/) | Opgavemappe til håndhævelse af task-kontrakter & acceptkriterier |
67
- | [`docs/adr/`](docs/adr/) | Architecture Decision Records (ADR) til projekt-specifikke beslutninger |
68
- | [`.agents/AGENTS.md`](.agents/AGENTS.md) | Retningslinjer for AI-agenter, Response HUD og task-management |
69
- | [`.agents/hooks.json`](.agents/hooks.json) | Pre-Invocation Hook til gatekeeperen |
70
- | [`CLAUDE.md`](CLAUDE.md) | Retningslinjer og sikkerhedsinvarianter for Claude Code |
76
+
77
+ | Fil / Mappe | Type | Formål |
78
+ |---|---|---|
79
+ | [`gauntlet.toml`](gauntlet.toml) | **Fælles** | Deklarativ konfiguration af lintere, typer, tests og verifikationslag |
80
+ | [`CONTEXT.md`](CONTEXT.md) | **Fælles** | Domæne-glossary for projektet (Aristoteles' *definitio per genus et differentiam*) |
81
+ | [`CODING_STANDARDS.md`](CODING_STANDARDS.md) | **Fælles** | Multi-stack kodestandarder og arkitekturinvarianter |
82
+ | [`spec.md`](spec.md) | **Fælles** | Makro-specifikation og system-invarianter |
83
+ | [`tasks/001-bootstrap.md`](tasks/) | **Fælles** | Opgavemappe til håndhævelse af task-kontrakter & acceptkriterier |
84
+ | [`docs/adr/`](docs/adr/) | **Fælles** | Architecture Decision Records (ADR) til projekt-specifikke beslutninger |
85
+ | [`.agents/AGENTS.md`](.agents/AGENTS.md) | **Antigravity / Gemini** | Retningslinjer for AI-agenter, Response HUD og task-management |
86
+ | [`.agents/hooks.json`](.agents/hooks.json) | **Antigravity / Gemini** | PreToolUse gatekeeper hook konfiguration |
87
+ | [`CLAUDE.md`](CLAUDE.md) | **Claude Code** | Retningslinjer og sikkerhedsinvarianter for Anthropic Claude Code |
88
+
89
+ > [!NOTE]
90
+ > **🤝 Poly-Harness Sameksistens:**
91
+ > De 7 øverste filer er helt universelle og styrer projektet for både mennesker og alle typer AI-agenter. De to harness-specifikke sæt (`CLAUDE.md` og `.agents/`) sameksisterer fredeligt uden konflikter, så du eller dit team frit kan skifte mellem f.eks. Google Antigravity IDE og Claude Code på det samme projekt. Hvis du udelukkende benytter én agent, kan det overskydende sæt frit slettes.
71
92
 
72
93
  > [!TIP]
73
94
  > **🛡️ Ikke-destruktiv Garanti (Safety First):**
74
95
  > `xgauntlet init` overskriver **aldrig** eksisterende filer i dit projekt, medmindre du udtrykkeligt angiver `--force`.
75
96
 
76
- ### 2. Kør Verifikation & Tjek Evidens
97
+ ### 3. Kør Verifikation & Tjek Evidens
98
+
77
99
  Når du eller agenten arbejder på en opgave i projektet, afvikles gauntlettet direkte:
78
100
 
79
101
  ```bash
80
102
  # Kør gauntlet og forseg evidens for en opgave:
81
- npx xgauntlet verify --task-id 001-bootstrap
103
+ xgauntlet verify --task-id 001-bootstrap
82
104
 
83
105
  # Valider kildetræets integritet mod rapporten (drift-kontrol):
84
- npx xgauntlet check-evidence
106
+ xgauntlet check-evidence
85
107
 
86
108
  # Valider opgavespecifikation og CONTEXT.md definitionsformat:
87
- npx xgauntlet check-spec
109
+ xgauntlet check-spec
88
110
 
89
111
  # Kør miljø- og toolchain-diagnostik:
90
- npx xgauntlet doctor
112
+ xgauntlet doctor
91
113
  ```
92
114
 
93
- > [!IMPORTANT]
94
- > **🚪 Zero Lock-in & Ren Afinstallation:**
95
- > Alt ligger lokalt i dit Git-træ. xGauntlet efterlader ingen globale dæmoner, baggrundsprocesser eller systemændringer på din maskine.
115
+ ---
116
+
117
+ ### 🧹 Afinstallation & Oprydning
118
+
119
+ xGauntlet kører efter **Zero Lock-in** princippet. Der er ingen baggrundsdæmoner, ingen systemd services og ingen skjulte registre:
120
+
121
+ #### 1. Afkobl et projekt (Kirurgisk In-Repo Oprydning)
122
+ For at fjerne xGauntlet fra et projekt, fjerner du blot de specifikke styringsfiler. Dine egne kodefiler, egne tasks og egne ADR'er berøres ikke:
123
+
124
+ ```bash
125
+ # Fjern xGauntlets kontrolfiler i projektet:
126
+ rm -f gauntlet.toml .agents/hooks.json verification-report.json evidence.md
127
+
128
+ # (Valgfrit) Fjern de oprindeligt scaffoldede skabeloner, hvis du ikke ønsker at bevare dem:
129
+ rm -f tasks/001-bootstrap.md docs/adr/0001-package-by-feature-architecture.md
130
+ ```
131
+
132
+ #### 2. Afinstaller værktøjet fra maskinen (Global Cleanup)
133
+ Hvis du ønsker at fjerne selve `xgauntlet`-programmet fra dit styresystem:
134
+
135
+ ```bash
136
+ npm uninstall -g xgauntlet
137
+
138
+ # Hvis du tidligere har afviklet flygtigt via npx, slettes den lokale cache-binær:
139
+ rm -rf ~/.cache/xgauntlet
140
+ ```
96
141
 
97
142
  ---
98
143
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "xgauntlet",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Universal cross-platform verification gauntlet & tamper-proof policy sidecar for AI coding agents",
5
5
  "bin": {
6
6
  "xgauntlet": "bin/xgauntlet.js",