Mar 23, 2023 · Mar 6, 2023 · Mar 6, 2023 · Mar 6, 2023 · Mar 7, 2023 · Mar 7, 2023
diff --git a/cli/dotfiles.go b/cli/dotfiles.go
 cmd := &clibase.Cmd{
 Use:        "dotfiles <git_repo_url>",
 Middleware: clibase.RequireNArgs(1),
 Short:      "Checkout and install a dotfiles repository from a Git URL",
 Short:      "Personalize your repo by applying a canonical dotfiles repository",
 Long: formatExamples(
 example{
 Description: "Check out and install a dotfiles repository without prompts",
diff --git a/cli/portforward.go b/cli/portforward.go
 client := new(codersdk.Client)
 cmd := &clibase.Cmd{
 Use:     "port-forward <workspace>",
 Short:   "Forward portsfrom machine to a workspace",
 Short:   "Forward portsbetween your local system and the workspace",
 Aliases: []string{"tunnel"},
 Long: formatExamples(
 example{
diff --git a/cli/root.go b/cli/root.go
 Flag:          varVerbose,
 FlagShorthand: "v",
 Env:           "CODER_VERBOSE",
 Description:   "Enable verboselogging.",
 Description:   "Enable verboseoutput.",
 Value:         clibase.BoolOf(&r.verbose),
 Group:         globalGroup,
 },
diff --git a/cli/scaletest.go b/cli/scaletest.go
 cmd := &clibase.Cmd{
 Use:   "scaletest",
 Short: "Run a scale test against the Coder API",
 Long:  "Perform scale tests against the Coder server.",
 Handler: func(inv *clibase.Invocation) error {
 return inv.Command.HelpHandler(inv)
 },
 cmd := &clibase.Cmd{
 Use:   "cleanup",
 Short: "Cleanup any orphaned scaletest resources",
 Long:  "Cleanup scaletest workspaces, then cleanup scaletest users.The strategy flags will apply to each stage of the cleanup process.",
 Long:  "The strategy flags will apply to each stage of the cleanup process.",
 Middleware: clibase.Chain(
 r.InitClient(client),
 ),

 cmd := &clibase.Cmd{
 Use:   "create-workspaces",
 Short: "Creates many workspaces and waits for them to be ready",
 Long: `Creates many users, then creates a workspace for each user andwaits forthem finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.
 Short: "Creates manyusers andworkspaces and waits for them to be ready",
 Long: `After creation,waits forthe workspaces finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.

 It is recommended that all rate limits are disabled on the server before running this scaletest. This test generates many login events which will be rate limited against the (most likely single) IP.`,
 Middleware: r.InitClient(client),
 {
 Flag: "no-cleanup",
 Env:  "CODER_SCALETEST_NO_CLEANUP",
 Description: "Do not clean upworkspaces after the load test has finished. " +
 Description: "Do not clean upresources after the load test has finished. " +
 "Useful for debugging.",
 Value: clibase.BoolOf(&noCleanup),
 },
 Flag:        "connect-mode",
 Env:         "CODER_SCALETEST_CONNECT_MODE",
 Default:     "derp",
 Description: "WireGuard connection mode.",
 Description: "Connection mode.",
 Value:       clibase.EnumOf(&connectMode, "derp", "direct"),
 },
 {
diff --git a/cli/schedule.go b/cli/schedule.go
  * 2m   (2 minutes)
  * 2    (2 minutes)
 `
 scheduleOverrideDescriptionLong = `Override the stop time of a currently running workspace instance.
  * The new stop time is calculated from *now*.
 scheduleOverrideDescriptionLong = `* The new stop time is calculated from *now*.
  * The new stop time must be at least 30 minutes in the future.
  * The workspace template may restrict the maximum workspace runtime.
 `
diff --git a/cli/ssh.go b/cli/ssh.go
 Flag:          "forward-gpg",
 FlagShorthand: "G",
 Env:           "CODER_SSH_FORWARD_GPG",
 Description:   "Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg,gpg2, gpgsm)andgpg-agenttobeinstalled onthehost.",
 Description:   "Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg,gpgconf) on both the clientandworkspace. The GPGagentmust alreadyberunning locally and will not be started by for you. If a GPG agent is already running intheworkspace, coder will attempt to kill it.",
 Value:         clibase.BoolOf(&forwardGPG),
 },
 {
 {
 Flag:        "no-wait",
 Env:         "CODER_SSH_NO_WAIT",
 Description: "Specifies whether to wait for the workspace to be ready before connecting.",
 Description: "Specifies whether to wait for the workspace to be ready before connecting (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.",
 Value:       clibase.BoolOf(&noWait),
 },
 }
diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden
                      coder.workspace"
    create            Create a workspace
    delete            Delete a workspace
    dotfiles          Checkout and install a dotfiles repository from a Git URL
    dotfiles          Personalize your repo by applying a canonical dotfiles
                      repository
    list              List workspaces
    login             Authenticate with Coder deployment
    logout            Unauthenticate your local session
    ping              Ping a workspace
    port-forward      Forward portsfrom machine to a workspace
    port-forward      Forward portsbetween your local system and the workspace
    publickey         Output your Coder public key used for Git operations
    rename            Rename a workspace
    reset-password    Directly connect to the database to reset a user's
          URL to a deployment.

  -v, --verbose, $CODER_VERBOSE
          Enable verboselogging.
          Enable verboseoutput.

 ---
 Report bugs and request features at https://github.com/coder/coder/issues/new
diff --git a/cli/testdata/coder_dotfiles_--help.golden b/cli/testdata/coder_dotfiles_--help.golden
 Usage: coder dotfiles <git_repo_url>

 Checkout and install a dotfiles repository from a Git URL
 Personalize your repo by applying a canonical dotfiles repository

 - Check out and install a dotfiles repository without prompts:

diff --git a/cli/testdata/coder_port-forward_--help.golden b/cli/testdata/coder_port-forward_--help.golden
 Usage: coder port-forward <workspace>

 Forward portsfrom machine to a workspace
 Forward portsbetween your local system and the workspace

 Aliases: tunnel

diff --git a/cli/testdata/coder_scaletest_--help.golden b/cli/testdata/coder_scaletest_--help.golden

 Run a scale test against the Coder API

 Perform scale tests against the Coder server.

 [1mSubcommands[0m
    cleanup              Cleanup any orphaned scaletest resources
    create-workspaces    Creates many workspaces and waits for them to be ready
    create-workspaces    Creates many users and workspaces and waits for them to
                         be ready

 ---
 Run `coder --help` for a list of global options.
diff --git a/cli/testdata/coder_scaletest_cleanup_--help.golden b/cli/testdata/coder_scaletest_cleanup_--help.golden

 Cleanup any orphaned scaletest resources

 Cleanup scaletest workspaces, then cleanup scaletest users. The strategy flags
 will apply to each stage of the cleanup process.
 The strategy flags will apply to each stage of the cleanup process.

 [1mOptions[0m
      --cleanup-concurrency, $CODER_SCALETEST_CLEANUP_CONCURRENCY (default: 1)
diff --git a/cli/testdata/coder_scaletest_create-workspaces_--help.golden b/cli/testdata/coder_scaletest_create-workspaces_--help.golden
 Usage: coder scaletest create-workspaces

 Creates many workspaces and waits for them to be ready
 Creates manyusers andworkspaces and waits for them to be ready

 Creates many users, then creates a workspace for each userandwaits for them
 finish building and fully come online.Optionally runs a command inside each
 workspace, and connects to the workspaceover WireGuard.
 After creation, waits for the workspaces finish buildingandfully come online.
 Optionally runs a command inside each workspace, and connects to the workspace
 over WireGuard.

 It is recommended that all rate limits are disabled on the server before running
 this scaletest. This test generates many login events which will be rate limited
          connection is established.

      --connect-mode, $CODER_SCALETEST_CONNECT_MODE (default: derp) one of derp|direct
 WireGuard connection mode.
 Connection mode.

      --connect-timeout, $CODER_SCALETEST_CONNECT_TIMEOUT (default: 5s)
          Timeout for each request to the --connect-url.
          concurrency limits.

      --no-cleanup, $CODER_SCALETEST_NO_CLEANUP
          Do not clean upworkspaces after the load test has finished. Useful
 fordebugging.
          Do not clean upresources after the load test has finished. Useful for
          debugging.

      --no-plan, $CODER_SCALETEST_NO_PLAN
          Skip the dry-run step to plan the workspace
diff --git a/cli/testdata/coder_schedule_override-stop_--help.golden b/cli/testdata/coder_schedule_override-stop_--help.golden

 Edit stop time of active workspace

 Override the stop time of a currently running workspace instance.
  * The new stop time is calculated from *now*.
 * The new stop time is calculated from *now*.
  * The new stop time must be at least 30 minutes in the future.
  * The workspace template may restrict the maximum workspace runtime.

diff --git a/cli/testdata/coder_ssh_--help.golden b/cli/testdata/coder_ssh_--help.golden

  -G, --forward-gpg, $CODER_SSH_FORWARD_GPG
          Specifies whether to forward the GPG agent. Unsupported on Windows
          workspaces, but supports all clients. Requires gnupg (gpg, gpg2,
          gpgsm) and gpg-agent to be installed on the host.
          workspaces, but supports all clients. Requires gnupg (gpg, gpgconfig)
          on both the client and workspace. The GPG agent must already be
          running locally and will not be started by for you. If a GPG agent is
          already running in the workspace, coder will attempt to kill it.

      --identity-agent, $CODER_SSH_IDENTITY_AGENT
          Specifies which identity agent to use (overrides $SSH_AUTH_SOCK),
          forward agent must also be enabled.

      --no-wait, $CODER_SSH_NO_WAIT
          Specifies whether to wait for the workspace to be ready before
          connecting.
          connecting (only applicable when the login before ready option has not
          been enabled). Note that the workspace agent may still be in the
          process of executing the startup script and the workspace may be in an
          incomplete state.

      --stdio, $CODER_SSH_STDIO
          Specifies whether to emit SSH output over stdin/stdout.
diff --git a/cli/testdata/coder_update_--help.golden b/cli/testdata/coder_update_--help.golden

 Will update and start a given workspace if it is out of date.

 Will update and start a given workspace if it is out of date. Use
 --always-prompt to change the parameter values of the workspace.
 Use --always-prompt to change the parameter values of the workspace.

 [1mOptions[0m
      --always-prompt (default: false)
diff --git a/cli/update.go b/cli/update.go
 Annotations: workspaceCommand,
 Use:         "update <workspace>",
 Short:       "Will update and start a given workspace if it is out of date.",
 Long: "Will update and start a given workspace if it is out of date. Use --always-prompt to change " +
 "the parameter values of the workspace.",
 Long:        "Use --always-prompt to change the parameter values of the workspace.",
 Middleware: clibase.Chain(
 clibase.RequireNArgs(1),
 r.InitClient(client),
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,7 +21,7 @@ func (r RootCmd) dotfiles() clibase.Cmd {
		cmd := &clibase.Cmd{
		Use: "dotfiles <git_repo_url>",
		Middleware: clibase.RequireNArgs(1),
		Short: "Checkout and install a dotfiles repository from a Git URL",
		Short: "Personalize your repo by applying a canonical dotfiles repository",
		Long: formatExamples(
		example{
		Description: "Check out and install a dotfiles repository without prompts",
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,7 +28,7 @@ func (r RootCmd) portForward() clibase.Cmd {
		client := new(codersdk.Client)
		cmd := &clibase.Cmd{
		Use: "port-forward <workspace>",
		Short: "Forward portsfrom machine to a workspace",
		Short: "Forward portsbetween your local system and the workspace",
		Aliases: []string{"tunnel"},
		Long: formatExamples(
		example{
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -267,7 +267,7 @@ func (r RootCmd) Command(subcommands []clibase.Cmd) *clibase.Cmd {
		Flag: varVerbose,
		FlagShorthand: "v",
		Env: "CODER_VERBOSE",
		Description: "Enable verboselogging.",
		Description: "Enable verboseoutput.",
		Value: clibase.BoolOf(&r.verbose),
		Group: globalGroup,
		},
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,7 +36,6 @@ func (r RootCmd) scaletest() clibase.Cmd {
		cmd := &clibase.Cmd{
		Use: "scaletest",
		Short: "Run a scale test against the Coder API",
		Long: "Perform scale tests against the Coder server.",
		Handler: func(inv *clibase.Invocation) error {
		return inv.Command.HelpHandler(inv)
		},
Expand DownExpand Up		@@ -363,7 +362,7 @@ func (r RootCmd) scaletestCleanup() clibase.Cmd {
		cmd := &clibase.Cmd{
		Use: "cleanup",
		Short: "Cleanup any orphaned scaletest resources",
		Long: "Cleanup scaletest workspaces, then cleanup scaletest users.The strategy flags will apply to each stage of the cleanup process.",
		Long: "The strategy flags will apply to each stage of the cleanup process.",
		Middleware: clibase.Chain(
		r.InitClient(client),
		),
Expand DownExpand Up		@@ -546,8 +545,8 @@ func (r RootCmd) scaletestCreateWorkspaces() clibase.Cmd {

		cmd := &clibase.Cmd{
		Use: "create-workspaces",
		Short: "Creates many workspaces and waits for them to be ready",
		Long: `Creates many users, then creates a workspace for each user andwaits forthem finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.
		Short: "Creates manyusers andworkspaces and waits for them to be ready",
		Long: `After creation,waits forthe workspaces finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.

		It is recommended that all rate limits are disabled on the server before running this scaletest. This test generates many login events which will be rate limited against the (most likely single) IP.`,
		Middleware: r.InitClient(client),
Expand DownExpand Up		@@ -857,7 +856,7 @@ parameters are valid for the given template.`,
		{
		Flag: "no-cleanup",
		Env: "CODER_SCALETEST_NO_CLEANUP",
		Description: "Do not clean upworkspaces after the load test has finished. " +
		Description: "Do not clean upresources after the load test has finished. " +
		"Useful for debugging.",
		Value: clibase.BoolOf(&noCleanup),
		},
Expand DownExpand Up		@@ -913,7 +912,7 @@ not start the agent quickly.`,
		Flag: "connect-mode",
		Env: "CODER_SCALETEST_CONNECT_MODE",
		Default: "derp",
		Description: "WireGuard connection mode.",
		Description: "Connection mode.",
		Value: clibase.EnumOf(&connectMode, "derp", "direct"),
		},
		{
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -46,8 +46,7 @@ When enabling scheduled stop, enter a duration in one of the following formats:
		* 2m (2 minutes)
		* 2 (2 minutes)
		`
		scheduleOverrideDescriptionLong = `Override the stop time of a currently running workspace instance.
		* The new stop time is calculated from now.
		scheduleOverrideDescriptionLong = `* The new stop time is calculated from now.
		* The new stop time must be at least 30 minutes in the future.
		* The workspace template may restrict the maximum workspace runtime.
		`
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -246,7 +246,7 @@ func (r RootCmd) ssh() clibase.Cmd {
		Flag: "forward-gpg",
		FlagShorthand: "G",
		Env: "CODER_SSH_FORWARD_GPG",
		Description: "Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg,gpg2, gpgsm)andgpg-agenttobeinstalled onthehost.",
		Description: "Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg,gpgconf) on both the clientandworkspace. The GPGagentmust alreadyberunning locally and will not be started by for you. If a GPG agent is already running intheworkspace, coder will attempt to kill it.",
		Value: clibase.BoolOf(&forwardGPG),
		},
		{
Expand All		@@ -265,7 +265,7 @@ func (r RootCmd) ssh() clibase.Cmd {
		{
		Flag: "no-wait",
		Env: "CODER_SSH_NO_WAIT",
		Description: "Specifies whether to wait for the workspace to be ready before connecting.",
		Description: "Specifies whether to wait for the workspace to be ready before connecting (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.",
		Value: clibase.BoolOf(&noWait),
		},
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,12 +15,13 @@ environments with Terraform.
		coder.workspace"
		create Create a workspace
		delete Delete a workspace
		dotfiles Checkout and install a dotfiles repository from a Git URL
		dotfiles Personalize your repo by applying a canonical dotfiles
		repository
		list List workspaces
		login Authenticate with Coder deployment
		logout Unauthenticate your local session
		ping Ping a workspace
		port-forward Forward portsfrom machine to a workspace
		port-forward Forward portsbetween your local system and the workspace
		publickey Output your Coder public key used for Git operations
		rename Rename a workspace
		reset-password Directly connect to the database to reset a user's
Expand DownExpand Up		@@ -68,7 +69,7 @@ variables or flags.
		URL to a deployment.

		-v, --verbose, $CODER_VERBOSE
		Enable verboselogging.
		Enable verboseoutput.

		---
		Report bugs and request features at https://github.com/coder/coder/issues/new
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,6 @@
		Usage: coder dotfiles <git_repo_url>

		Checkout and install a dotfiles repository from a Git URL
		Personalize your repo by applying a canonical dotfiles repository

		- Check out and install a dotfiles repository without prompts:

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,6 @@
		Usage: coder port-forward <workspace>

		Forward portsfrom machine to a workspace
		Forward portsbetween your local system and the workspace

		Aliases: tunnel

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,11 +2,10 @@ Usage: coder scaletest

		Run a scale test against the Coder API

		Perform scale tests against the Coder server.

		[1mSubcommands[0m
		cleanup Cleanup any orphaned scaletest resources
		create-workspaces Creates many workspaces and waits for them to be ready
		create-workspaces Creates many users and workspaces and waits for them to
		be ready

		---
		Run `coder --help` for a list of global options.