2026-10-04 13:54:17 +00:00
|
|
|
# CommandKit
|
|
|
|
|
|
2026-10-11 02:06:06 +00:00
|
|
|
CommandKit is a Go library for typed command declarations, shared CLI behavior,
|
|
|
|
|
and application-owned execution. The core `commandkit` module is usable by
|
|
|
|
|
itself. ConfigKit and PromptKit support lives in separately versioned optional
|
|
|
|
|
modules, so applications choose which upstream libraries they add.
|
2026-10-06 16:32:59 +00:00
|
|
|
|
2026-10-11 02:06:06 +00:00
|
|
|
The core captures reusable command declarations, validates installation batches
|
|
|
|
|
before changing an application's registry, converts typed inputs before
|
|
|
|
|
constructing them, and returns outcomes without exiting the process. Its
|
|
|
|
|
[consumer guide](docs/consumers/guide.md) covers declaration and invocation.
|
2026-10-06 16:32:59 +00:00
|
|
|
|
2026-10-11 02:06:06 +00:00
|
|
|
## Modules
|
|
|
|
|
|
|
|
|
|
| Module | Package | Provides |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| `gitea.maximumdirect.net/eric/CommandKit` | `commandkit` | Typed commands, bindings, execution, outcomes, help, and version. |
|
|
|
|
|
| `gitea.maximumdirect.net/eric/CommandKit/integrations/ckconfig` | `ckconfig` | ConfigKit-backed `config` scopes and inspection commands. |
|
2026-10-12 22:25:43 +00:00
|
|
|
| `gitea.maximumdirect.net/eric/CommandKit/integrations/ckprompt` | `ckprompt` | PromptKit engine configuration/comparison, prompt/profile catalogs, named inspection, requirements discovery, and concrete request validation. |
|
2026-10-11 02:06:06 +00:00
|
|
|
|
|
|
|
|
Importing an integration does not install commands. Pass its declaration to
|
|
|
|
|
`commandkit.New` or `App.Register` to install it. The integrations depend on the
|
|
|
|
|
core and their selected upstream libraries; the core does not depend on either
|
|
|
|
|
integration.
|
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
- [Core-only example](examples/core/main.go)
|
|
|
|
|
- [ConfigKit example](integrations/ckconfig/examples/simple/README.md)
|
|
|
|
|
- [Composed ConfigKit and PromptKit example](integrations/ckprompt/examples/composed/README.md)
|
2026-10-07 14:56:13 +00:00
|
|
|
|
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-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-09 04:04:24 +00:00
|
|
|
- [Deferred capabilities and proposals](docs/roadmap/deferred.md)
|
2026-10-07 18:29:24 +00:00
|
|
|
|
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.
|
