46 lines
2.4 KiB
Markdown
46 lines
2.4 KiB
Markdown
# Audita CLI Reference
|
|
|
|
Audita uses CommandKit for routing and the ConfigKit and PromptKit integrations
|
|
for their standard inspection and request commands. Run `audita --help` or
|
|
command-specific `--help` for the installed command inventory. The adopted
|
|
[CommandKit consumer guide](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/f369d6a78253b6e6fcb1e023fb2e9c3af1d20ff0/docs/consumers/guide.md)
|
|
describes the standard command grammar, inspection, comparison, preview,
|
|
validation, smoke tests, and their provider-specific caveats. Help and version
|
|
do not load application or model configuration.
|
|
|
|
## Processing
|
|
|
|
```sh
|
|
audita process [flags] transcript.json
|
|
```
|
|
|
|
`--config` selects a main configuration and `--overlay` selects its overlay.
|
|
`--output` writes the transcript to a file; omission selects stdout. The shared
|
|
`--debug` flag enables retained debug artifacts, and `--quiet` suppresses optional
|
|
messages. Quiet processing requires an output file or `/dev/null`. See
|
|
[operations](operations.md) for output and report lifecycle.
|
|
|
|
Explicit process flags override root settings only. `--glossaries` and
|
|
`--protected-terms` each accept one JSON array of collection names or `null`;
|
|
`[]` clears the selection. Set pipeline order and per-entry overrides in YAML.
|
|
Other supplied flags cover profiles, output schema, description, reporting,
|
|
chunking, normalization, confidence thresholds, validation budget, and debug
|
|
work directory. `audita process --help` lists the available flags. An omitted flag
|
|
does not contribute an override. [Configuration](config.md) defines their values
|
|
and inheritance.
|
|
|
|
## Inspection and outcomes
|
|
|
|
The application configuration scope uses ConfigKit's native effective values,
|
|
source evidence, explanation, comparison, and redaction. PromptKit supplies its
|
|
own configuration and resource scopes and request preparation, validation, and
|
|
explicit smoke diagnostics. Inspection does not require a processing-ready
|
|
pipeline or contact a provider. Smoke tests can contact providers and are run
|
|
only on explicit request.
|
|
|
|
Process stdout contains transcript JSON when no output file is selected. Ordinary
|
|
reports may record recoverable model failures even when processing completes.
|
|
Exit status `0` means success, `1` runtime or output failure, `2` invalid usage
|
|
or input, and native comparison may return `3` for differences. See the
|
|
[output contract](integrations/output-files.md) and [subprocess contract](integrations/subprocess.md).
|