0.13.0-rc.5 (824aefd6ad16).
Run this command in an authenticated local terminal or inside a workspace; see the availability above.
Examples
Inspect the supported arguments before running this command. Help is offline and does not modify resources.rig app param --help
Local syntax
Usage: rigbox app param [OPTIONS] <COMMAND>
Arguments and flags
| Argument | Description | Details |
|---|---|---|
--output | Output format [default: human, or rig config set output …] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
--query | Filter output with a JMESPath expression | Global; Value: JMESPATH |
--cli-input-json | Read inputs from a JSON file or ’-’ (stdin) | Global; Value: FILE |
--cli-input-yaml | Read inputs from a YAML file or ’-’ (stdin) | Global; Value: FILE; Conflicts: cli_input_json |
--generate-cli-skeleton | Print a fillable input template, then exit | Global; Default: false |
--no-pager | Do not pipe help output through a pager | Global; Default: false |
-v, --verbose | Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck rig deploy | Global; Default: false |
-h, --help | Print help |
Complete command help
Complete command help
Read and write catalog-app parameters
Usage: rigbox app param [OPTIONS] <COMMAND>
Commands:
ls List all declared parameters and their current values
get Read a single parameter value
set Set one or more parameter values
unset Reset parameters to their defaults
help Print this message or the help of the given subcommand(s)
Options:
--output <OUTPUT>
Output format [default: human, or `rig config set output …`]
[possible values: human, json, yaml, text, table]
--query <JMESPATH>
Filter output with a JMESPath expression
--cli-input-json <FILE>
Read inputs from a JSON file or '-' (stdin)
--cli-input-yaml <FILE>
Read inputs from a YAML file or '-' (stdin)
--generate-cli-skeleton
Print a fillable input template, then exit
--no-pager
Do not pipe help output through a pager
-v, --verbose
Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`
-h, --help
Print help
Workspace syntax
Usage: rigbox app param [OPTIONS] <COMMAND>
Arguments and flags
| Argument | Description | Details |
|---|---|---|
--output | Output format [default: human, or rig config set output …] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
--query | Filter output with a JMESPath expression | Global; Value: JMESPATH |
--no-pager | Do not pipe help output through a pager | Global; Default: false |
-v, --verbose | Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status) | Global; Default: false |
-h, --help | Print help |
Complete command help
Complete command help
Read and write catalog-app parameters
Usage: rigbox app param [OPTIONS] <COMMAND>
Commands:
ls List all declared parameters and their current values
get Read a single parameter value
set Set one or more parameter values
unset Reset parameters to their defaults
help Print this message or the help of the given subcommand(s)
Options:
--output <OUTPUT>
Output format [default: human, or `rig config set output …`]
[possible values: human, json, yaml, text, table]
--query <JMESPATH>
Filter output with a JMESPath expression
--no-pager
Do not pipe help output through a pager
-v, --verbose
Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)
-h, --help
Print help