38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
# 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.
|