@@ -37,6 +37,8 @@ Code gets simpler. Nothing else changes.
3737
3838Now concurrent requests can corrupt shared state.
3939
40+ ![ GauntletCI example] ( ./gauntletci-example.png )
41+
4042---
4143
4244## Looks equivalent, changes runtime behavior
@@ -99,6 +101,21 @@ GauntletCI evaluates staged or full diffs and returns:
99101
100102---
101103
104+ # What the model is used for
105+
106+ The model is used to:
107+
108+ - interpret diffs in context
109+ - reason about behavioral impact
110+ - explain why a change may be risky
111+ - suggest validation steps
112+
113+ It does not generate code.
114+
115+ It is used as a reasoning layer on top of deterministic rule detection.
116+
117+ ---
118+
102119# What this is
103120
104121A diff-first system that surfaces behavior changes that are likely not fully validated.
@@ -127,16 +144,62 @@ dotnet tool install -g GauntletCI
127144
128145# Quickstart
129146
130- 1 . Configure ` .gauntletci.json `
147+ GauntletCI needs minimal configuration to understand:
148+
149+ - how to run your tests
150+ - which rules should block a commit
151+ - which model (remote or local) to use for analysis
152+
153+ Works with local models for offline or cost-controlled usage.
154+
155+ 1 . Create or edit ` .gauntletci.json ` :
156+
157+ ``` json
158+ {
159+ "test_command" : " dotnet test" ,
160+ "disabled_rules" : [],
161+ "blocking_rules" : [" GCI012" , " GCI004" ],
162+ "telemetry" : true ,
163+ "model" : " claude-sonnet-4-6"
164+ }
165+ ```
131166
132- 2 . Set API key
167+ 2 . Configure a model provider
168+
169+ Supported:
170+
171+ - Hosted models (Anthropic, OpenAI, compatible APIs)
172+ - Local models (Ollama or any OpenAI-compatible endpoint)
173+
174+ Example (Anthropic):
175+
176+ set ANTHROPIC_API_KEY=your_key_here
177+
178+ Example (Ollama):
179+
180+ - Install Ollama: https://ollama.com
181+ - Run a model locally:
182+ ollama run llama3
183+ - Configure endpoint in your environment or config
133184
1341853 . Run:
135186
136187gauntletci
137188
189+ Optional:
190+
191+ gauntletci --full
192+ gauntletci --rule GCI012
193+ gauntletci --format json
194+
138195---
139196
140197# License
141198
142- Elastic License 2.0 (ELv2)
199+ GauntletCI is source-available under the Elastic License 2.0 (ELv2).
200+
201+ This means you can use, modify, and distribute the source freely except:
202+
203+ - You may not offer GauntletCI as a managed service or SaaS product.
204+
205+ If you are building an internal tool or using the CLI directly, ELv2 places no restrictions on you.
0 commit comments