2026-10-04 13:54:17 +00:00
|
|
|
# CommandKit
|
|
|
|
|
|
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.
|
|
|
|
|
|
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,
|
2026-10-07 14:26:32 +00:00
|
|
|
application or CommandKit version reporting, configuration scope discovery,
|
2026-10-07 14:17:46 +00:00
|
|
|
ConfigKit-backed validation, native effective YAML display, source inventory,
|
2026-10-07 14:26:32 +00:00
|
|
|
and path explanation reports. Applications can register a PromptKit engine
|
2026-10-07 14:40:41 +00:00
|
|
|
configuration scope independently of PromptKit definition commands, and can
|
|
|
|
|
install optional prompt and profile inspection commands.
|
2026-10-06 16:32:59 +00:00
|
|
|
|
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).
|
|
|
|
|
|
2026-10-06 16:32:59 +00:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
- [Contributor guide](docs/development.md)
|
2026-10-07 13:37:57 +00:00
|
|
|
- [Command line reference](docs/cli.md)
|
2026-10-07 14:56:13 +00:00
|
|
|
- [Consumer guide](docs/consumers/guide.md)
|
|
|
|
|
- [Internal package overview](docs/internal/overview.md)
|
2026-10-08 16:49:01 +00:00
|
|
|
- [Maintainer release procedure](docs/release.md)
|
2026-10-09 01:54:31 +00:00
|
|
|
- [Computational efficiency roadmap](docs/roadmap/performance.md)
|
|
|
|
|
- [Performance implementation record](docs/roadmap/implementation.md)
|
2026-10-06 16:32:59 +00:00
|
|
|
- [Architecture policy](docs/policy/architecture.md)
|
2026-10-07 03:55:36 +00:00
|
|
|
- [Policy provenance](docs/policy/meta.md)
|
2026-10-06 16:32:59 +00:00
|
|
|
|
2026-10-07 18:29:24 +00:00
|
|
|
## Planning history and future work
|
|
|
|
|
|
|
|
|
|
- [Initial delivery and deferred capabilities](docs/roadmap/initial.md)
|
2026-10-08 16:49:01 +00:00
|
|
|
- [Completed initial implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/3871d837489b9955998b362587a52b47282dc021/docs/roadmap/implementation.md)
|
2026-10-09 01:54:31 +00:00
|
|
|
- [Completed ReleaseKit implementation record](https://gitea.maximumdirect.net/eric/CommandKit/src/commit/c0c03285f7beac3e96f1708b655c1eb2add35e79/docs/roadmap/implementation.md)
|
2026-10-07 18:29:24 +00:00
|
|
|
- [Historical CLI planning](docs/roadmap/01-cli-plan.md)
|
|
|
|
|
- [Completed dispatcher planning](docs/roadmap/02-dispatch.md)
|
|
|
|
|
- [Completed backend planning](docs/roadmap/03-backend.md)
|
|
|
|
|
- [Completed facade planning](docs/roadmap/04-facade.md)
|
|
|
|
|
|
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.
|
