Migrate examples and guidance and remove legacy test harness

This commit is contained in:
2026-09-24 02:37:20 +00:00
parent 9561e80efb
commit 80804a038f
102 changed files with 328 additions and 8371 deletions

View File

@@ -13,12 +13,20 @@ go build -o ./bin/audita ./cmd/audita
```
Processing requires a reachable [compatible LLM endpoint](docs/integrations/openai-compatible-llm.md)
and access to its configured model. Supply its credentials through the
[configuration mechanisms](docs/config.md#secrets); the
[minimal config](examples/minimal-config.yml) reads `AUDITA_LLM_API_KEY` and uses
the [default model and endpoint](docs/config.md#llm-settings). Set that variable
in your environment before using an endpoint that requires authentication.
For another endpoint or model, edit a copy of the config.
and access to a model you select. The [minimal config](examples/minimal-config.yml)
targets an unauthenticated local endpoint; edit its endpoint and
[local profiles](examples/profiles/) to match your service and models. The
[service example](examples/production-config.yml) demonstrates a named credential
reference and a shared backend. Set its referenced environment variable before
validating it. The [testing overlay](examples/overlays/testing.yml) selects both
role profiles, but model cost, speed, and quality depend on your provider choices.
Check configuration and profile selection offline:
```sh
./bin/audita config validate --config examples/minimal-config.yml
./bin/audita config print-effective --config examples/minimal-config.yml --view profiles
```
Run the included small input with the minimal config:
@@ -29,8 +37,9 @@ Run the included small input with the minimal config:
--output corrected.json
```
This makes LLM requests. Inherited configuration environment overrides still
apply; see [precedence](docs/config.md#effective-precedence).
This makes LLM requests. Explicit setting flags override the selected file and
optional overlay; general environment setting overrides are no longer read.
See the [v2 migration guide](docs/migrations/v2.md) for old configurations.
## Documentation