Synopsis
fcli fod action help [--pubkey=source] [-z=<source>] [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] <action>
Description
This command allows for showing the help information for the given built-in or custom action. The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location.
Options
- --pubkey=source
-
Optional public key to use for verifying action signature. Can be specified as one of:
file:<local file>
url:<url>
string:<string value>
env:<env-var name>
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
- -z, --from-zip=<source>
-
Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.
Generic fcli options (also see documentation link below)
- --debug
-
Enable collection of debug logs.
- --env-prefix=<prefix>
-
Prefix for resolving default option values. Default value: FCLI_DEFAULT.
- -h, --help
-
Use 'fcli [command] -h' to display help for fcli (sub-)commands.
- --log-file=<logFile>
-
Write log output to file. Default: ./fcli.log if logging is enabled.
- --log-level=<logLevel>
-
Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.
- --log-mask=<level>
-
Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.