2026-05-24 00:51:02 +00:00
# Audita CLI Reference
2026-11-10 17:52:14 +00:00
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.
2026-05-24 00:51:02 +00:00
2026-11-10 17:52:14 +00:00
## Processing
2026-05-24 00:51:02 +00:00
```sh
2026-11-10 17:52:14 +00:00
audita process [flags] transcript.json
2026-05-24 00:51:02 +00:00
```
2026-11-10 17:52:14 +00:00
`--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.
2026-11-16 15:12:06 +00:00
Progress for processing goes to stderr. Use `--progress` to show stage and
chunk activity, model proposal, validation and repair operations, and observed
counts as work completes. Debug mode enables progress by default.
`--progress=false` disables it, and quiet mode suppresses it even when
`--progress` is explicit.
2026-11-10 17:52:14 +00:00
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,
2026-11-11 17:05:52 +00:00
chunking, normalization, validation budget, and debug
2026-11-10 17:52:14 +00:00
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
2026-11-16 15:12:06 +00:00
pipeline or contact a provider. Processing preflight separately checks the selected\nprofiles and glossary entries. Smoke tests can contact providers and are run
2026-11-10 17:52:14 +00:00
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
2026-11-16 14:18:38 +00:00
or input, and native comparison may return `3` for differences. A missing
processing profile or required glossary selection is an input failure. See the
2026-11-10 17:52:14 +00:00
[output contract ](integrations/output-files.md ) and [subprocess contract ](integrations/subprocess.md ).