Clarify definition inspection loading
This commit is contained in:
22
docs/cli.md
22
docs/cli.md
@@ -207,9 +207,19 @@ scriptorium inspect prompt --prompt ID [--prompt-version VERSION]
|
||||
|
||||
`--prompt` is required. Inspection uses normal configuration discovery and the
|
||||
selected Promptkit sources, defaults to text regardless of
|
||||
`defaults.render_format`, and writes to stdout unless `--out` is supplied. It
|
||||
loads and normalizes the selected definition but does not resolve a profile,
|
||||
load a schema, render a template, reserve backend capacity, or call a model.
|
||||
`defaults.render_format`, and writes to stdout unless `--out` is supplied.
|
||||
|
||||
Both definition-inspection commands first construct the same engine used for
|
||||
execution from the complete selected source sequence. Construction resolves
|
||||
and validates all effective definitions, including unused ones, and captures
|
||||
referenced message-file contents and static template syntax. Invalid unused
|
||||
definitions or unreadable message resources can therefore prevent inspection.
|
||||
No prompt collection is mandatory, but selected prompts are not ignored.
|
||||
|
||||
Inspection does not prepare an execution request, load request-time schemas or
|
||||
artifacts, resolve credential values, reserve backend capacity, or call a model.
|
||||
Prompt inspection does not select an execution profile or render request-specific
|
||||
templates.
|
||||
|
||||
## `scriptorium inspect profile`
|
||||
|
||||
@@ -218,9 +228,9 @@ scriptorium inspect profile --profile ID
|
||||
[--config PATH] [--config-overlay NAME] [--promptkit-source PATH ...] [--schema-dir DIR] [--format text|json] [--out PATH]
|
||||
```
|
||||
|
||||
`--profile` is required. Inspection resolves profile inheritance and backend
|
||||
defaults from the selected sources, but never reads a credential value, loads
|
||||
a prompt, reserves capacity, or calls a model. Unset provider controls are
|
||||
`--profile` is required. After the [full-source engine construction described
|
||||
above](#scriptorium-inspect-prompt), inspection selects one effective profile
|
||||
with resolved inheritance and backend defaults. Unset provider controls are
|
||||
shown as zero values when Promptkit leaves them unspecified.
|
||||
|
||||
## Application configuration inspection
|
||||
|
||||
Reference in New Issue
Block a user