Document PromptKit comparison and catalogs
This commit is contained in:
@@ -1,9 +1,8 @@
|
||||
# CommandKit ckprompt
|
||||
|
||||
`ckprompt` is the optional PromptKit integration for CommandKit. It can adapt
|
||||
PromptKit engine configuration into a `ckconfig.Scope` and create core command
|
||||
declarations for named prompt and profile inspection. Importing it does not
|
||||
install either command family.
|
||||
`ckprompt` is the optional PromptKit integration for CommandKit. It adapts
|
||||
PromptKit engine configuration, native comparison, prompt/profile catalogs, and
|
||||
named inspection. Importing it does not install either command family.
|
||||
|
||||
## Module
|
||||
|
||||
@@ -17,15 +16,16 @@ for callback, input, state, and acquisition contracts.
|
||||
## Example
|
||||
|
||||
Add `ckprompt.ConfigScope(loadEngine)` to the scopes passed to
|
||||
`ckconfig.Command` when the application wants PromptKit engine configuration in
|
||||
the `config` family. Install `ckprompt.Command(ckprompt.FromEngine(loadEngine))`
|
||||
separately for named prompt and profile inspection. `FromEngine` supplies
|
||||
PromptKit-backed callbacks; applications may provide their own callbacks with
|
||||
`ckprompt.Suite`. CommandKit-owned inspection code does not execute prompts,
|
||||
contact model providers, or resolve credentials; application loaders and direct
|
||||
callbacks retain their own effects. See the
|
||||
`ckconfig.Command` when the application wants PromptKit engine configuration
|
||||
and native comparison in the `config` family. Install
|
||||
`ckprompt.Command(ckprompt.FromEngine(loadEngine))` separately for prompt/profile
|
||||
catalogs and named inspections. `FromEngine` supplies all four PromptKit-backed
|
||||
callbacks; applications may narrow them before capture or provide their own
|
||||
callbacks with `ckprompt.Suite`. CommandKit-owned inspection and listing code
|
||||
does not execute prompts or contact model providers; application loaders and
|
||||
direct callbacks retain their own effects. See the
|
||||
[CLI reference](https://gitea.maximumdirect.net/eric/CommandKit/src/branch/main/docs/cli.md#promptkit-definition-inspection)
|
||||
for the inspection boundary and report semantics. The maintained
|
||||
for operator commands and report semantics. The maintained
|
||||
[composed example](examples/composed) shows complete application wiring.
|
||||
|
||||
## License and attribution
|
||||
|
||||
Reference in New Issue
Block a user