Synopsis
fcli fod action run [--on-invalid-signature=<onInvalidSignature>] [--on-invalid-version=<onUnsupportedVersion>] [--on-no-public-key=<onNoPublicKey>] [--on-unsigned=<onUnsigned>] [--progress=<type>] [--pubkey=source] [-z=<source>] [--<action-parameter>=<value>]… [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] <action>
Description
This command allows for running built-in or custom actions. As actions may perform potentially dangerous operations like deleting data or posting data to 3rd-party systems, you should only run trusted actions. For this reason, fcli requires confirmation when attempting to run an action without a (valid) signature.
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
- --<action-parameter>=<value>
-
Action parameter(s); see 'help' command output to list supported parameters.
- --on-invalid-signature=<onInvalidSignature>
-
Action to take if action signature is invalid. Allowed values: ignore, warn, fail, prompt. Default value: prompt.
- --on-invalid-version=<onUnsupportedVersion>
-
Action to take if action schema version is not supported by this fcli version. Allowed values: ignore, warn, fail, prompt. Default value: prompt.
- --on-no-public-key=<onNoPublicKey>
-
Action to take if no matching public key was found. Allowed values: ignore, warn, fail, prompt. Default value: prompt.
- --on-unsigned=<onUnsigned>
-
Action to take if action isn’t signed. Allowed values: ignore, warn, fail, prompt. Default value: prompt.
- --progress=<type>
-
Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.
- --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. This option will be ignored if action is specified as local or remote action YAML file location.
Session options:
- --session=<sessionName>
-
Name of the FoD session to use for executing this command. Default value: default.
Generic fcli options:
- --env-prefix=<envPrefix>
-
Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.
- -h, --help
-
Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.
- --log-file=<logFile>
-
File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.
- --log-level=<logLevel>
-
Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.