Skip to content

docs: complete README CLI flag reference - #138

Merged
TMHSDigital merged 1 commit into
TMHSDigital:mainfrom
sb123sb123:docs/137-readme-cli-flags
Oct 7, 2026
Merged

TMHSDigital merged 1 commit into
TMHSDigital:mainfrom
sb123sb123:docs/137-readme-cli-flags

Conversation

@sb123sb123

Copy link
Copy Markdown
Contributor

Summary

  • Add the missing -ct, -permute, -print-config, -resume, -seeds, and -state entries to the README flag table.
  • Add a regression test that checks every flag registered by the CLI appears in that table.

Closes #137.

Validation

  • Focused README and generated-site flag-table tests passed.
  • go test -race ./... passed.
  • make lint passed with golangci-lint v2.14.0.

@TMHSDigital
TMHSDigital merged commit 3139c44 into TMHSDigital:main Oct 7, 2026
2 checks passed
@TMHSDigital

Copy link
Copy Markdown
Owner

Thanks @sb123sb123! Merged as 3139c44. All six rows match subenum -h, and the regression test does its job (I removed the -state row locally and it failed naming the flag). If you want a follow-up: the test catches missing flags but not stale rows for removed ones, and the -print-config row could put env, config and default in code formatting like flag.

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.

README flag table is missing six flags

2 participants