Assemble PromptKit profiles for offline configuration inspection
This commit is contained in:
27
docs/cli.md
27
docs/cli.md
@@ -1,8 +1,9 @@
|
||||
# Audita CLI Reference
|
||||
|
||||
The shared version-2 configuration parser is implemented for `process`, `config
|
||||
validate`, and `config print-effective`. Profile assembly and process execution are
|
||||
being reconnected in later work, so the CLI is not yet a usable assembled command.
|
||||
The shared version-2 configuration parser and offline profile inspection are
|
||||
implemented for `process`, `config validate`, and `config print-effective`.
|
||||
Process execution is being reconnected in later work, so the CLI is not yet a
|
||||
usable assembled command.
|
||||
The [configuration reference](config.md) owns fields, defaults, and validation.
|
||||
|
||||
## Commands and help
|
||||
@@ -51,10 +52,17 @@ shared LLM section. Legacy configuration environment overrides are ignored.
|
||||
|
||||
## Streams and exit status
|
||||
|
||||
`config validate` prints `config is valid` on success. `config print-effective`
|
||||
currently writes ConfigKit's redacted effective-settings YAML; selected-profile
|
||||
and provenance views are scheduled with profile assembly. The effective YAML is
|
||||
for inspection and is not guaranteed to be a reloadable input file.
|
||||
`config validate` loads settings and both selected PromptKit profiles offline,
|
||||
then prints `config is valid` on success. `config print-effective` accepts
|
||||
`--view settings|profiles|explain` and defaults to `settings`. Settings writes
|
||||
ConfigKit's redacted effective-settings YAML. Profiles writes an Audita-owned
|
||||
YAML summary of selected ID, backend, model, sampling controls, per-attempt
|
||||
timeout, service tier, and reasoning effort for each role. It omits credentials,
|
||||
endpoints, and arbitrary extra provider parameters. Explain writes a YAML
|
||||
sequence of field paths, source origins, and recorded derivations without
|
||||
resolved setting values. These views share the same settings and profile
|
||||
validation path as `process`. Unknown views are usage errors. The effective
|
||||
settings YAML is for inspection and is not guaranteed reloadable.
|
||||
|
||||
For `process`, `--output` writes the corrected transcript to a file and leaves
|
||||
stdout empty on success. Without it, stdout carries transcript JSON only on
|
||||
@@ -63,8 +71,9 @@ errors and diagnostic locations. A successful run can contain skipped correction
|
||||
or warnings; see the [report contract](integrations/output-files.md).
|
||||
|
||||
Exit codes are `0` for success, `1` for runtime or output failure, and `2` for
|
||||
usage or configuration input errors. Configuration commands never contact a
|
||||
provider merely to parse settings; profile validation is being connected next.
|
||||
usage or configuration input errors. Invalid settings and profiles return `2`;
|
||||
broken embedded assets and serialization or write failures return `1`.
|
||||
Configuration commands inspect profiles without contacting a provider.
|
||||
|
||||
See the [input files](integrations/transcript-glossary-files.md),
|
||||
[subprocess contract](integrations/subprocess.md), and
|
||||
|
||||
Reference in New Issue
Block a user