Add scoped PromptKit configuration reports
This commit is contained in:
28
docs/cli.md
28
docs/cli.md
@@ -13,6 +13,8 @@ notarius help
|
||||
notarius --version
|
||||
notarius run <pipeline-id> --input path/to/source.json [--json] [flags]
|
||||
notarius config validate [--config path/to/config.yml] [--config-overlay name] [--pipeline pipeline-id] [--only lane-a,lane-b]
|
||||
notarius config effective [--scope notarius|promptkit] [--config path/to/config.yml] [--config-overlay name]
|
||||
notarius config explain [--scope notarius|promptkit] [--config path/to/config.yml] [--config-overlay name] <json-pointer>
|
||||
notarius pipelines list [--config path/to/config.yml] [--config-overlay name] [--json]
|
||||
~~~
|
||||
|
||||
@@ -188,8 +190,16 @@ notarius config effective [--config path/to/config.yml] [--config-overlay name]
|
||||
~~~
|
||||
|
||||
This command writes the selected composed configuration as deterministic,
|
||||
redacted YAML. Standard output contains only that YAML: it does not validate a
|
||||
pipeline, prepare modules, materialize references, or contact a provider.
|
||||
redacted YAML. By default, it reports the Notarius configuration. Set
|
||||
**--scope promptkit** to report PromptKit's captured effective configuration;
|
||||
**--scope notarius** is equivalent to the default. Only the PromptKit scope
|
||||
constructs the PromptKit inspection engine, using the selected configuration
|
||||
and registered application assets. Engine construction validates and captures
|
||||
the definitions. Standard output contains only the selected report: the
|
||||
command does not validate a pipeline, prepare modules, materialize references,
|
||||
resolve credentials, or contact a provider. PromptKit output can include
|
||||
ordinary inline prompt and provider-parameter data; credential-shaped provider
|
||||
parameters are redacted.
|
||||
|
||||
## config explain
|
||||
|
||||
@@ -197,11 +207,15 @@ pipeline, prepare modules, materialize references, or contact a provider.
|
||||
notarius config explain [--config path/to/config.yml] [--config-overlay name] <json-pointer>
|
||||
~~~
|
||||
|
||||
This command writes ConfigKit's redacted, human-readable explanation for one
|
||||
canonical JSON Pointer. Supply `""` explicitly to explain the root. A malformed
|
||||
pointer is a syntax error; a well-formed unknown path is a command failure.
|
||||
The explanation can describe a value displaced by a selected overlay. Standard
|
||||
output contains only the explanation.
|
||||
This command writes a redacted, human-readable explanation for one canonical
|
||||
JSON Pointer. Supply `""` explicitly to explain the root. By default, it
|
||||
explains Notarius configuration; **--scope promptkit** selects PromptKit
|
||||
configuration history, while **--scope notarius** is equivalent to the default.
|
||||
A malformed pointer is a syntax error; a well-formed unknown path is a command
|
||||
failure. The explanation can describe values displaced by source overlays or
|
||||
imports. Standard output contains only the selected explanation. PromptKit
|
||||
scope constructs and validates its captured definitions, and its report can
|
||||
include ordinary inline prompt and provider-parameter data.
|
||||
|
||||
## pipelines list
|
||||
|
||||
|
||||
Reference in New Issue
Block a user