synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: explain --rich-parameter-file format (#14941)

Browse Source
This commit is contained in:
Joobi S B
2024-10-09 10:04:24 +05:30
committed by GitHub
parent a0787b71a1
commit 26df33ac88
9 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cli/parameter.go
View File

@ -58,7 +58,7 @@ func (wpf *workspaceParameterFlags) cliParameters() []serpent.Option {
serpent.Option{ serpent.Option{
Flag: "rich-parameter-file", Flag: "rich-parameter-file",
Env: "CODER_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), Value: serpent.StringOf(&wpf.richParameterFile),
}, },
} }

3
cli/testdata/coder_create_--help.golden vendored
View File

@ -28,7 +28,8 @@ OPTIONS:
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the 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 --start-at string, $CODER_WORKSPACE_START_AT
Specify the workspace autostart schedule. Check coder schedule start Specify the workspace autostart schedule. Check coder schedule start

3
cli/testdata/coder_restart_--help.golden vendored
View File

@ -24,7 +24,8 @@ OPTIONS:
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the 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 -y, --yes bool
Bypass prompts. Bypass prompts.

3
cli/testdata/coder_start_--help.golden vendored
View File

@ -24,7 +24,8 @@ OPTIONS:
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the 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 -y, --yes bool
Bypass prompts. Bypass prompts.

3
cli/testdata/coder_update_--help.golden vendored
View File

@ -26,7 +26,8 @@ OPTIONS:
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the 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. Run `coder --help` for a list of global options.

2
docs/reference/cli/create.md generated
View File

@ -90,7 +90,7 @@ Rich parameter value in the format "name=value".
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> | | Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template. 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.
### --parameter-default ### --parameter-default

2
docs/reference/cli/restart.md generated
View File

@ -53,7 +53,7 @@ Rich parameter value in the format "name=value".
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> | | Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template. 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.
### --parameter-default ### --parameter-default

2
docs/reference/cli/start.md generated
View File

@ -53,7 +53,7 @@ Rich parameter value in the format "name=value".
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> | | Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template. 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.
### --parameter-default ### --parameter-default

2
docs/reference/cli/update.md generated
View File

@ -51,7 +51,7 @@ Rich parameter value in the format "name=value".
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> | | Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template. 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.
### --parameter-default ### --parameter-default