README.md

# CommandKit

CommandKit helps Go applications build consistent command-line interfaces. It
provides typed flags and arguments, help, output formatting, and error reporting.
Optional integrations add commands for inspecting configuration and working with
PromptKit.

CommandKit is in alpha. Start with the [consumer guide](docs/consumers/guide.md#core-commands)
to define a command, or run the [core example](examples/core/README.md).
Applications supply their own command handlers and decide when to exit;
CommandKit returns the result of each invocation.

## Modules

| Module | Package | Provides |
| --- | --- | --- |
| `go.maximumdirect.net/commandkit` | `commandkit` | Commands, typed inputs, shared output and error reporting, help, and version. |
| `go.maximumdirect.net/ckconfig` | `ckconfig` | Commands to view, validate, explain, and compare ConfigKit configuration. |
| `go.maximumdirect.net/ckprompt` | `ckprompt` | Commands to list and inspect PromptKit resources, discover required inputs, validate and preview requests, and run smoke tests. |

Importing an integration does not install commands. Core and the integrations
are versioned separately; see the [consumer guide](docs/consumers/guide.md#module-selection)
for published versions, compatibility, and installation choices.

## Examples

- [Core-only example](examples/core/README.md)
- [ConfigKit example](integrations/ckconfig/examples/simple/README.md)
- [Composed ConfigKit and PromptKit example](integrations/ckprompt/examples/composed/README.md)

## Documentation

- [Contributor guide](docs/development.md)
- [Command line reference](docs/cli.md)
- [Consumer guide](docs/consumers/guide.md)
- [Internal package overview](docs/internal/overview.md)
- [Maintainer release procedure](docs/release.md)
- [Architecture policy](docs/policy/architecture.md)
- [Policy provenance](docs/policy/meta.md)
- [Future work and proposals](docs/roadmap/future.md)

CommandKit is licensed under the [LGPL v3.0 or later](COPYRIGHT).

[Open Source attribution notices](docs/oss/attribution.md) are available.
Initial commit 2026-10-04 13:54:17 +00:00			`# CommandKit`

Refresh operator documentation and CLI help 2026-11-07 23:31:14 +00:00			`CommandKit helps Go applications build consistent command-line interfaces. It`
			`provides typed flags and arguments, help, output formatting, and error reporting.`
			`Optional integrations add commands for inspecting configuration and working with`
			`PromptKit.`
Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00
Refresh operator documentation and CLI help 2026-11-07 23:31:14 +00:00			`CommandKit is in alpha. Start with the [consumer guide](docs/consumers/guide.md#core-commands)`
			`to define a command, or run the [core example](examples/core/README.md).`
			`Applications supply their own command handlers and decide when to exit;`
			`CommandKit returns the result of each invocation.`
Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00
Reconcile module docs and release materials 2026-10-11 02:06:06 +00:00			`## Modules`

			`\| Module \| Package \| Provides \|`
			`\| --- \| --- \| --- \|`
Refresh operator documentation and CLI help 2026-11-07 23:31:14 +00:00			\| `go.maximumdirect.net/commandkit` \| `commandkit` \| Commands, typed inputs, shared output and error reporting, help, and version. \|
			\| `go.maximumdirect.net/ckconfig` \| `ckconfig` \| Commands to view, validate, explain, and compare ConfigKit configuration. \|
			\| `go.maximumdirect.net/ckprompt` \| `ckprompt` \| Commands to list and inspect PromptKit resources, discover required inputs, validate and preview requests, and run smoke tests. \|
Reconcile module docs and release materials 2026-10-11 02:06:06 +00:00
Correct reporting and release navigation 2026-11-07 16:01:14 +00:00			`Importing an integration does not install commands. Core and the integrations`
			`are versioned separately; see the [consumer guide](docs/consumers/guide.md#module-selection)`
			`for published versions, compatibility, and installation choices.`
Reconcile module docs and release materials 2026-10-11 02:06:06 +00:00
			`## Examples`

Add aliases to maintained examples 2026-10-19 19:56:33 +00:00			`- [Core-only example](examples/core/README.md)`
Reconcile module docs and release materials 2026-10-11 02:06:06 +00:00			`- [ConfigKit example](integrations/ckconfig/examples/simple/README.md)`
			`- [Composed ConfigKit and PromptKit example](integrations/ckprompt/examples/composed/README.md)`
Complete CommandKit consumer documentation 2026-10-07 14:56:13 +00:00
Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00			`## Documentation`

			`- [Contributor guide](docs/development.md)`
Add generated help and version commands 2026-10-07 13:37:57 +00:00			`- [Command line reference](docs/cli.md)`
Complete CommandKit consumer documentation 2026-10-07 14:56:13 +00:00			`- [Consumer guide](docs/consumers/guide.md)`
			`- [Internal package overview](docs/internal/overview.md)`
Document the source release workflow 2026-10-08 16:49:01 +00:00			`- [Maintainer release procedure](docs/release.md)`
Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00			`- [Architecture policy](docs/policy/architecture.md)`
Plan staged CommandKit implementation 2026-10-07 03:55:36 +00:00			`- [Policy provenance](docs/policy/meta.md)`
Retire completed roadmaps and collect future work 2026-11-04 16:04:32 +00:00			`- [Future work and proposals](docs/roadmap/future.md)`
Route documentation navigation to current contract owners 2026-10-07 18:29:24 +00:00
Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00			`CommandKit is licensed under the [LGPL v3.0 or later](COPYRIGHT).`

			`[Open Source attribution notices](docs/oss/attribution.md) are available.`