42 lines
2.1 KiB
Markdown
42 lines
2.1 KiB
Markdown
# CommandKit ckprompt
|
|
|
|
`ckprompt` is the optional PromptKit integration for CommandKit. It adapts
|
|
PromptKit engine configuration, native comparison, five catalogs, named
|
|
inspection, requirements discovery and validation, and native smoke tests.
|
|
Importing it does not install either command family.
|
|
|
|
## Module
|
|
|
|
The module path is
|
|
`gitea.maximumdirect.net/eric/CommandKit/integrations/ckprompt`. Its first
|
|
release is prepared as `v0.1.0`. It uses `commandkit`, `ckconfig`, and
|
|
PromptKit. See the
|
|
[consumer guide](https://gitea.maximumdirect.net/eric/CommandKit/src/branch/main/docs/consumers/guide.md#promptkit-configuration-and-definitions)
|
|
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
|
|
and native comparison in the `config` family. Install
|
|
`ckprompt.Command(ckprompt.FromEngine(loadEngine))` separately for catalogs,
|
|
named inspections, and requirements discovery. `FromEngine` supplies eight
|
|
PromptKit-backed callbacks: three inspections and five catalogs. Applications
|
|
may narrow, wrap, or replace them before capture or provide custom callbacks
|
|
with `ckprompt.Suite`. Add concrete request validation and smoke testing
|
|
explicitly with `WithRequestValidation` and `WithSmokeTesting`. Inspection,
|
|
requirements, and catalog operations do not execute prompts or contact model
|
|
providers; application loaders and callbacks retain their own effects. Smoke
|
|
testing invokes the selected native PromptKit operation; the
|
|
application retains ownership of client and configuration choices. See the
|
|
[CLI reference](https://gitea.maximumdirect.net/eric/CommandKit/src/branch/main/docs/cli.md#promptkit-smoke-testing)
|
|
for operator commands and report semantics. The maintained
|
|
[composed example](examples/composed) shows complete application wiring.
|
|
|
|
## License and attribution
|
|
|
|
This module is licensed under the [GNU Lesser General Public License v3.0 or
|
|
later](COPYRIGHT). The accompanying [LICENSE](LICENSE) contains the full LGPL
|
|
v3 and GPL v3 texts. See [third-party attribution](docs/oss/attribution.md)
|
|
for incorporated and dependency notices.
|