222 lines
13 KiB
Markdown
222 lines
13 KiB
Markdown
# Future work
|
|
|
|
Status: pending release and integration work, plus future capability proposals.
|
|
No delivery dates are selected here.
|
|
|
|
## Purpose and authority
|
|
|
|
Completed roadmaps, implementation plans, and review findings have been retired.
|
|
This document preserves unfinished work and unselected ideas under the
|
|
[release policy](../policy/release.md#release-documentation-and-preparation).
|
|
The completed PromptKit v0.18.0 adoption roadmap and implementation plan remain
|
|
available in the
|
|
[PromptKit retirement snapshot](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/540e2359d66d604a563df0be1c9fc961588f5b9c/docs/roadmap).
|
|
The completed ConfigKit adoption, reporting, dependency alignment, release-tooling,
|
|
and remediation records remain available at the
|
|
[retirement snapshot](https://forge.maximumdirect.net/base-layer/commandkit/src/commit/260256d722f52bc947103d078cb67a129f4cc9f1/docs/roadmap).
|
|
[Earlier retired records](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/6bc37e7ba64ca0920b4d0cc77039a18d4006b24e/docs/roadmap)
|
|
also remain in Git history. Completed records are not assignments to restart work.
|
|
|
|
Accepted [ADRs](../adr/) and the [architecture policy](../policy/architecture.md)
|
|
govern any future implementation. The [CLI reference](../cli.md), public GoDoc,
|
|
and [consumer guide](../consumers/guide.md) own implemented behavior. Retaining
|
|
an idea here does not select its syntax, API, priority, or delivery date.
|
|
|
|
## Pending release and integration work
|
|
|
|
### ckprompt release
|
|
|
|
The PromptKit v0.18.0 adoption is complete. The
|
|
[ckprompt v0.3.0 candidate](../../integrations/ckprompt/docs/releases/v0.3.0.md)
|
|
remains unpublished. Publication and hosted delivery remain separate operations
|
|
under the [release procedure](../release.md).
|
|
The published ckprompt v0.2.0 retains its earlier dependencies; see the
|
|
[consumer guide](../consumers/guide.md#module-selection) for module selection.
|
|
|
|
### PromptKit v0.20.0 adoption
|
|
|
|
The [PromptKit v0.20.0 roadmap](promptkit-v0.20.0.md) owns the agreed adoption,
|
|
the shared core reporting/input prerequisites, operator CLI additions for
|
|
PromptKit and ConfigKit, recorded decisions, and completion checklist. It targets
|
|
a clean alpha adoption without backward-compatibility provisions or consumer
|
|
migration guidance. Implementation has not started. Use released upstream
|
|
contracts only; do not inspect or monitor unreleased work in anticipation of
|
|
adoption.
|
|
|
|
## Future capability targets
|
|
|
|
### Comparison extensions
|
|
|
|
The [working roadmap](promptkit-v0.20.0.md#additional-configkit-operator-workflows)
|
|
owns independent comparison selections (OD-9), assertion outcomes (OD-10), and
|
|
optional detailed reports (OD-5). These accepted plans do not change currently
|
|
implemented behavior.
|
|
|
|
General collection-clearing support is deferred pending a concrete consumer need.
|
|
Revisit standardized syntax and binding support for explicitly replacing a
|
|
nonempty application-default selector collection with an empty collection.
|
|
This is separate from clearing configuration lists through OD-11's transient
|
|
overrides and does not reinstate comparison inheritance. No clearing grammar
|
|
or public helper API is selected.
|
|
|
|
### Configuration inspection extensions
|
|
|
|
The [working roadmap](promptkit-v0.20.0.md#shared-configuration-capabilities)
|
|
owns metadata/path discovery (OD-4), detailed comparison (OD-5), failed-load
|
|
evidence and aggregate validation (OD-6), focused inspection/filters (OD-8), and
|
|
transient overrides (OD-11). The six-command suite, selected output behavior,
|
|
and pass-through override policy are defined there. Implementation belongs in
|
|
`ckconfig`, with PromptKit exposing native evidence through its configuration
|
|
scope. Use the shared core reporting prerequisite and thin projections;
|
|
presentation refinements should follow implementation and beta feedback.
|
|
All numbered decisions are settled; exact APIs and wiring remain implementation
|
|
work. Persistent configuration editing remains deferred.
|
|
|
|
Discovery, import defaults, collection identities, and field-level resolution
|
|
recording remain available through application loaders. Discovery tracing,
|
|
resource-context inspection, and secrets-directory bootstrap commands remain
|
|
deferred. Acquired source records do not provide a complete trace of rejected
|
|
discovery candidates; bootstrap and resource contexts primarily serve
|
|
application loading and startup.
|
|
|
|
### PromptKit inspection and selection extensions
|
|
|
|
The [PromptKit v0.20.0 roadmap](promptkit-v0.20.0.md#targeted-end-state)
|
|
owns native prompt/profile/backend resource inspection, concrete request preview,
|
|
applicable request flags, namespace selection, and the shared configuration
|
|
inspection extensions. The [resource inspection plan](promptkit-v0.20.0.md#resource-inspection)
|
|
includes backend inspection through the released upstream API. Execution flags
|
|
will be public reusable `ckprompt` collections for standard and application-owned
|
|
CLI commands, composed through existing core bindings.
|
|
[Roadmap OD-2](promptkit-v0.20.0.md#od-2-request-controls-and-provider-parameter-grammar)
|
|
records the agreed canonical naming, scoped convenience aliases, integration
|
|
installation collection, selected text/file input forms, and CLI JSON number
|
|
policy. Numeric conversion uses ordinary Go types and a small internal helper
|
|
with policy comments, behind a narrow public core CLI JSON parser. Collections
|
|
and aliases use existing declarations; cross-flag text/file precedence uses the
|
|
roadmap's ordered typed input prerequisite.
|
|
Output-contract overrides and appended-message flags are deferred below.
|
|
These are CLI features; general-purpose helpers for
|
|
application-internal PromptKit use are outside CommandKit's ownership boundary.
|
|
|
|
[Roadmap OD-3](promptkit-v0.20.0.md#od-3-namespace-flags-and-loader-defaults)
|
|
records the agreed namespace-selector applicability, including the limited role
|
|
of profile selection in requirements inspection. That selection follows the
|
|
released upstream identity requirement; it does not change prompt dependencies.
|
|
|
|
- **Output-contract override flags.** Deferred from the current adoption. A
|
|
possible future operator task is validating or previewing one prompt with a
|
|
replacement output contract without editing its definition. PromptKit uses
|
|
whole-contract replacement; a complete-contract file option was discussed,
|
|
but no flag spelling or file format is selected. Existing configuration and
|
|
application builders remain available. Revisit when the standard `promptkit`
|
|
commands have a demonstrated need for this workflow.
|
|
|
|
- **Appended-message flags.** Deferred from the current adoption. The potential
|
|
operator task is reproducing a single request with application-added messages
|
|
through `promptkit show prepared` or `promptkit requirements validate`, to
|
|
inspect roles, ordering, and content or check preparation. These commands do
|
|
not test model responses or application workflows. Appended messages follow
|
|
definition messages in supplied order; they are already rendered and do not
|
|
satisfy missing named prompt inputs. Revisit when request reproduction is a
|
|
demonstrated operator requirement. An ordered message-list file is a candidate,
|
|
but no flag syntax, file format, or supported-role selection is decided.
|
|
Deferring flags does not remove native appended messages from preview reports
|
|
when an application builder supplies them.
|
|
|
|
[Roadmap OD-2](promptkit-v0.20.0.md#od-2-request-controls-and-provider-parameter-grammar)
|
|
selects inline text and explicit file input for single-prompt validation and
|
|
preview. Native API availability alone does not select further CLI syntax or
|
|
require a convenience API for application execution.
|
|
|
|
### Alias completion and discovery
|
|
|
|
The delivered [shell completion feature](../cli.md#shell-completion) provides
|
|
canonical suggestions and alias-aware interpretation. Potential future work
|
|
includes suggesting command and flag alias spellings and valid continuations of
|
|
alias-only prefixes. For example, completion could suggest `inspect` after
|
|
`app legacy ` when `legacy inspect` is an installed alias.
|
|
|
|
Alias discovery is outside the initial scope. This deferral does not establish a
|
|
permanent canonical-only completion contract or prohibit future alias discovery.
|
|
A later design should determine how alias suggestions are presented alongside
|
|
canonical suggestions while ensuring inserted continuations form valid next
|
|
steps. No delivery date or final API is selected here.
|
|
|
|
### Reporting extensions
|
|
|
|
The [shared core report output prerequisite](promptkit-v0.20.0.md#shared-core-report-output-prerequisite)
|
|
owns application-selected content, core rendering, universal/automatic format
|
|
selection, JSON representation conventions, text templates, and safe YAML input
|
|
conversion. Text, YAML, and JSON land together; new core formats work through the
|
|
same report API. The [output inventory](promptkit-v0.20.0.md#output-implementation-inventory)
|
|
identifies report paths and preserves explicit raw/help/diagnostic boundaries.
|
|
OD-6 defines one aggregate validation report and its changed delivery timing.
|
|
XML is outside current consideration; Markdown and other renderers are not
|
|
selected for this adoption.
|
|
|
|
Error-conversion helpers such as `WarnError` remain deferred pending demonstrated
|
|
value; applications can already use `report.Warn(err.Error())`. Terminal redraw
|
|
and progress-bar presentation were outside the completed reporting scope and
|
|
remain unselected. Whole-run buffering to make failed runs show only errors
|
|
was also outside that scope. Any later extension needs a deliberate API and
|
|
presentation decision rather than assuming those behaviors are already provided.
|
|
|
|
### Release workflow extensions
|
|
|
|
Historical hosted-page backfilling and automated CI delivery remain separate
|
|
future choices. The current local page-only delivery workflow is implemented;
|
|
these extensions are not prerequisites for using it. The release procedure owns
|
|
delivery, immutable content, and recovery behavior.
|
|
|
|
Additional validation options, including race testing, full vet, compilation
|
|
matrices, size limits, and more forbidden-file paths, can be considered for
|
|
demonstrated needs. None is selected by retaining it here, and the existing
|
|
candidate checks do not become general prohibitions on development workspaces.
|
|
|
|
## Other future proposals
|
|
|
|
These capabilities remain outside the delivered scope and require a concrete
|
|
operator or consumer need and an appropriate ownership/behavior decision:
|
|
|
|
- Additional report renderers as described under [reporting extensions](#reporting-extensions),
|
|
and output-file management or reloadable export.
|
|
- Shell completion extensions, including alias discovery described above and
|
|
dynamic discovery of configured or remote values.
|
|
- Persistent configuration mutation. Transient CLI overrides are selected under
|
|
roadmap OD-11; field metadata and provenance inspection are scoped under
|
|
[configuration inspection extensions](#configuration-inspection-extensions).
|
|
- Credential diagnostics beyond PromptKit's native smoke checks and additional
|
|
live provider probes.
|
|
- Additional component identity registration and domain artifact catalogs.
|
|
- Additional library families, including possible FeedKit integration; families
|
|
can define suitable verbs without requiring comparison or configuration scopes.
|
|
- Backend selection or replacement, a plugin framework, general dependency
|
|
injection, and concurrent-dispatch guarantees.
|
|
|
|
Execution, serving, and session operations remain application-owned. The
|
|
[request preview proposal](promptkit-v0.20.0.md#preview-and-request-flags)
|
|
exposes native preparation and rendering as an agreed operator inspection target;
|
|
implementation has not started.
|
|
The [architecture policy](../policy/architecture.md#command-and-application-ownership)
|
|
recommends shared vocabulary; the [CLI reference](../cli.md#registered-command-syntax)
|
|
owns implemented grammar.
|
|
Backend replacement remains possible behind the accepted facade, subject to the
|
|
published API/CLI contracts and deliberate compatibility decisions.
|
|
|
|
## Possible further efficiency work
|
|
|
|
Selected-scope memoization and selector-membership indexes were deferred pending
|
|
measurements that justify their bookkeeping. Mutable backend reuse across
|
|
invocations, segmented aggregate YAML delivery, provider caching, consumer-loader
|
|
redesign, and a replacement backend were outside the completed performance
|
|
target. Reconsider them only with concrete motivation and review of ownership,
|
|
invocation state, native reports, and the affected contracts. Retained measurement
|
|
records are historical evidence, not performance guarantees or release gates.
|
|
|
|
## Consumer adoption
|
|
|
|
CommandKit is in alpha with no consumers. No application adoption work or rollout
|
|
order is selected. The [consumer guide](../consumers/guide.md) and maintained
|
|
examples provide integration guidance for future applications.
|