coder · matifali · Oct 9, 2024 · Oct 3, 2024 · Oct 3, 2024 · Oct 4, 2024
diff --git a/cli/parameter.go b/cli/parameter.go
@@ -58,7 +58,7 @@ func (wpf *workspaceParameterFlags) cliParameters() []serpent.Option {
 		serpent.Option{
 			Flag:        "rich-parameter-file",
 			Env:         "CODER_RICH_PARAMETER_FILE",
-			Description: "Specify a file path with values for rich parameters defined in the template.",
+			Description: "Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters.",
 			Value:       serpent.StringOf(&wpf.richParameterFile),
 		},
 	}

diff --git a/cli/testdata/coder_create_--help.golden b/cli/testdata/coder_create_--help.golden
@@ -28,7 +28,8 @@ OPTIONS:
 
       --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
           Specify a file path with values for rich parameters defined in the
-          template.
+          template. The file should be in YAML format, containing key-value
+          pairs for the parameters.
 
       --start-at string, $CODER_WORKSPACE_START_AT
           Specify the workspace autostart schedule. Check coder schedule start

diff --git a/cli/testdata/coder_restart_--help.golden b/cli/testdata/coder_restart_--help.golden
@@ -24,7 +24,8 @@ OPTIONS:
 
       --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
           Specify a file path with values for rich parameters defined in the
-          template.
+          template. The file should be in YAML format, containing key-value
+          pairs for the parameters.
 
   -y, --yes bool
           Bypass prompts.

diff --git a/cli/testdata/coder_start_--help.golden b/cli/testdata/coder_start_--help.golden
@@ -24,7 +24,8 @@ OPTIONS:
 
       --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
           Specify a file path with values for rich parameters defined in the
-          template.
+          template. The file should be in YAML format, containing key-value
+          pairs for the parameters.
 
   -y, --yes bool
           Bypass prompts.

diff --git a/cli/testdata/coder_update_--help.golden b/cli/testdata/coder_update_--help.golden
@@ -26,7 +26,8 @@ OPTIONS:
 
       --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
           Specify a file path with values for rich parameters defined in the
-          template.
+          template. The file should be in YAML format, containing key-value
+          pairs for the parameters.
 
 ———
 Run `coder --help` for a list of global options.
diff --git a/docs/reference/cli/create.md b/docs/reference/cli/create.md
diff --git a/docs/reference/cli/restart.md b/docs/reference/cli/restart.md
diff --git a/docs/reference/cli/start.md b/docs/reference/cli/start.md
diff --git a/docs/reference/cli/update.md b/docs/reference/cli/update.md