mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-21 14:35:22 +08:00
Paul Gottschling
e58e510ef2
* Generate a tctl reference page Add a `cli-docs-tctl` Make target and generate the page. To allow the page to render, make the `tctl edit` help text more consistent with that of other commands by using a single line for the resource type/name argument. This change adds 47 `tctl` commands not present in the current reference. Also change the default value of the `tctl recordings download` `output-dir` flag to the system-independent "." value. Otherwise, generating this page prints a system-specific file path. Also make minor modifications to flag, argument, and command descriptions to be consistent with messaging conventions in the docs. * CLI ref generator: add arg/flag default overrides In the CLI reference doc generator, make it possible to override default argument and flag values. This is necessary when these values are dynamic and system dependent, e.g., a user's home directory. Add the `flag_default_overrides` and `arg_default_overrides` fields to the generator config file. Use these fields to create template functions that replace default values in a `*kingpin.FlagModel` or `*kingpin.ArgModel`. * Add flag default overrides for tctl reference Configure flags with dynamic values to have hardcoded values in the reference docs page so there is no need to edit the dynamic argument logic in the tctl source.