Document shared loading and integration upgrades
This commit is contained in:
@@ -6,8 +6,8 @@ in-memory model client. **No model service or credentials are required.**
|
||||
|
||||
Use Go 1.27.0 on `PATH`. An aligned workspace containing all three local modules
|
||||
exercises their current sources; follow the [workspace setup](../../../../docs/development.md#documentation-validation)
|
||||
from the repository root. The example also builds independently with
|
||||
`GOWORK=off` against its module's released dependencies.
|
||||
from the repository root. The current checkout requires the local ckconfig API;
|
||||
its published v0.9.0 dependency does not yet provide that API.
|
||||
The [consumer guide](../../../../docs/consumers/guide.md#module-selection) owns
|
||||
version and compatibility details.
|
||||
|
||||
@@ -21,7 +21,7 @@ go run . promptkit list prompts --campaign spring
|
||||
go run . promptkit show prompt briefing --campaign spring --format yaml
|
||||
```
|
||||
|
||||
The first command lists `app` and `promptkit` configurations and their available
|
||||
The first command lists `app`, `storage`, and `promptkit` configurations and their available
|
||||
operations. The next commands find and inspect the `briefing` prompt.
|
||||
`--campaign` is a selector supplied by this example, not a standard PromptKit flag.
|
||||
|
||||
@@ -30,6 +30,8 @@ operations. The next commands find and inspect the `briefing` prompt.
|
||||
```sh
|
||||
go run . config validate --scope all --campaign spring --limit=0
|
||||
go run . config diff --scope app --config fixtures/before.yml --against-config fixtures/after.yml
|
||||
go run . config show --scope storage --config fixtures/before.yml
|
||||
go run . config diff --scope storage --config fixtures/before.yml --against-config fixtures/after.yml
|
||||
go run . config diff --scope promptkit --config fixtures/before.yml --against-config fixtures/after.yml --campaign spring --against-campaign spring
|
||||
```
|
||||
|
||||
@@ -44,8 +46,8 @@ The two sides have independent selectors and overrides:
|
||||
go run . config diff --scope app --campaign spring --limit=0 --against-campaign autumn --against-limit=0 --set '/campaigns/spring/model="left"' --against-set '/campaigns/spring/model="right"' --details
|
||||
```
|
||||
|
||||
Only the application scope supports `--set` here. The released PromptKit loader
|
||||
has no override handoff, so its configuration scope does not enable the feature.
|
||||
The application and storage scopes support `--set` here. The PromptKit scope
|
||||
does not advertise override support in this example.
|
||||
An aggregate operation that includes that scope rejects overrides.
|
||||
|
||||
## List resources and select namespaces
|
||||
@@ -155,7 +157,9 @@ selects the command context without loading an engine.
|
||||
The example installs `ckconfig.Command(suite)` and
|
||||
`ckprompt.Declarations(definitions)` with application-owned aliases in a
|
||||
`[]commandkit.Declaration`. `NewInput` initializes scope inputs; `NewState`
|
||||
creates a cache shared within an invocation. The loaders cache successful
|
||||
creates a cache shared within an invocation. The application composes PromptKit
|
||||
settings and resources into its ConfigKit load; the engine consumes the same
|
||||
result, and `FromConfigKitSubtree` exposes `storage`. The loaders cache successful
|
||||
configuration results by the complete configuration/overlay selection,
|
||||
overrides, and supplied campaign, including whether each value was supplied.
|
||||
These are example choices, not a CommandKit cache policy.
|
||||
@@ -167,5 +171,5 @@ for suite composition, builders, and ownership, and the [source](main.go) for
|
||||
the complete application.
|
||||
|
||||
Run `GOWORK=auto GOTOOLCHAIN=local go test ./...` from this example directory
|
||||
for an aligned workspace check. Use
|
||||
`GOWORK=off GOTOOLCHAIN=local go test ./...` to check the declared releases.
|
||||
for an aligned workspace check. Independent ckprompt validation against its
|
||||
declared requirements follows the coordinated ckconfig release.
|
||||
|
||||
Reference in New Issue
Block a user