Refresh operator documentation and CLI help
This commit is contained in:
@@ -1,27 +1,40 @@
|
||||
# CommandKit ckprompt v0.3.0
|
||||
|
||||
CommandKit ckprompt v0.3.0 adopts PromptKit v0.20.0 and ConfigKit v1.1.0,
|
||||
and requires CommandKit core v0.4.0, ckconfig v0.4.0, and Go 1.27.0.
|
||||
The integration uses shared core reporting for text, YAML, and JSON output.
|
||||
This unpublished candidate adds PromptKit v0.20.0 support, including request
|
||||
preview, namespace selection, and shared text, YAML, and JSON output. It uses
|
||||
ConfigKit v1.1.0 and requires Go 1.27.0.
|
||||
|
||||
Prompt, profile, and backend commands report PromptKit's native resource
|
||||
inspections. Applications may opt into prepared-request preview, concrete
|
||||
request validation, smoke testing, and namespace selectors independently.
|
||||
Reusable request flag collections support application-owned commands;
|
||||
`ckprompt.Declarations` installs the standard family with scoped aliases.
|
||||
Literal and file inputs retain their command-line order. Provider parameters
|
||||
can be supplied for preparation and applicable diagnostics.
|
||||
## Operator features
|
||||
|
||||
The PromptKit configuration scope exposes native metadata and load-failure
|
||||
evidence through ckconfig, including independent comparison selections,
|
||||
detailed differences, and validation findings. Smoke reports retain native
|
||||
evidence and operation failures separately from presentation failures.
|
||||
- Inspect prompts, profiles, and backends, and list available resources.
|
||||
- Preview rendered requests without calling the model, or validate that a
|
||||
request can be prepared with the supplied inputs.
|
||||
- Choose namespaces and override request settings for supported commands.
|
||||
- Run smoke tests and inspect their results, including incomplete or unsupported
|
||||
checks and reports returned alongside errors.
|
||||
- Inspect engine configuration through `config`, including detailed validation
|
||||
findings, source information after failed loads, and configuration comparisons.
|
||||
|
||||
This pre-1.0 release changes resource report shapes, input flags, formatting,
|
||||
and configuration comparison behavior. Applications should update declarations
|
||||
and report consumers to the current [CLI reference](../../../../docs/cli.md#promptkit-definition-inspection)
|
||||
and [consumer guide](../../../../docs/consumers/guide.md#promptkit-configuration-definitions-and-requirements).
|
||||
Applications continue to own engine construction, credentials, and execution.
|
||||
Applications choose which commands to enable. Reusable flag collections also
|
||||
let application commands offer the same request flags. `ckprompt.Declarations`
|
||||
adds the standard commands with their shorter flag aliases. Literal and file
|
||||
inputs keep their command-line order.
|
||||
|
||||
## Compatibility and preparation
|
||||
|
||||
This candidate changes resource report shapes, input flags, formatting, and
|
||||
configuration comparison behavior. Review the current
|
||||
[CLI reference](../../../../docs/cli.md#promptkit-definition-inspection) and
|
||||
[consumer guide](../../../../docs/consumers/guide.md#promptkit-configuration-definitions-and-requirements)
|
||||
when updating declarations or code that reads reports. Applications continue to
|
||||
own engine construction, credentials, and execution.
|
||||
|
||||
The current source requires `ckconfig.AdaptDiagnostics`, which is absent from
|
||||
its selected ckconfig v0.4.0 dependency. Before publication, complete
|
||||
[dependency alignment](../../../../docs/roadmap/future.md#pending-release-and-integration-work)
|
||||
and update this candidate's dependency guidance to the selected releases.
|
||||
The [module selection table](../../../../docs/consumers/guide.md#module-selection)
|
||||
distinguishes published combinations from the current workspace.
|
||||
|
||||
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.3.0/integrations/ckprompt/COPYRIGHT) |
|
||||
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.3.0/integrations/ckprompt/LICENSE) |
|
||||
|
||||
Reference in New Issue
Block a user