Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit26df33a

Browse files
authored
docs: explain --rich-parameter-file format (#14941)
1 parenta0787b7 commit26df33a

File tree

9 files changed

+13
-9
lines changed

9 files changed

+13
-9
lines changed

‎cli/parameter.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func (wpf *workspaceParameterFlags) cliParameters() []serpent.Option {
5858
serpent.Option{
5959
Flag:"rich-parameter-file",
6060
Env:"CODER_RICH_PARAMETER_FILE",
61-
Description:"Specify a file path with values for rich parameters defined in the template.",
61+
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.",
6262
Value:serpent.StringOf(&wpf.richParameterFile),
6363
},
6464
}

‎cli/testdata/coder_create_--help.golden

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ OPTIONS:
2828

2929
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
3030
Specify a file path with values for rich parameters defined in the
31-
template.
31+
template. The file should be in YAML format, containing key-value
32+
pairs for the parameters.
3233

3334
--start-at string, $CODER_WORKSPACE_START_AT
3435
Specify the workspace autostart schedule. Check coder schedule start

‎cli/testdata/coder_restart_--help.golden

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ OPTIONS:
2424

2525
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
2626
Specify a file path with values for rich parameters defined in the
27-
template.
27+
template. The file should be in YAML format, containing key-value
28+
pairs for the parameters.
2829

2930
-y, --yes bool
3031
Bypass prompts.

‎cli/testdata/coder_start_--help.golden

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ OPTIONS:
2424

2525
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
2626
Specify a file path with values for rich parameters defined in the
27-
template.
27+
template. The file should be in YAML format, containing key-value
28+
pairs for the parameters.
2829

2930
-y, --yes bool
3031
Bypass prompts.

‎cli/testdata/coder_update_--help.golden

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ OPTIONS:
2626

2727
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
2828
Specify a file path with values for rich parameters defined in the
29-
template.
29+
template. The file should be in YAML format, containing key-value
30+
pairs for the parameters.
3031

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

‎docs/reference/cli/create.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎docs/reference/cli/restart.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎docs/reference/cli/start.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎docs/reference/cli/update.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp