Skip to content

docs: refresh generated command help for pflag v1.1.0 - #115

Merged
jaxxstorm merged 1 commit into
mainfrom
docs-refresh-pflag-command-reference
Nov 9, 2026
Merged

jaxxstorm merged 1 commit into
mainfrom
docs-refresh-pflag-command-reference

Conversation

@jaxxstorm

Copy link
Copy Markdown
Owner

Summary

  • Regenerate docs/commands/*.md using make docs-generate on current main (cdd16243da80831bbda929debec1ecaea9466e33).
  • Refresh pflag v1.1.0 boolean help syntax (for example, --debug[=true|false] and --help[=true|false]) and corresponding option-column spacing across 123 generated pages.
  • No source, dependency, generator, workflow, or manually maintained documentation changes.

Why

The pflag v1.1.0 update in #111 changed generated help formatting without refreshing the checked-in command reference. On unchanged main, make docs-check fails with command docs check failed (123 differences).

This same pre-existing drift blocks #114: CI run 42674902956 passes Go tests but fails Verify generated docs. This standalone refresh fixes the base-branch docs gate; once merged, updating #114 onto that main will remove this particular blocker without mixing generated documentation into its dependency update. This PR does not modify #114.

Verification

Using Go 1.27.3:

  • Reproduced make docs-check failure on untouched main (exit 2, 123 differences).
  • make docs-generate followed by make docs-check passes.
  • Regenerated a second time; SHA-256 hashes of all 123 changed files are identical.
  • Reviewed every changed file programmatically: removing only [=true|false] and normalizing whitespace yields the original contents, ruling out unrelated text or environment/secret leakage.
  • git diff --check passes.
  • make test passes (root and tools modules, including CLI integration and docs tests).
  • make coverage-gaps-check passes with no additional tracked changes.
  • go build ./... and go -C tools build ./... pass.
  • go vet ./... and go -C tools vet ./... pass.

Copilot AI balanced review requested due to automatic review settings November 9, 2026 19:33
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-09T19:34:38.908608Z a026281 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues were identified for the generated command-reference refresh.

No open issues 🎉

What changed in this PR

Refreshes tscli’s generated command reference to match the pflag v1.1.0 help formatting introduced by #111. This addresses the documented generated-docs drift also blocking #114, without changing CLI behavior or dependencies.

Changes:

  • Updates boolean flags to show optional explicit values, such as --debug[=true|false].
  • Adjusts option-column spacing across 123 generated command pages.
  • Leaves source code, generators, workflows, and manually maintained documentation unchanged.
File Description
docs/​commands/​tscli.md Refreshes root boolean help and spacing.
docs/​commands/​tscli_version.md Refreshes version help and inherited options.
docs/​commands/​tscli_set.md Refreshes set-command help formatting.
docs/​commands/​tscli_set_webhook.md Refreshes help and rotate boolean syntax.
docs/​commands/​tscli_set_webhook_test.md Refreshes webhook-test help formatting.
docs/​commands/​tscli_set_user.md Refreshes user-setting help formatting.
docs/​commands/​tscli_set_user_role.md Refreshes user-role help formatting.
docs/​commands/​tscli_set_user_invite.md Refreshes help and resend boolean syntax.
docs/​commands/​tscli_set_user_access.md Refreshes user-access boolean syntax.
docs/​commands/​tscli_set_settings.md Refreshes settings boolean syntax.
docs/​commands/​tscli_set_service.md Refreshes service-setting help formatting.
docs/​commands/​tscli_set_service_approval.md Refreshes approval boolean syntax and spacing.
docs/​commands/​tscli_set_posture-integration.md Refreshes posture-integration help formatting.
docs/​commands/​tscli_set_policy.md Refreshes policy-setting help formatting.
docs/​commands/​tscli_set_oauth-app.md Refreshes OAuth-app help formatting.
docs/​commands/​tscli_set_logs.md Refreshes logging-settings help formatting.
docs/​commands/​tscli_set_logs_stream.md Refreshes log-stream setting help formatting.
docs/​commands/​tscli_set_key.md Refreshes key-setting help formatting.
docs/​commands/​tscli_set_dns.md Refreshes DNS-setting help formatting.
docs/​commands/​tscli_set_dns_split-dns.md Refreshes replace boolean syntax and spacing.
docs/​commands/​tscli_set_dns_searchpaths.md Refreshes DNS search-path help formatting.
docs/​commands/​tscli_set_dns_preferences.md Refreshes MagicDNS boolean syntax and spacing.
docs/​commands/​tscli_set_dns_nameservers.md Refreshes nameserver-setting help formatting.
docs/​commands/​tscli_set_dns_configuration.md Refreshes DNS configuration help formatting.
docs/​commands/​tscli_set_device.md Refreshes device-setting help formatting.
docs/​commands/​tscli_set_device_tags.md Refreshes device-tag help formatting.
docs/​commands/​tscli_set_device_routes.md Refreshes device-route setting help formatting.
docs/​commands/​tscli_set_device_posture.md Refreshes device-posture setting help formatting.
docs/​commands/​tscli_set_device_name.md Refreshes device-renaming help formatting.
docs/​commands/​tscli_set_device_key.md Refreshes key-expiry boolean syntax.
docs/​commands/​tscli_set_device_ip.md Refreshes device-IP help formatting.
docs/​commands/​tscli_set_device_invite.md Refreshes device-invite setting help formatting.
docs/​commands/​tscli_set_device_expiry.md Refreshes device-expiry help formatting.
docs/​commands/​tscli_set_device_authorization.md Refreshes approve boolean syntax and spacing.
docs/​commands/​tscli_set_device_attributes.md Refreshes device-attribute help formatting.
docs/​commands/​tscli_set_contact.md Refreshes resend boolean syntax and spacing.
docs/​commands/​tscli_list.md Refreshes list-command help formatting.
docs/​commands/​tscli_list_webhooks.md Refreshes webhook-list help formatting.
docs/​commands/​tscli_list_users.md Refreshes user-list help formatting.
docs/​commands/​tscli_list_tailnets.md Refreshes tailnet-list help formatting.
docs/​commands/​tscli_list_services.md Refreshes service-list help formatting.
docs/​commands/​tscli_list_services_devices.md Refreshes service-device list help formatting.
docs/​commands/​tscli_list_routes.md Refreshes route-list help formatting.
docs/​commands/​tscli_list_posture-integrations.md Refreshes posture-integration list help formatting.
docs/​commands/​tscli_list_oauth-apps.md Refreshes OAuth-app list help formatting.
docs/​commands/​tscli_list_nameservers.md Refreshes nameserver-list help formatting.
docs/​commands/​tscli_list_logs.md Refreshes log-list help formatting.
docs/​commands/​tscli_list_logs_network.md Refreshes network-log list help formatting.
docs/​commands/​tscli_list_logs_config.md Refreshes configuration-log list help formatting.
docs/​commands/​tscli_list_keys.md Refreshes all-keys boolean syntax and spacing.
docs/​commands/​tscli_list_invites.md Refreshes invite-list help formatting.
docs/​commands/​tscli_list_invites_user.md Refreshes user-invite list help formatting.
docs/​commands/​tscli_list_invites_device.md Refreshes device-invite list help formatting.
docs/​commands/​tscli_list_devices.md Refreshes all-fields boolean syntax and spacing.
docs/​commands/​tscli_get.md Refreshes get-command help formatting.
docs/​commands/​tscli_get_webhook.md Refreshes webhook retrieval help formatting.
docs/​commands/​tscli_get_user.md Refreshes user retrieval help formatting.
docs/​commands/​tscli_get_user_invite.md Refreshes user-invite retrieval help formatting.
docs/​commands/​tscli_get_settings.md Refreshes settings retrieval help formatting.
docs/​commands/​tscli_get_service.md Refreshes service retrieval help formatting.
docs/​commands/​tscli_get_service_approval.md Refreshes service-approval retrieval help formatting.
docs/​commands/​tscli_get_posture-integration.md Refreshes posture-integration retrieval help formatting.
docs/​commands/​tscli_get_policy.md Refreshes JSON boolean syntax and spacing.
docs/​commands/​tscli_get_policy_validate.md Refreshes policy-validation help formatting.
docs/​commands/​tscli_get_policy_preview.md Refreshes current-policy boolean syntax and spacing.
docs/​commands/​tscli_get_oauth-app.md Refreshes OAuth-app retrieval help formatting.
docs/​commands/​tscli_get_logs.md Refreshes log retrieval help formatting.
docs/​commands/​tscli_get_logs_stream.md Refreshes status boolean syntax and spacing.
docs/​commands/​tscli_get_logs_aws.md Refreshes AWS logging help formatting.
docs/​commands/​tscli_get_logs_aws_validate.md Refreshes AWS logging validation help formatting.
docs/​commands/​tscli_get_key.md Refreshes key retrieval help formatting.
docs/​commands/​tscli_get_dns.md Refreshes DNS retrieval help formatting.
docs/​commands/​tscli_get_dns_split-dns.md Refreshes split-DNS retrieval help formatting.
docs/​commands/​tscli_get_dns_searchpaths.md Refreshes DNS search-path retrieval help formatting.
docs/​commands/​tscli_get_dns_preferences.md Refreshes DNS preferences help formatting.
docs/​commands/​tscli_get_dns_nameservers.md Refreshes DNS nameserver retrieval help formatting.
docs/​commands/​tscli_get_dns_configuration.md Refreshes DNS configuration retrieval help formatting.
docs/​commands/​tscli_get_device.md Refreshes all-fields boolean syntax and spacing.
docs/​commands/​tscli_get_device_posture.md Refreshes device-posture retrieval help formatting.
docs/​commands/​tscli_get_device_invite.md Refreshes device-invite retrieval help formatting.
docs/​commands/​tscli_get_contacts.md Refreshes contact retrieval help formatting.
docs/​commands/​tscli_delete.md Refreshes delete-command help formatting.
docs/​commands/​tscli_delete_webhook.md Refreshes webhook-deletion help formatting.
docs/​commands/​tscli_delete_users.md Refreshes admins and confirm boolean syntax.
docs/​commands/​tscli_delete_user.md Refreshes user-deletion help formatting.
docs/​commands/​tscli_delete_user_invite.md Refreshes user-invite deletion help formatting.
docs/​commands/​tscli_delete_tailnet.md Refreshes tailnet-deletion help formatting.
docs/​commands/​tscli_delete_service.md Refreshes service-deletion help formatting.
docs/​commands/​tscli_delete_posture-integration.md Refreshes posture-integration deletion help formatting.
docs/​commands/​tscli_delete_oauth-app.md Refreshes OAuth-app deletion help formatting.
docs/​commands/​tscli_delete_logs.md Refreshes logging-removal help formatting.
docs/​commands/​tscli_delete_logs_stream.md Refreshes log-stream deletion help formatting.
docs/​commands/​tscli_delete_key.md Refreshes key-deletion help formatting.
docs/​commands/​tscli_delete_devices.md Refreshes confirm and ephemeral boolean syntax.
docs/​commands/​tscli_delete_device.md Refreshes device-deletion help formatting.
docs/​commands/​tscli_delete_device_routes.md Refreshes device-route deletion help formatting.
docs/​commands/​tscli_delete_device_posture.md Refreshes device-posture deletion help formatting.
docs/​commands/​tscli_delete_device_invite.md Refreshes device-invite deletion help formatting.
docs/​commands/​tscli_create.md Refreshes create-command help formatting.
docs/​commands/​tscli_create_webhook.md Refreshes webhook-creation help formatting.
docs/​commands/​tscli_create_token.md Refreshes token-creation help formatting.
docs/​commands/​tscli_create_tailnet.md Refreshes tailnet-creation help formatting.
docs/​commands/​tscli_create_posture-integration.md Refreshes posture-integration creation help formatting.
docs/​commands/​tscli_create_oauth-app.md Refreshes OAuth-app creation help formatting.
docs/​commands/​tscli_create_key.md Refreshes auth-key boolean syntax and spacing.
docs/​commands/​tscli_create_invite.md Refreshes invite-creation help formatting.
docs/​commands/​tscli_create_invite_user.md Refreshes user-invite creation help formatting.
docs/​commands/​tscli_create_invite_device.md Refreshes exit-node and multi-use boolean syntax.
docs/​commands/​tscli_config.md Refreshes configuration-command help formatting.
docs/​commands/​tscli_config_show.md Refreshes configuration-display help formatting.
docs/​commands/​tscli_config_setup.md Refreshes configuration-setup help formatting.
docs/​commands/​tscli_config_set.md Refreshes configuration-setting help formatting.
docs/​commands/​tscli_config_profiles.md Refreshes profile-command help formatting.
docs/​commands/​tscli_config_profiles_set.md Refreshes profile-setting help and inherited options.
docs/​commands/​tscli_config_profiles_set-active.md Refreshes profile-activation help formatting.
docs/​commands/​tscli_config_profiles_list.md Refreshes profile-list help formatting.
docs/​commands/​tscli_config_profiles_delete.md Refreshes profile-deletion help formatting.
docs/​commands/​tscli_config_get.md Refreshes configuration retrieval help formatting.
docs/​commands/​tscli_config_encryption.md Refreshes encryption-command help formatting.
docs/​commands/​tscli_config_encryption_setup.md Refreshes encryption-setup help formatting.
docs/​commands/​tscli_agent.md Refreshes agent-command help formatting.
docs/​commands/​tscli_agent_update.md Refreshes force boolean syntax and spacing.
docs/​commands/​tscli_agent_init.md Refreshes force boolean syntax and spacing.

Review effort: Balanced

@jaxxstorm
jaxxstorm merged commit 7fc8c42 into main Nov 9, 2026
2 checks passed
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