Skip to content

docs: v0.1.0#5

Merged
krakenhavoc merged 1 commit intomainfrom
docs/v0.1.0
Mar 27, 2026
Merged

docs: v0.1.0#5
krakenhavoc merged 1 commit intomainfrom
docs/v0.1.0

Conversation

@krakenhavoc
Copy link
Copy Markdown
Contributor

This pull request updates the README.md to provide more comprehensive and detailed documentation for the krakenkey CLI tool. The changes clarify command usage, add new sections for endpoint management, expand flag documentation, and improve examples for both interactive and CI/CD use cases.

Command Documentation Improvements:

  • Expanded descriptions for auth, domain, and account commands, including clearer explanations of what each command does and what information it displays.
  • Added detailed flag tables for auth keys create, cert issue, cert submit, and endpoint add, specifying required and optional flags, defaults, and descriptions. [1] [2]
  • Enhanced the cert command section with more details on filtering, output options, and supported operations, including new/clarified flags for issuing, submitting, downloading, renewing, revoking, retrying, and deleting certificates.
  • Introduced a new section for krakenkey endpoint commands, documenting endpoint monitoring, probe management, and region assignment/removal, along with their respective flags.

Example and Usability Enhancements:

  • Improved CI/CD and Docker usage examples by clarifying environment variable setup and output handling for automation scenarios. [1] [2]

These updates make the CLI documentation more user-friendly and actionable, especially for new users and those integrating with automation pipelines.

@krakenhavoc krakenhavoc merged commit 1533b85 into main Mar 27, 2026
4 checks passed
@krakenhavoc krakenhavoc deleted the docs/v0.1.0 branch March 27, 2026 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant