Skip to content

feat(cli): organize flags #6269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 14 commits into from
Prev Previous commit
Next Next commit
Remove help
  • Loading branch information
ammario committed Feb 18, 2023
commit efed5f725a2e6f29dae784d33d42cad33ff90590
1 change: 0 additions & 1 deletion cli/testdata/coder_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ Other Flags:
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
-h, --help help for coder
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_agent_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Operability Flags:
--pprof-address string The address to serve pprof.
Consumes $CODER_AGENT_PPROF_ADDRESS (default "127.0.0.1:6060")
Other Flags:
-h, --help help for agent
--no-reap Do not start a process reaper.

Global Flags:
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_config-ssh_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Get Started:
Flags:
-n, --dry-run Perform a trial run with no changes made, showing a diff at
the end.
-h, --help help for config-ssh
--ssh-config-file string Specifies the path to an SSH config.
Consumes $CODER_SSH_CONFIG_FILE (default "~/.ssh/config")
-o, --ssh-option stringArray Specifies additional SSH options to embed in each host stanza.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_create_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder create [name] [flags]

Flags:
-h, --help help for create
--parameter-file string Specify a file path with parameter values.
Consumes $CODER_PARAMETER_FILE
--rich-parameter-file string Specify a file path with values for rich
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_delete_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Aliases:
delete, rm

Flags:
-h, --help help for delete
--orphan Delete a workspace without deleting its resources. This can delete a
workspace in a broken state, but may also lead to unaccounted cloud resources.
-y, --yes Bypass prompts
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_dotfiles_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Get Started:
$ coder dotfiles --yes git@github.com:example/dotfiles.git

Flags:
-h, --help help for dotfiles
--symlink-dir string Specifies the directory for the dotfiles symlink destinations. If
empty will use $HOME.
Consumes $CODER_SYMLINK_DIR
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_list_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Flags:
template, status, last built, outdated, starts at, stops after
(default [workspace,template,status,last built,outdated,starts
at,stops after])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")
--search string Search for a workspace with a query. (default "owner:me")

Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_login_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Flags:
--first-user-username string Specifies a username to use if creating the first user
for the deployment.
Consumes $CODER_FIRST_USER_USERNAME
-h, --help help for login

Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_logout_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder logout [flags]

Flags:
-h, --help help for logout
-y, --yes Bypass prompts

Global Flags:
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_ping_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder ping <workspace> [flags]

Flags:
-h, --help help for ping
-n, --num int Specifies the number of pings to perform. (default 10)
-t, --timeout duration Specifies how long to wait for a ping to complete. (default 5s)
-v, --verbose Enables verbose logging.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_port-forward_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Get Started:
$ coder port-forward <workspace> --tcp 8080,9000:3000,9090-9092,10000-10002:10010-10012

Flags:
-h, --help help for port-forward
-p, --tcp stringArray Forward TCP port(s) from the workspace to the local machine.
Consumes $CODER_PORT_FORWARD_TCP
--udp stringArray Forward UDP port(s) from the workspace to the local machine. The UDP
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_publickey_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Aliases:
publickey, pubkey

Flags:
-h, --help help for publickey
--reset Regenerate your public key. This will require updating the key on any services
it's registered with.
-y, --yes Bypass prompts
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_rename_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder rename <workspace> <new name> [flags]

Flags:
-h, --help help for rename
-y, --yes Bypass prompts

Global Flags:
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_reset-password_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder reset-password <username> [flags]

Flags:
-h, --help help for reset-password
--postgres-url string URL of a PostgreSQL database to connect to.
Consumes $CODER_PG_CONNECTION_URL

Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_restart_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder restart <workspace> [flags]

Flags:
-h, --help help for restart
-y, --yes Bypass prompts

Global Flags:
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_scaletest_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Commands:
cleanup Cleanup any orphaned scaletest resources
create-workspaces Creates many workspaces and waits for them to be ready

Flags:
-h, --help help for scaletest


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_scaletest_cleanup_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Flags:
Consumes $CODER_LOADTEST_CLEANUP_JOB_TIMEOUT (default 5m0s)
--cleanup-timeout duration Timeout for the entire cleanup run. 0 means unlimited.
Consumes $CODER_LOADTEST_CLEANUP_TIMEOUT (default 30m0s)
-h, --help help for cleanup

Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ Other Flags:
Consumes $CODER_LOADTEST_CONNECT_URL
-c, --count int Required: Number of workspaces to create.
Consumes $CODER_LOADTEST_COUNT (default 1)
-h, --help help for create-workspaces
--job-timeout duration Timeout per job. Jobs may take longer to complete
under higher concurrency limits.
Consumes $CODER_LOADTEST_JOB_TIMEOUT (default 5m0s)
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_schedule_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ Commands:
start Edit workspace start schedule
stop Edit workspace stop schedule

Flags:
-h, --help help for schedule


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_schedule_override-stop_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Usage:
Get Started:
$ coder schedule override-stop my-workspace 90m

Flags:
-h, --help help for override-stop


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_schedule_show_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ Shows the following information for the given workspace:
Usage:
coder schedule show <workspace-name> [flags]

Flags:
-h, --help help for show


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_schedule_start_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ Get Started:

$ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin

Flags:
-h, --help help for start


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_schedule_stop_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ Usage:
Get Started:
$ coder schedule stop my-workspace 2h30m

Flags:
-h, --help help for stop


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_server_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,6 @@ Other Flags:
commas, or enter '*' to opt-in to
all available experiments.
Consumes $CODER_EXPERIMENTS
-h, --help help for server
--postgres-url string URL of a PostgreSQL database. If
empty, PostgreSQL binaries will be
downloaded from Maven
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_server_create-admin-user_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Usage:
Flags:
--email string The email of the new user. If not specified, you will be
prompted via stdin. Consumes $CODER_EMAIL.
-h, --help help for create-admin-user
--password string The password of the new user. If not specified, you will
be prompted via stdin. Consumes $CODER_PASSWORD.
--postgres-url string URL of a PostgreSQL database. If empty, the built-in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder server postgres-builtin-serve [flags]

Flags:
-h, --help help for postgres-builtin-serve
--raw-url Output the raw connection URL instead of a psql command.

Global Flags:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder server postgres-builtin-url [flags]

Flags:
-h, --help help for postgres-builtin-url
--raw-url Output the raw connection URL instead of a psql command.

Global Flags:
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_show_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ Display details of a workspace's resources and agents
Usage:
coder show <workspace> [flags]

Flags:
-h, --help help for show


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_speedtest_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Usage:

Flags:
-d, --direct Specifies whether to wait for a direct connection before testing speed.
-h, --help help for speedtest
-r, --reverse Specifies whether to run in reverse mode where the client receives and
the server sends.
-t, --time duration Specifies the duration to monitor traffic. (default 5s)
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_ssh_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Flags:
a GPG agent is already running in the workspace, it
will be attempted to be killed.
Consumes $CODER_SSH_FORWARD_GPG
-h, --help help for ssh
--identity-agent string Specifies which identity agent to use (overrides
$SSH_AUTH_SOCK), forward agent must also be
enabled.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_start_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder start <workspace> [flags]

Flags:
-h, --help help for start
-y, --yes Bypass prompts

Global Flags:
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_state_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Commands:
pull
push

Flags:
-h, --help help for state


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_state_pull_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Usage:

Flags:
-b, --build int Specify a workspace build to target by name.
-h, --help help for pull

Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_state_push_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Usage:

Flags:
-b, --build int Specify a workspace build to target by name.
-h, --help help for push

Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_stop_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder stop <workspace> [flags]

Flags:
-h, --help help for stop
-y, --yes Bypass prompts

Global Flags:
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_templates_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ Commands:
push Push a new template version from the current directory or as specified by flag
versions Manage different versions of the specified template

Flags:
-h, --help help for templates


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_templates_create_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Other Flags:
template. (default 24h0m0s)
-d, --directory string Specify the directory to create from, use '-' to read
tar from stdin (default "[current directory]")
-h, --help help for create
--parameter-file string Specify a file path with parameter values.
--variable stringArray Specify a set of values for Terraform-managed variables.
--variables-file string Specify a file path with values for Terraform-managed
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_templates_delete_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder templates delete [name...] [flags]

Flags:
-h, --help help for delete
-y, --yes Bypass prompts

Global Flags:
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_templates_edit_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Flags:
workspaces created from this template to this value.
--description string Edit the template description
--display-name string Edit the template display name
-h, --help help for edit
--icon string Edit the template icon path
--name string Edit the template name
-y, --yes Bypass prompts
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_templates_init_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ Get started with a templated template.
Usage:
coder templates init [directory] [flags]

Flags:
-h, --help help for init


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_templates_list_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Flags:
-c, --column strings Columns to display in table output. Available columns: name, created
at, last updated, organization id, provisioner, active version id,
used by, default ttl (default [name,last updated,used by])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")

Global Flags:
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_templates_plan_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ Plan a template push from the current directory
Usage:
coder templates plan <directory> [flags]

Flags:
-h, --help help for plan


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_templates_pull_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Usage:
coder templates pull <name> [destination] [flags]

Flags:
-h, --help help for pull
-y, --yes Bypass prompts

Global Flags:
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_templates_push_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Other Flags:
values from active template version
-d, --directory string Specify the directory to create from, use '-' to read
tar from stdin (default "[current directory]")
-h, --help help for push
--name string Specify a name for the new template version. It will be
automatically generated if not provided.
--parameter-file string Specify a file path with parameter values.
Expand Down
3 changes: 1 addition & 2 deletions cli/testdata/coder_templates_versions_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ Get Started:
Commands:
list List all the versions of the specified template

Flags:
-h, --help help for versions


Global Flags:
--global-config coder Path to the global coder config directory.
Expand Down
1 change: 0 additions & 1 deletion cli/testdata/coder_templates_versions_list_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Flags:
-c, --column strings Columns to display in table output. Available columns: name, created
at, created by, status, active (default [name,created at,created
by,status,active])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")

Global Flags:
Expand Down
Loading