base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reconcile module docs and release materials

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-11 02:06:06 +00:00
parent 18e81a5579
commit d2b5b0f3a8
45 changed files with 2380 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/cli.md
View File

@@ -85,9 +85,12 @@ constructing application command inputs.
## Configuration scopes
An application installs one configuration suite with `RegisterConfig`. Its
An application installs the declaration returned by
`ckconfig.Command(ckconfig.Suite[Input, State]{...})` through
`commandkit.New` or `App.Register`. For the common single application scope,
`ckconfig.AppCommand` returns a convenience declaration. The installed
`config scopes` command lists scope names and the configuration operations
currently installed for those scopes:
currently available for those scopes:
```text
example config scopes
@@ -102,10 +105,9 @@ runtime context or acquire configuration. It reports the intersection between
declared scope capabilities and installed handlers, so an operation is listed
only when the corresponding command is available.
Applications can register the `promptkit` scope with `NewPromptKitScope` to
expose PromptKit engine configuration through these handlers. This configuration
scope can be installed without registering PromptKit prompt or profile
definition commands.
Applications can add `ckprompt.ConfigScope(loadEngine)` to the ConfigKit suite
to expose PromptKit engine configuration through these handlers. This scope
does not install PromptKit prompt or profile definition commands.
### Validate configuration
@@ -231,12 +233,12 @@ serialized as `[]`.
## PromptKit definition inspection
Applications can install prompt and profile inspection independently with
`RegisterPromptKit`. When acquisition is reached, the handler invokes its
registered inspection callback once with the caller's selection and context.
The bundled `NewPromptKitSuite` helper acquires an engine through the application
loader and asks PromptKit to inspect its captured named definition. The loader
can construct or reuse an engine; direct suite callbacks retain their own
implementation and lifecycle.
`ckprompt.Command(suite)`, passing the resulting declaration to core. The
`ckprompt.FromEngine(loadEngine)` adapter supplies callbacks that acquire an
engine only after input checks pass and inspection is reached. The loader
receives invocation context, selection, input, and state; its implementation
controls whether an engine is constructed or reused. Direct suite callbacks
retain their own implementation and lifecycle.
CommandKit's inspection path does not execute prompts, contact model providers,
or resolve provider credential values. Application acquisition and direct