60 lines
3.6 KiB
Markdown
60 lines
3.6 KiB
Markdown
# CommandKit ckprompt v0.1.0
|
|
|
|
## Summary
|
|
|
|
The initial independently versioned PromptKit integration exposes native
|
|
configuration inspection and comparison, definition inspection, requirements,
|
|
catalogs, and smoke testing. This source-only Go module uses CommandKit v0.2.0,
|
|
ckconfig v0.1.0, PromptKit v0.16.0, and ConfigKit v0.8.0.
|
|
|
|
## Features
|
|
|
|
- `ckprompt.ConfigScope` exposes PromptKit engine configuration and native
|
|
comparison through the `config` family, including `config diff --scope promptkit`.
|
|
- `ckprompt.Command` installs independently optional capabilities. `FromEngine`
|
|
supplies named prompt/profile inspection, requirements discovery, and five
|
|
catalogs: prompts, profiles, backends, namespaces, and collections.
|
|
- `promptkit list` reports native inventories as YAML, with namespace filters
|
|
for prompts, profiles, and backends, and kind filters for namespace discovery.
|
|
- `promptkit requirements show PROMPT_ID` reports PromptKit's native input and
|
|
variable requirements, completeness, and issues with optional caller context.
|
|
- Opt-in `WithRequestValidation` adds
|
|
`promptkit requirements validate PROMPT_ID`, forwarding variables and
|
|
file-backed inputs to PromptKit's native request preparation and returning a
|
|
YAML success confirmation.
|
|
- Opt-in `WithSmokeTesting` adds `promptkit test KIND`, exposing native
|
|
`reachability`, `authentication`, `text_inference`, and `structured_output`
|
|
checks. `promptkit test all` runs those checks sequentially, continues after
|
|
individual errors, stops on cancellation, and retains acquired reports and
|
|
operation errors. Native observations are projected into YAML without an
|
|
additional readiness classification.
|
|
- Validation and smoke adapters accept optional typed request builders;
|
|
applications retain configuration, client, and request-construction ownership.
|
|
|
|
## Requirements and adoption
|
|
|
|
**Go 1.26.0 or newer is required.** Add
|
|
`gitea.maximumdirect.net/eric/CommandKit/integrations/ckprompt@v0.1.0` and
|
|
explicitly install the desired declarations. Adding a PromptKit configuration
|
|
scope and installing the `promptkit` family remain separate choices. Request
|
|
validation and smoke testing each require explicit opt-in.
|
|
|
|
Applications migrating from CommandKit v0.1.0 must move to the separate
|
|
integration modules and update loader, callback, and installation wiring for
|
|
the captured declaration API. Align engine loading and fixtures with PromptKit
|
|
v0.16.0's direct prompt definitions and collection configuration.
|
|
|
|
Prompt selection now uses an ID only: remove `--version` from prompt inspection
|
|
invocations. YAML prompt inspection uses optional `version` in place of
|
|
`prompt_version`; update report consumers accordingly. Prompt and collection
|
|
catalogs also report optional descriptive versions, omitting the field when
|
|
absent. PromptKit owns selection, requirements, validation, and smoke semantics.
|
|
|
|
See the [module README](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/integrations/ckprompt/README.md),
|
|
[consumer guide](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/docs/consumers/guide.md),
|
|
and [CLI reference](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/docs/cli.md).
|
|
|
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/integrations/ckprompt/COPYRIGHT) |
|
|
[LICENSE](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/integrations/ckprompt/LICENSE) |
|
|
[ATTRIBUTION](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/integrations/ckprompt/docs/oss/attribution.md)
|