commandkit/docs/roadmap/configkit-v1.1.0.md

ConfigKit v1.1.0 adoption

Status: proposed; dependency and report changes are not implemented. This roadmap covers the embedded ckconfig integration, the API coverage review, and recommended extensions. Release coordination and capability scope have recommendations under Open Decisions.

Purpose and authority

Adopt go.maximumdirect.net/configkit v1.1.0 and expose its capabilities through CommandKit's existing configuration commands in a neutral, consistent way. ConfigKit owns configuration loading, composition, resolution, inspection, and their semantics. CommandKit owns command selection, coordination, presentation, and invocation outcomes. Adapt upstream capabilities faithfully, using current upstream terminology, without adding independent guarantees or commentary qualifying upstream limitations.

This follows the clarified integration goal and the existing architecture policy. The agent, testing, documentation, release, and OSS policies govern implementation. This roadmap proposes work; current contracts remain in GoDoc, the CLI reference, and the consumer guide until implementation lands.

Current baseline and review evidence

Initial review revision: 60841227b7e2928d3fefd3326f0e3f4694f41e6d. API coverage follow-up revision: 7a9e3a1f7cdd0475f06a63ce0aababefe08651bc; library code and module selections are unchanged between these revisions. The completed dependency alignment roadmap records the preceding vanity migration and releases.

Component	Current selection
Core	go.maximumdirect.net/commandkit v0.3.0; Go 1.26.0 minimum
ckconfig	go.maximumdirect.net/ckconfig v0.2.0; Go 1.26.0 minimum
ckconfig dependencies	Core v0.3.0, gitea.maximumdirect.net/eric/ConfigKit v0.8.0, YAML v4.0.0-rc.6
ckprompt	v0.2.0; ckconfig v0.2.0, old-path ConfigKit v0.8.0 and PromptKit v0.16.0; Go 1.26.0 minimum
Maintainer release toolchain	Go 1.26.8, with GOTOOLCHAIN=local

The ConfigKit vanity endpoint and direct Go module discovery resolve v1.1.0 to published commit 191015e289d7f2b91abb9fdd9c4f2f5cf75b4de9. Its module declares Go 1.27.0 and retains the YAML dependency and LGPL-3.0-or-later library grant. The upstream v1.0 migration notes and v1.1 release notes describe the adopted API and behavior changes. Upgrading from v0.8.0 also crosses the import, collection, CLI-assignment, and discovery changes documented in the v0.9 notes and v0.10 notes.

A disposable ckconfig copy passed its complete module suite and maintained simple example tests on Go 1.27.0 after changing the dependency/import path, minimum, two source-reader fields, and affected test APIs. This establishes that the existing adapter structure remains suitable. It did not exercise the proposed report-field renames, additional source evidence, or a migrated ckprompt; final implementation still needs validation of those selected changes.

API coverage findings

The follow-up compared the public API of the pinned v1.1.0 module with ckconfig's provider facets, adapters, and report projections. These are gaps in current integration coverage, not necessarily APIs newly introduced in v1.1.0.

Capability	Current ckconfig exposure	Recommendation
SourceInfo.EmptyImportSelections	Omitted from the source report.	Include in adoption; OD-2.
Result.Metadata(), Metadata.Lookup, and IsExplicit	No metadata facet in View; explanation reports do not expose explicit input presence.	Prioritize optional field-metadata inspection as the next functional expansion; OD-3.
Metadata.HistoricalPaths and History	Operators must already know a path to request an explanation; metadata history records are not exposed.	Pair path discovery and provenance history with metadata inspection; OD-3.
LoadError.Sources() and Source(id)	Acquired sources support diagnostic context, but config sources returns before reporting an inventory on acquisition failure.	Consider failed-load source inspection separately; OD-4.
Full Difference records	The Go comparison provider returns native records; the CLI reduces them to additions, right-side changes, and deletion paths.	Consider an additional detailed comparison report; OD-5.
Structured Diagnostic records	Native writers present diagnostic content; there is no structured native diagnostic report.	Lower-priority candidate, coordinated with shared reporting; OD-6.

The upstream metadata API, source and diagnostic records, load-error API, and comparison API own the returned evidence and its semantics.

The current explanation projection covers every field of v1.1.0's Explanation: effective and historical snapshots, origin and inheritance, reasons, dependencies, and secret-reference names. Improved list-history behavior can flow through that existing adapter. Metadata queries add distinct information: explicitness and null state from FieldInfo, observed paths including removed ones, and Change records with previous origins and operation paths. They need not replace the value-oriented explanation report.

Result.Source(id) is a convenient lookup of records already available through the source inventory. A source-ID filter is a possible usability refinement; it does not inherently require another command or a required lookup method on every custom source provider. Discovery, import defaults, collection identities, and field-level resolution recording fit the application-supplied loader. Source resource contexts and explicit secrets-directory bootstrap primarily serve application loading and startup; there is no immediate recommendation to add standard inspection operations for them. A consumer need could motivate later presentation of their upstream results.

Targeted end state

Dependency and toolchain

The ckconfig module requires go.maximumdirect.net/configkit v1.1.0, and its production code, tests, and maintained example use that import identity. Raise its consumer minimum to Go 1.27.0. Retain its core v0.3.0 requirement unless implementation identifies a concrete need for a newer core API. Core remains independent of ConfigKit and retains its own Go minimum.

Use a Go 1.27 toolchain for ckconfig dependency preparation and validation. Update the maintainer procedure to select an available Go 1.27 release and distinguish the per-module consumer minimums. The existing host-native, workspace-off launcher can use that toolchain without a new toolchain-selection mechanism.

Faithful adaptation and reports

Retain the existing scope, loader, comparison, diagnostic, and reporting structure. Continue using ConfigKit's public results, native rendering, and diff APIs rather than reproducing its domain logic locally. New collection, discovery, and resolution features can be used by application loaders through the adopted library; they do not inherently require additional CLI flags or CommandKit-owned loading policy.

Align the existing source report with ConfigKit's current vocabulary:

Current API or report spelling	Target
SourceInfo.DestinationUnresolved	SourceInfo.DestinationIsFallback
SourceInfo.VersionCheck / SourceVersionCheck	SourceInfo.VersionEvidence / SourceVersionEvidence
Text/YAML destination_unresolved	destination_is_fallback
Text/YAML version_check	version_evidence
Native main layer value base	Native main layer value main

Update DTOs and both report formats together. Preserve the upstream evidence and its supported presence, null, location, ordering, and redaction information through adaptation. Use the upstream terms directly in help and documentation; link to the owning inspection contract for their semantics. Describe the report migration plainly in the release note. The target uses the new field names without duplicate legacy report fields.

ConfigKit's source inventory also supplies EmptyImportSelections, with declaration path, location, and selector. OD-2 addresses including this evidence in the existing source report; it is not yet a selected report-schema addition.

Recommended inspection expansion

After the dependency and source-report adoption, prioritize an optional metadata capability for field inspection, path discovery, and provenance history. A narrow provider facet could expose ConfigKit's public Metadata value directly. FromConfigKit can supply it from the loaded result; custom scopes can declare the operations for which they provide the capability. This is a proposed extension, not a new requirement on existing providers.

Use upstream Lookup and IsExplicit for effective field metadata, HistoricalPaths for observed-path enumeration, and History for definition, inheritance, and resolution records. HistoricalPaths includes effective and removed paths; it is not simply a list of current fields. Scope the report to the returned upstream evidence rather than inferring an independent provenance model. Command names, selectors, and report shapes need a focused design once this extension is selected; this roadmap does not establish their grammar.

Field-origin inventories are currently among the deferred proposals. OD-3 proposes reconsidering that scope based on the reviewed public API. If selected, update that record and the owning CLI/API documentation with implementation. Retaining the proposal here does not by itself mark the extension accepted or implemented.

Failed-load source inspection, detailed comparison reports, and structured diagnostics remain separately considered additions under OD-4 through OD-6. They use existing upstream evidence, but each changes CommandKit's presentation or outcome coordination and needs its own scope choice. In particular, source inventory output on an acquisition error would retain the failed outcome; additional comparison detail would expose the native left/right snapshots, presence/redaction fields, and HiddenChanged already returned to the provider.

Consumer migration and module coordination

Public ckconfig signatures expose ConfigKit types, so switching import identity requires consumers to migrate the ConfigKit values they pass across those boundaries. Use the adopted upstream API names in maintained consumers and fixtures. Known test changes include Definition.Secret to Sensitive and Resolution.Record(..., ChangeNormalization, ...) to RecordNormalization. Review other removed pre-v1 symbols where actually used.

Migration guidance should link to upstream for source-root configkit controls becoming config, optional becoming required with changed defaults, identified-collection registrations and operations, and CLI-assignment ordering. Change affected maintained fixtures when present. Application configuration and validation choices remain application-owned; CommandKit does not introduce a compatibility loader or impose new configuration restrictions.

ckprompt's current ConfigKit types come from the old package identity. It cannot simply select the new ckconfig release while retaining that wiring. Its later adoption needs a coordinated ConfigKit/PromptKit migration and review of its own adapters and composed example. OD-1 determines scheduling; this roadmap does not select an unreviewed PromptKit release or claim a new matched integration set.

Work from the baseline

1. Confirm scope choices and prepare module metadata. Resolve OD-1 and OD-2 and record which proposed extensions, if any, join the adoption release. Deferred extensions need not block the dependency migration. Select the Go 1.27 maintainer toolchain, update ckconfig's requirement, imports, and minimum, and regenerate authentic sums with workspace discovery off. Inspect the resulting dependency graph; do not commit local replacements or environment files as an adoption mechanism.
2. Adapt APIs and source reports. Update the native source field accesses, DTOs, text/YAML output, affected tests, and example code. Apply the selected empty-import-evidence choice. Preserve current coordination and outcomes except where an explicitly selected extension changes presentation, such as retaining a failure alongside returned source evidence. Adapt upstream results rather than adding domain validation.
3. Design and implement selected extensions. Treat metadata inspection and path discovery as the next functional work item under OD-3, whether included here or scheduled next. Define its optional provider capability, CLI usage, and report projection together. For any OD-4 through OD-6 feature selected, specify its report delivery and outcome behavior before implementation. Reuse native records and rendering where suitable; avoid a second domain implementation or a generic framework solely to mirror upstream APIs.
4. Update canonical documentation and notices. Revise the ckconfig README and GoDoc, CLI source-report reference, consumer guide, and release toolchain instructions with the implemented changes. Review the selected graph and upstream notices, then update ckconfig attribution with the vanity identity, selected versions, and pinned source links. Update other module notices only when their actual selections change. Preserve published release history.
5. Validate the selected end state. Run the ckconfig suite, including its maintained example, independently with GOWORK=off and read-only module metadata on the selected Go 1.27 toolchain. Update focused adapter/report assertions for the new vocabulary and faithful projection of returned evidence. Preserve coverage of request forwarding, diagnostics, cancellation, output failures, and supported error identity. Assertions establish CommandKit adaptation; ConfigKit owns tests of its domain correctness. For selected metadata capabilities, verify query forwarding and returned field/history projection. For failed-load inventory or detailed comparison, verify the selected report and outcome coordination without re-establishing upstream acquisition, provenance matching, or sensitivity behavior. Review changed Markdown links, fragments, and examples. If coordinated ckprompt work is selected, also validate that module and the composed consumer against the proposed dependency set; local-workspace success alone does not establish independent module compatibility.
6. Prepare the integration release. Propose ckconfig v0.3.0, subject to the existing fresh-version guards, with tag integrations/ckconfig/v0.3.0. Explain changed ConfigKit type identity, Go minimum, report fields, and consumer migration in its checked-in note with the usual licensing footer. A pre-v1 minor fits these intentional compatibility changes. Use the existing selected-module release procedure when publication is requested; this plan adds no release gate. Source publication and hosted Gitea delivery retain their separate outcomes.

Completion evidence

Implementation is complete when ckconfig's actual module metadata and imports select the new dependency, the selected report changes faithfully expose its returned evidence, the module suite and maintained consumer pass independently, and current documentation, notices, and release preparation describe that state. Record resolved scope choices, final validation evidence, and the status of each proposed extension. Features selected for this implementation need their own provider/report evidence; recording a deferred proposal does not demonstrate its implementation. A future source release is reported separately from implementation completion; preparing this roadmap does not publish a version or migrate external applications.

Open Decisions

OD-1: Release ckconfig first or coordinate both integrations?

Recommendation: implement and release ckconfig independently first, and review ckprompt's upstream migration as the next integration task. This keeps the current scope concrete and uses the established independent module releases. Existing ckprompt v0.2.0 consumers retain their published dependency set; document that moving them to the new ckconfig needs the corresponding ckprompt migration. The tradeoff is an interval with no newly aligned release pair.

Viable alternative: complete the ConfigKit/PromptKit review and both integration migrations before releasing the next pair, publishing ckconfig first in dependency order. This gives composed consumers a coordinated adoption path and validates the shared type boundaries together. It expands this work into PromptKit adoption and delays ckconfig availability while that review and implementation proceed. No simultaneous tag publication is needed.

OD-2: Include empty-import-selection evidence in this adoption?

Recommendation: add empty_import_selections to the existing text/YAML source report, projecting ConfigKit's declaration path, location, selector, and record order. This exposes structured source evidence already available upstream without a new command or a second explanation engine. It adds report mapping and focused projection coverage alongside the other schema changes; the exact empty-list presentation should be settled with the implemented report.

Viable alternative: limit this release to migrating the evidence already reported, and defer this additive field to a later inspection enhancement. That reduces the immediate report change and test scope, and still makes the native metadata available to Go consumers of ConfigKit. CLI consumers would continue to lack this upstream evidence, and a later release would need another report and documentation update.

OD-3: When and how should metadata inspection and path discovery land?

Recommendation: make optional metadata inspection and path discovery the next functional expansion after adoption. Expose the upstream metadata queries through an optional facet, and design field and history reports together. This adds explicitness, path discovery, and provenance information that current explanations do not fully expose, while keeping existing providers usable. It requires a focused CLI/API design and a later release if staged separately.

Viable alternative: include that coherent expansion in the adoption release. This gives consumers the broader inspection surface with one migration and documentation update. It increases the current release's API, report, and validation scope and can delay the dependency upgrade. Either schedule can use the same upstream-owned query semantics; final command grammar remains a design choice rather than a contract selected by this roadmap.

OD-4: Expose acquired sources when a configuration load fails?

Recommendation: evaluate this as a separate source-inspection enhancement, presenting LoadError's returned inventory while retaining the load failure and diagnostics. It makes upstream acquisition evidence available for troubleshooting without treating the operation as successful. The design must account for returning the source facet on error and delivering a report before terminal failure presentation; that coordination is additional to mechanical adoption.

Viable alternative: include this behavior in the adoption release alongside the source-report changes. It delivers successful and failed-load inventory inspection together and avoids another source-report release. It broadens the current adapter and outcome changes and requires focused coverage of report delivery failures as well as acquisition failure. Retaining current diagnostic context alone until that work is selected remains viable.

OD-5: Add a detailed native comparison report?

Recommendation: consider an additional report form in a later comparison enhancement, retaining the current reduced form for its established operator use. The detailed form would project Path, both snapshots, and HiddenChanged from native records, making already-returned evidence available to CLI consumers. Supporting two forms adds selection, presentation, and documentation work; choose the interface when the feature is selected.

Viable alternative: replace the reduced report with native-record projection in a pre-v1 minor release. One report form is simpler to maintain and exposes all current comparison fields directly. It requires deliberate migration of published report consumers and changes the concise additions/changes/deletions workflow. Keeping only the current form is also viable when that workflow meets consumer needs; richer reporting is a capability proposal, not a correctness fix.

OD-6: Where should structured diagnostic reporting be introduced?

Recommendation: retain native diagnostic rendering for this adoption and consider structured records with CommandKit's shared reporting design. That keeps result and diagnostic delivery consistent across integrations and custom commands. It defers machine-readable native codes, paths, severities, and locations until their report channel and outcome behavior are designed.

Viable alternative: add an optional ckconfig-specific diagnostic report that projects ConfigKit's records directly. This could deliver useful structured evidence sooner without redesigning the shared reporting API. It introduces a separate presentation path whose interaction with ordinary results, warnings, and terminal failures needs definition and may later need alignment with other families. It is a lower-priority extension rather than a dependency-adoption requirement.