Skip to content

Commit f703a5b

Browse files
ammarioammario
authored
chore(cli): lighten flags on help page (#9606)
1 parent e361f11 commit f703a5b

File tree

62 files changed

+413
-413
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+413
-413
lines changed

‎cli/help.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ var usageTemplate = template.Must(
6060
},
6161
"keyword": func(s string) string {
6262
return pretty.Sprint(
63-
pretty.FgColor(cliui.Color("#0173ff")),
63+
pretty.FgColor(cliui.Color("#87ceeb")),
6464
s,
6565
)
6666
},

‎cli/testdata/coder_--help.golden

+10-10
Original file line numberDiff line numberDiff line change
@@ -53,38 +53,38 @@ coder v0.0.0-devel
5353
Global options are applied to all commands. They can be set using environment
5454
variables or flags.
5555

56-
--debug-options bool
56+
--debug-options bool
5757
Print all options, how they're set, then exit.
5858

59-
--disable-direct-connections bool, $CODER_DISABLE_DIRECT_CONNECTIONS
59+
--disable-direct-connections bool, $CODER_DISABLE_DIRECT_CONNECTIONS
6060
Disable direct (P2P) connections to workspaces.
6161

62-
--global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
62+
--global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
6363
Path to the global `coder` config directory.
6464

65-
--header string-array, $CODER_HEADER
65+
--header string-array, $CODER_HEADER
6666
Additional HTTP headers added to all requests. Provide as key=value.
6767
Can be specified multiple times.
6868

69-
--header-command string, $CODER_HEADER_COMMAND
69+
--header-command string, $CODER_HEADER_COMMAND
7070
An external command that outputs additional HTTP headers added to all
7171
requests. The command must output each header as `key=value` on its
7272
own line.
7373

74-
--no-feature-warning bool, $CODER_NO_FEATURE_WARNING
74+
--no-feature-warning bool, $CODER_NO_FEATURE_WARNING
7575
Suppress warnings about unlicensed features.
7676

77-
--no-version-warning bool, $CODER_NO_VERSION_WARNING
77+
--no-version-warning bool, $CODER_NO_VERSION_WARNING
7878
Suppress warning when client and server versions do not match.
7979

80-
--token string, $CODER_SESSION_TOKEN
80+
--token string, $CODER_SESSION_TOKEN
8181
Specify an authentication token. For security reasons setting
8282
CODER_SESSION_TOKEN is preferred.
8383

84-
--url url, $CODER_URL
84+
--url url, $CODER_URL
8585
URL to a deployment.
8686

87-
-v, --verbose bool, $CODER_VERBOSE
87+
-v, --verbose bool, $CODER_VERBOSE
8888
Enable verbose output.
8989

9090
———

‎cli/testdata/coder_agent_--help.golden

+11-11
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,38 @@ coder v0.0.0-devel
66
Starts the Coder workspace agent.
77

88
OPTIONS:
9-
--log-human string, $CODER_AGENT_LOGGING_HUMAN (default: /dev/stderr)
9+
--log-human string, $CODER_AGENT_LOGGING_HUMAN (default: /dev/stderr)
1010
Output human-readable logs to a given file.
1111

12-
--log-json string, $CODER_AGENT_LOGGING_JSON
12+
--log-json string, $CODER_AGENT_LOGGING_JSON
1313
Output JSON logs to a given file.
1414

15-
--log-stackdriver string, $CODER_AGENT_LOGGING_STACKDRIVER
15+
--log-stackdriver string, $CODER_AGENT_LOGGING_STACKDRIVER
1616
Output Stackdriver compatible logs to a given file.
1717

18-
--auth string, $CODER_AGENT_AUTH (default: token)
18+
--auth string, $CODER_AGENT_AUTH (default: token)
1919
Specify the authentication type to use for the agent.
2020

21-
--debug-address string, $CODER_AGENT_DEBUG_ADDRESS (default: 127.0.0.1:2113)
21+
--debug-address string, $CODER_AGENT_DEBUG_ADDRESS (default: 127.0.0.1:2113)
2222
The bind address to serve a debug HTTP server.
2323

24-
--log-dir string, $CODER_AGENT_LOG_DIR (default: /tmp)
24+
--log-dir string, $CODER_AGENT_LOG_DIR (default: /tmp)
2525
Specify the location for the agent log files.
2626

27-
--no-reap bool
27+
--no-reap bool
2828
Do not start a process reaper.
2929

30-
--pprof-address string, $CODER_AGENT_PPROF_ADDRESS (default: 127.0.0.1:6060)
30+
--pprof-address string, $CODER_AGENT_PPROF_ADDRESS (default: 127.0.0.1:6060)
3131
The address to serve pprof.
3232

33-
--prometheus-address string, $CODER_AGENT_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
33+
--prometheus-address string, $CODER_AGENT_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
3434
The bind address to serve Prometheus metrics.
3535

36-
--ssh-max-timeout duration, $CODER_AGENT_SSH_MAX_TIMEOUT (default: 72h)
36+
--ssh-max-timeout duration, $CODER_AGENT_SSH_MAX_TIMEOUT (default: 72h)
3737
Specify the max timeout for a SSH connection, it is advisable to set
3838
it to a minimum of 60s, but no more than 72h.
3939

40-
--tailnet-listen-port int, $CODER_AGENT_TAILNET_LISTEN_PORT (default: 0)
40+
--tailnet-listen-port int, $CODER_AGENT_TAILNET_LISTEN_PORT (default: 0)
4141
Specify a static port for Tailscale to use for listening.
4242

4343
———

‎cli/testdata/coder_config-ssh_--help.golden

+9-9
Original file line numberDiff line numberDiff line change
@@ -16,39 +16,39 @@ coder v0.0.0-devel
1616
$ coder config-ssh --dry-run
1717

1818
OPTIONS:
19-
--coder-binary-path string, $CODER_SSH_CONFIG_BINARY_PATH
19+
--coder-binary-path string, $CODER_SSH_CONFIG_BINARY_PATH
2020
Optionally specify the absolute path to the coder binary used in
2121
ProxyCommand. By default, the binary invoking this command ('config
2222
ssh') is used.
2323

24-
-n, --dry-run bool, $CODER_SSH_DRY_RUN
24+
-n, --dry-run bool, $CODER_SSH_DRY_RUN
2525
Perform a trial run with no changes made, showing a diff at the end.
2626

27-
--force-unix-filepaths bool, $CODER_CONFIGSSH_UNIX_FILEPATHS
27+
--force-unix-filepaths bool, $CODER_CONFIGSSH_UNIX_FILEPATHS
2828
By default, 'config-ssh' uses the os path separator when writing the
2929
ssh config. This might be an issue in Windows machine that use a
3030
unix-like shell. This flag forces the use of unix file paths (the
3131
forward slash '/').
3232

33-
--ssh-config-file string, $CODER_SSH_CONFIG_FILE (default: ~/.ssh/config)
33+
--ssh-config-file string, $CODER_SSH_CONFIG_FILE (default: ~/.ssh/config)
3434
Specifies the path to an SSH config.
3535

36-
--ssh-host-prefix string, $CODER_CONFIGSSH_SSH_HOST_PREFIX
36+
--ssh-host-prefix string, $CODER_CONFIGSSH_SSH_HOST_PREFIX
3737
Override the default host prefix.
3838

39-
-o, --ssh-option string-array, $CODER_SSH_CONFIG_OPTS
39+
-o, --ssh-option string-array, $CODER_SSH_CONFIG_OPTS
4040
Specifies additional SSH options to embed in each host stanza.
4141

42-
--use-previous-options bool, $CODER_SSH_USE_PREVIOUS_OPTIONS
42+
--use-previous-options bool, $CODER_SSH_USE_PREVIOUS_OPTIONS
4343
Specifies whether or not to keep options from previous run of
4444
config-ssh.
4545

46-
--wait yes|no|auto, $CODER_CONFIGSSH_WAIT (default: auto)
46+
--wait yes|no|auto, $CODER_CONFIGSSH_WAIT (default: auto)
4747
Specifies whether or not to wait for the startup script to finish
4848
executing. Auto means that the agent startup script behavior
4949
configured in the workspace template is used.
5050

51-
-y, --yes bool
51+
-y, --yes bool
5252
Bypass prompts.
5353

5454
———

‎cli/testdata/coder_create_--help.golden

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,25 @@ coder v0.0.0-devel
1010
$ coder create <username>/<workspace_name>
1111

1212
OPTIONS:
13-
--parameter string-array, $CODER_RICH_PARAMETER
13+
--parameter string-array, $CODER_RICH_PARAMETER
1414
Rich parameter value in the format "name=value".
1515

16-
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
16+
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
1717
Specify a file path with values for rich parameters defined in the
1818
template.
1919

20-
--start-at string, $CODER_WORKSPACE_START_AT
20+
--start-at string, $CODER_WORKSPACE_START_AT
2121
Specify the workspace autostart schedule. Check coder schedule start
2222
--help for the syntax.
2323

24-
--stop-after duration, $CODER_WORKSPACE_STOP_AFTER
24+
--stop-after duration, $CODER_WORKSPACE_STOP_AFTER
2525
Specify a duration after which the workspace should shut down (e.g.
2626
8h).
2727

28-
-t, --template string, $CODER_TEMPLATE_NAME
28+
-t, --template string, $CODER_TEMPLATE_NAME
2929
Specify a template name.
3030

31-
-y, --yes bool
31+
-y, --yes bool
3232
Bypass prompts.
3333

3434
———

‎cli/testdata/coder_delete_--help.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ coder v0.0.0-devel
88
Aliases: rm
99

1010
OPTIONS:
11-
--orphan bool
11+
--orphan bool
1212
Delete a workspace without deleting its resources. This can delete a
1313
workspace in a broken state, but may also lead to unaccounted cloud
1414
resources.
1515

16-
-y, --yes bool
16+
-y, --yes bool
1717
Bypass prompts.
1818

1919
———

‎cli/testdata/coder_dotfiles_--help.golden

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ coder v0.0.0-devel
1010
$ coder dotfiles --yes git@github.com:example/dotfiles.git
1111

1212
OPTIONS:
13-
-b, --branch string
13+
-b, --branch string
1414
Specifies which branch to clone. If empty, will default to cloning the
1515
default branch or using the existing branch in the cloned repo on
1616
disk.
1717

18-
--symlink-dir string, $CODER_SYMLINK_DIR
18+
--symlink-dir string, $CODER_SYMLINK_DIR
1919
Specifies the directory for the dotfiles symlink destinations. If
2020
empty, will use $HOME.
2121

22-
-y, --yes bool
22+
-y, --yes bool
2323
Bypass prompts.
2424

2525
———

‎cli/testdata/coder_list_--help.golden

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ coder v0.0.0-devel
88
Aliases: ls
99

1010
OPTIONS:
11-
-a, --all bool
11+
-a, --all bool
1212
Specifies whether all workspaces will be listed or not.
1313

14-
-c, --column string-array (default: workspace,template,status,healthy,last built,outdated,starts at,stops after)
14+
-c, --column string-array (default: workspace,template,status,healthy,last built,outdated,starts at,stops after)
1515
Columns to display in table output. Available columns: workspace,
1616
template, status, healthy, last built, outdated, starts at, stops
1717
after, daily cost.
1818

19-
-o, --output string (default: table)
19+
-o, --output string (default: table)
2020
Output format. Available formats: table, json.
2121

22-
--search string (default: owner:me)
22+
--search string (default: owner:me)
2323
Search for a workspace with a query.
2424

2525
———

‎cli/testdata/coder_login_--help.golden

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ coder v0.0.0-devel
66
Authenticate with Coder deployment
77

88
OPTIONS:
9-
--first-user-email string, $CODER_FIRST_USER_EMAIL
9+
--first-user-email string, $CODER_FIRST_USER_EMAIL
1010
Specifies an email address to use if creating the first user for the
1111
deployment.
1212

13-
--first-user-password string, $CODER_FIRST_USER_PASSWORD
13+
--first-user-password string, $CODER_FIRST_USER_PASSWORD
1414
Specifies a password to use if creating the first user for the
1515
deployment.
1616

17-
--first-user-trial bool, $CODER_FIRST_USER_TRIAL
17+
--first-user-trial bool, $CODER_FIRST_USER_TRIAL
1818
Specifies whether a trial license should be provisioned for the Coder
1919
deployment or not.
2020

21-
--first-user-username string, $CODER_FIRST_USER_USERNAME
21+
--first-user-username string, $CODER_FIRST_USER_USERNAME
2222
Specifies a username to use if creating the first user for the
2323
deployment.
2424

25-
--use-token-as-session bool
25+
--use-token-as-session bool
2626
By default, the CLI will generate a new session token when logging in.
2727
This flag will instead use the provided token as the session token.
2828

‎cli/testdata/coder_logout_--help.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ coder v0.0.0-devel
66
Unauthenticate your local session
77

88
OPTIONS:
9-
-y, --yes bool
9+
-y, --yes bool
1010
Bypass prompts.
1111

1212
———

‎cli/testdata/coder_ping_--help.golden

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ coder v0.0.0-devel
66
Ping a workspace
77

88
OPTIONS:
9-
-n, --num int (default: 10)
9+
-n, --num int (default: 10)
1010
Specifies the number of pings to perform.
1111

12-
-t, --timeout duration (default: 5s)
12+
-t, --timeout duration (default: 5s)
1313
Specifies how long to wait for a ping to complete.
1414

15-
--wait duration (default: 1s)
15+
--wait duration (default: 1s)
1616
Specifies how long to wait between pings.
1717

1818
———

‎cli/testdata/coder_port-forward_--help.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ coder v0.0.0-devel
3434
$ coder port-forward <workspace> --tcp 1.2.3.4:8080:8080
3535

3636
OPTIONS:
37-
-p, --tcp string-array, $CODER_PORT_FORWARD_TCP
37+
-p, --tcp string-array, $CODER_PORT_FORWARD_TCP
3838
Forward TCP port(s) from the workspace to the local machine.
3939

40-
--udp string-array, $CODER_PORT_FORWARD_UDP
40+
--udp string-array, $CODER_PORT_FORWARD_UDP
4141
Forward UDP port(s) from the workspace to the local machine. The UDP
4242
connection has TCP-like semantics to support stateful UDP protocols.
4343

‎cli/testdata/coder_publickey_--help.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ coder v0.0.0-devel
88
Aliases: pubkey
99

1010
OPTIONS:
11-
--reset bool
11+
--reset bool
1212
Regenerate your public key. This will require updating the key on any
1313
services it's registered with.
1414

15-
-y, --yes bool
15+
-y, --yes bool
1616
Bypass prompts.
1717

1818
———

‎cli/testdata/coder_rename_--help.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ coder v0.0.0-devel
66
Rename a workspace
77

88
OPTIONS:
9-
-y, --yes bool
9+
-y, --yes bool
1010
Bypass prompts.
1111

1212
———

‎cli/testdata/coder_reset-password_--help.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ coder v0.0.0-devel
66
Directly connect to the database to reset a user's password
77

88
OPTIONS:
9-
--postgres-url string, $CODER_PG_CONNECTION_URL
9+
--postgres-url string, $CODER_PG_CONNECTION_URL
1010
URL of a PostgreSQL database to connect to.
1111

1212
———

‎cli/testdata/coder_restart_--help.golden

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ coder v0.0.0-devel
66
Restart a workspace
77

88
OPTIONS:
9-
--build-option string-array, $CODER_BUILD_OPTION
9+
--build-option string-array, $CODER_BUILD_OPTION
1010
Build option value in the format "name=value".
1111

12-
--build-options bool
12+
--build-options bool
1313
Prompt for one-time build options defined with ephemeral parameters.
1414

15-
-y, --yes bool
15+
-y, --yes bool
1616
Bypass prompts.
1717

1818
———

0 commit comments

Comments
 (0)