diff --git a/docs/roadmap/commandkit.md b/docs/roadmap/commandkit.md index f48fb4b..b4f49ad 100644 --- a/docs/roadmap/commandkit.md +++ b/docs/roadmap/commandkit.md @@ -59,7 +59,7 @@ release. resource and namespace/collection inventories, contextual requirement inspection, and captured engine configuration through its config scope. Native reports and namespace selection must remain available; a curated Audita - subset is not a substitute. Inspection success is not execution readiness. + subset is not a substitute. - Apply the [resolved profile-summary decision](promptkit.md#profile-inspection-and-summary--resolved): retire the curated profiles view, use standard configuration/resource inspection and request preview, and add no replacement custom role summary at this stage. @@ -160,6 +160,35 @@ Check effective mode after native ordering, boolean values, and aliases: explicit destination. `--debug --quiet` also requires one; debug capture remains independent once the invocation passes this check. +## Request Preview, Validation, and Smoke Commands — Resolved + +Include standard ckprompt request preview, request validation, and the complete +smoke-command surface in the next major release. Enable the upstream adapters +and retain native commands, flags, reports, and outcomes. Smoke commands remain +explicit operator-invoked operations, separate from application startup and +automated release checks. + +Use the standard request inputs directly where they suffice. Where Audita adds +role/profile selection, shared instructions, response schemas, or domain inputs, +reuse its processing request-construction helpers in the relevant adapters. +Preserve native operator overrides and keep generic requests usable without +Audita processing context. Request preview and validation operate on supplied +inputs; representative validator candidates can come from maintained fixtures +without running proposal inference as part of request construction. + +Establish runtime and request construction first, then wire preview and +validation, followed by smoke commands and assembled-CLI verification. All are +required adoption scope. Address concrete integration blockers upstream rather +than silently omitting standard capabilities. + +For standard CommandKit commands passed through by Audita, provide a concise +link to the upstream documentation for the adopted version. Upstream owns their +command reference and behavior explanations. Do not duplicate that documentation, +add local provider-call/cost warnings, or add caveats or workarounds for perceived +limitations of the standard capabilities. Audita documentation covers only its +own selectors, request construction, domain inputs, and application-specific +behavior. Apply this documentation boundary to the whole standard command suite. + ## Work Outline The adoption gate above applies to implementation in this outline; preparatory @@ -188,14 +217,15 @@ design and inventory work can proceed before it opens. Wire processing artifact capture to the shared debug boolean once the public binding API is available; remove Audita's independent debug flag declaration and parsing while retaining its application-owned capture behavior. -5. Develop concrete request adapters for preview, validation, and any selected - smoke commands. They need correct variables, schema contracts, and credential - handling, not just an engine loader. Keep generic resource inspection independent - of those domain inputs and distinguish generic from Audita-prepared requests. +5. Enable the standard preview, validation, and full smoke capabilities using the + resolved adapter and sequencing approach above. Share Audita request helpers + where domain additions are needed; keep generic resource inspection independent + of those domain inputs. 6. Update [CLI](../cli.md), [configuration](../config.md), [operations](../operations.md), [subprocess integration](../integrations/subprocess.md), examples, help, - completion guidance, and migration documentation with implementation. Adopt - the dependencies and exact attribution together. + completion guidance, and migration documentation with implementation. Document + Audita-specific behavior and link to upstream for standard command usage. + Adopt the dependencies and exact attribution together. ## Acceptance and Upstream Requests @@ -238,10 +268,14 @@ through native parsing. Inspection must not create processing artifacts even with debug enabled. Check artifact-location reporting subject to normal visibility and help text explaining capture under quiet mode. +Verify preview, validation, and every standard smoke operation through the +assembled CLI using fixtures and controlled providers. Focus on Audita's command +registration, engine loading, input forwarding, shared request construction, and +native report/outcome handoff. Keep integration coverage proportionate rather +than duplicating upstream capability tests. + Tagged core and integration suites passed during review, but do not establish -these Audita behaviors. Use offline tests and controlled providers; explicitly -invoked smoke operations may contact providers and incur costs, but are not an -automatic startup or release check. +these Audita behaviors. Use offline tests and controlled providers. CommandKit and integrations are early-stage. Freely propose upstream improvements where reporting, declaration, or integration APIs are problematic or incomplete. @@ -284,19 +318,3 @@ quiet destination validation. Presence information remains available through native typed input. Resolve any remaining integration gap upstream rather than inspecting private state, inferring input from emitted output, redeclaring the core flag, or reparsing arguments. The mode accessor alone does not unblock capture wiring. - -## Open Decisions - -### Request Preview, Validation, and Smoke Commands - -**Recommendation:** include standard offline request preview and validation, -and expose smoke diagnostics as explicit operator-invoked commands once the -request adapter is correct. This best supports the suite happy path. Generic -inspection remains available without a runnable request, and smoke results must -retain unknown/unsupported facts rather than imply provider readiness. - -**Alternative:** deliver the agreed full inspection/configuration surface first, -then add request operations in a named follow-up stage if their adapter needs -upstream work. This limits premature request semantics but leaves a temporarily -incomplete suite experience. It is not permission to defer the full inspection -set or to silently omit commands because they were absent from old Audita. diff --git a/docs/roadmap/library-adoption.md b/docs/roadmap/library-adoption.md index 53386f2..406d631 100644 --- a/docs/roadmap/library-adoption.md +++ b/docs/roadmap/library-adoption.md @@ -46,7 +46,10 @@ They do not select unrelated work in [future.md](future.md). - **CommandKit and integrations:** adopt the standard suite experience, including the full ckprompt inspection command set. The libraries are young; problematic or incomplete behavior is a candidate for an upstream change request rather - than a permanent Audita workaround. + than a permanent Audita workaround. For standard commands passed through by + Audita, link concisely to upstream documentation instead of maintaining a local + reference, warnings, or caveats about upstream capabilities. Document Audita's + own inputs, wiring, and domain-specific behavior. - **ReleaseKit:** adopt `go.maximumdirect.net/releasekit` v0.9.0 and move as much release machinery upstream as possible. Audita may select any number of ReleaseKit-owned validators. Retain local release validation only with a