commandkit/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 to define a command, or run the core example. 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 for published versions, compatibility, and installation choices.

Examples

• Core-only example
• ConfigKit example
• Composed ConfigKit and PromptKit example

Documentation

• Contributor guide
• Command line reference
• Consumer guide
• Internal package overview
• Maintainer release procedure
• Architecture policy
• Policy provenance
• Future work and proposals

CommandKit is licensed under the LGPL v3.0 or later.

Open Source attribution notices are available.