Add resolved PromptKit profile inspection
This commit is contained in:
35
docs/cli.md
35
docs/cli.md
@@ -15,6 +15,7 @@ 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 config profile [--config path/to/config.yml] [--config-overlay name] <profile-id>
|
||||
notarius pipelines list [--config path/to/config.yml] [--config-overlay name] [--json]
|
||||
~~~
|
||||
|
||||
@@ -217,6 +218,40 @@ 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.
|
||||
|
||||
## config profile
|
||||
|
||||
~~~
|
||||
notarius config profile [--config path/to/config.yml] [--config-overlay name] <profile-id>
|
||||
~~~
|
||||
|
||||
This command inspects one exact, nonblank PromptKit profile ID and writes one
|
||||
JSON object followed by a newline:
|
||||
|
||||
The following illustrates the JSON shape; field values vary with the selected
|
||||
profile and its configured backend.
|
||||
|
||||
~~~json
|
||||
{"profile_id":"example","api_key_required":true,"effective_model_params":{"backend_id":"openrouter","endpoint":"https://provider.example/v1","model":"example-model","temperature":0,"max_tokens":0,"top_p":0,"timeout_seconds":600,"service_tier":"","reasoning_effort":"","api_key_env":"PROVIDER_API_KEY","extra_params":null}}
|
||||
~~~
|
||||
|
||||
The object reports the resolved target, including backend-completed endpoint
|
||||
and credential-name settings. An empty **backend_id** identifies an
|
||||
endpoint-only profile. Credential names and **api_key_required** are configured
|
||||
metadata; the command does not look up credential values or report whether an
|
||||
environment variable is set. Credential-shaped keys in **extra_params** are
|
||||
redacted.
|
||||
|
||||
This is the named profile's configured target, not a prediction of provider
|
||||
defaults or the profile selected by an individual request. A request may omit
|
||||
its profile and let its prompt select a default, and a run may supply a profile
|
||||
override; this command applies neither behavior. Zero-valued fields show the
|
||||
effective value but do not distinguish omission from an explicit zero. Use
|
||||
[effective configuration](#config-effective) and
|
||||
[configuration explanation](#config-explain) to inspect source presence and
|
||||
history. Profile/configuration failures use exit status 1; malformed command
|
||||
syntax, a blank ID, or an incorrect argument count use exit status 2. No
|
||||
transcript or model call is involved.
|
||||
|
||||
## pipelines list
|
||||
|
||||
~~~
|
||||
|
||||
Reference in New Issue
Block a user