37 lines
1.8 KiB
Markdown
37 lines
1.8 KiB
Markdown
# 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.
|
|
|
|
## 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 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
|
|
[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
|
|
[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.
|