Skip to content

docs: add JSON template example to csr command help#179

Merged
danielewood merged 1 commit intomainfrom
docs/csr-template-example
Mar 19, 2026
Merged

docs: add JSON template example to csr command help#179
danielewood merged 1 commit intomainfrom
docs/csr-template-example

Conversation

@danielewood
Copy link
Copy Markdown
Collaborator

Summary

  • Add inline JSON example to certkit csr --help showing the --template file structure
  • Covers subject fields, mixed host types (DNS, wildcard, IP, email, SPIFFE URI), and optional other_names

Context

Users had to read source code to figure out the JSON template format for certkit csr --template. Now the help text shows a complete example.

Test plan

  • certkit csr --help displays the example correctly
  • CI passes

🤖 Generated with Claude Code

The --template flag accepts a JSON file but the help didn't show what
the structure looks like. Add an inline example covering subject fields,
mixed host types, and other_names so users don't have to read source
code to write a template.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 19, 2026 00:47
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an inline JSON template example to the certkit csr command’s help text so users can understand the --template file format without reading source code.

Changes:

  • Extended certkit csr --help (Long description) with a complete JSON template example.
  • Documented host auto-classification (DNS/IP/email/URI) and the optional other_names field with supported types.

You can also share your feedback on Copilot code review. Take the survey.

@danielewood danielewood merged commit 6ccee62 into main Mar 19, 2026
19 checks passed
@danielewood danielewood deleted the docs/csr-template-example branch March 19, 2026 00:52
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.

2 participants