README.md

# CommandKit

CommandKit is a Go library project for consistent CLI inspection, command syntax,
and shared command infrastructure across related applications.

The current Go library provides an instance-owned command registry, typed flag
and operand bindings, Cobra-backed routing, invocation outcomes, generated help,
application or CommandKit version reporting, configuration scope discovery,
ConfigKit-backed validation, native effective YAML display, source inventory,
and path explanation reports. Applications can register a PromptKit engine
configuration scope independently of PromptKit definition commands, and can
install optional prompt and profile inspection commands.

The [consumer guide](docs/consumers/guide.md) links to two maintained examples:
[simple](examples/simple/README.md) and
[composed](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 history

- [Optional integration module roadmap](docs/roadmap/modules.md)
- [Finalized registration API design](docs/roadmap/registration-api.md)
- [Deferred capabilities and proposals](docs/roadmap/deferred.md)
- [Completed planning and implementation records in Git history](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/6bc37e7ba64ca0920b4d0cc77039a18d4006b24e/docs/roadmap)

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`

Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00			`CommandKit is a Go library project for consistent CLI inspection, command syntax,`
			`and shared command infrastructure across related applications.`

Add generated help and version commands 2026-10-07 13:37:57 +00:00			`The current Go library provides an instance-owned command registry, typed flag`
			`and operand bindings, Cobra-backed routing, invocation outcomes, generated help,`
Add PromptKit configuration scope 2026-10-07 14:26:32 +00:00			`application or CommandKit version reporting, configuration scope discovery,`
Add configuration path explanations 2026-10-07 14:17:46 +00:00			`ConfigKit-backed validation, native effective YAML display, source inventory,`
Add PromptKit configuration scope 2026-10-07 14:26:32 +00:00			`and path explanation reports. Applications can register a PromptKit engine`
Add PromptKit definition inspection 2026-10-07 14:40:41 +00:00			`configuration scope independently of PromptKit definition commands, and can`
			`install optional prompt and profile inspection commands.`
Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00
Complete CommandKit consumer documentation 2026-10-07 14:56:13 +00:00			`The [consumer guide](docs/consumers/guide.md) links to two maintained examples:`
			`[simple](examples/simple/README.md) and`
			`[composed](examples/composed/README.md).`

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)`
Adopt shared policies and record CommandKit architecture 2026-10-06 16:32:59 +00:00
Retire completed roadmaps and preserve deferred work 2026-10-09 04:04:24 +00:00			`## Future work and history`
Route documentation navigation to current contract owners 2026-10-07 18:29:24 +00:00
Accept the captured declaration architecture and align documentation 2026-10-10 16:19:45 +00:00			`- [Optional integration module roadmap](docs/roadmap/modules.md)`
			`- [Finalized registration API design](docs/roadmap/registration-api.md)`
Retire completed roadmaps and preserve deferred work 2026-10-09 04:04:24 +00:00			`- [Deferred capabilities and proposals](docs/roadmap/deferred.md)`
			`- [Completed planning and implementation records in Git history](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/6bc37e7ba64ca0920b4d0cc77039a18d4006b24e/docs/roadmap)`
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.`