file:<local file>+
diff --git a/dev-info.html b/dev-info.html index 6647911e69..8bbbbbc8e1 100644 --- a/dev-info.html +++ b/dev-info.html @@ -764,7 +764,7 @@
fcli config public-key import -f=<pemFile> -n=<name> [[-h] - [--env-prefix=<envPrefix>] [--log-file=<logFile>] - [--log-level=<logLevel>]] ] [--store=_variableName - _ ] [--to-file=<outputFile>_]]
+fcli config public-key import -n=<name> [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName + _ ] [--to-file=<outputFile>_]] + source
PEM file to be imported.
-Name for the imported public key.
@@ -117,12 +114,50 @@Public key to be imported into the fcli trusted public key store. 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 import 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.+
Manage fcli proxy configurations.
Manage fcli trusted public keys.
fcli fod action get [-z=<source>] [[-h] [--env-prefix=<envPrefix>] - [--log-file=<logFile>] [--log-level=<logLevel>]] <action>
+fcli fod action get [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>
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. 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.+
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.
@@ -102,7 +132,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.
fcli fod action help [-z=<source>] [[-h] [--env-prefix=<envPrefix>] - [--log-file=<logFile>] [--log-level=<logLevel>]] <action>
+fcli fod action help [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>
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. 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.+
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.
@@ -99,7 +129,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.
fcli fod action import [-z=<source>] [[-h] [--env-prefix=<envPrefix>] - [--log-file=<logFile>] [--log-level=<logLevel>]] - ] [--store=_variableName - _ ] [--to-file=<outputFile>_]] [<action>]
+fcli fod action import [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[=<propertyNames>]] + [--to-file=<outputFile>]] [<action>]
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. 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.+
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.
@@ -126,7 +156,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.
fcli fod action run [-y] [--progress=<type>] [-z=<source>] +
fcli fod action run [-y] [--progress=<type>] [--pubkey=source] [-z=<source>] [--<action-parameter>=<value>]… [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] @@ -74,6 +74,35 @@
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.
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. 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.+
Confirm running an action with invalid signature.
@@ -131,7 +160,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.
Fcli supports workflow-style actions defined in YAML files. Many built-in actions are provided, focusing on data export and CI/CD integration. Users can also develop their own custom actions, either from scratch or by customizing built-in actions. Note though that the ability to run custom actions is currently considered PREVIEW functionality; custom actions developed for this fcli version may fail on other fcli versions. We will stabilize action syntax over the next couple of fcli versions, and provide proper backward compatibility so that newer fcli versions can run actions developed for older fcli versions.
+Fcli supports workflow-style actions defined in YAML files. Many built-in actions are provided, focusing on data export and CI/CD integration. Users can also develop their own custom actions, either from scratch or by customizing built-in actions.
+Note that the ability to run custom actions is currently considered PREVIEW functionality; custom actions developed for this fcli version may fail on other fcli versions, even between minor fcli releases. We will stabilize action syntax over the next couple of fcli versions, after which any major action schema changes will be considered a major fcli version change. This fcli version supports the following action schema versions: null.
Actions can potentially perform dangerous operations like deleting data or posting data to 3rd-party systems, so it is recommended to only run trusted actions. Action authors can sign their actions using the action sign
command; actions without a (valid) signature will require confirmation when trying to run them. Trusted public keys can be configured through the fcli config public-key
commands.
fcli ssc action get [-z=<source>] [[-h] [--env-prefix=<envPrefix>] - [--log-file=<logFile>] [--log-level=<logLevel>]] <action>
+fcli ssc action get [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>
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. 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.+
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.
@@ -102,7 +132,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.
fcli ssc action help [-z=<source>] [[-h] [--env-prefix=<envPrefix>] - [--log-file=<logFile>] [--log-level=<logLevel>]] <action>
+fcli ssc action help [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>
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. 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.+
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.
@@ -99,7 +129,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.
fcli ssc action import [-z=<source>] [[-h] [--env-prefix=<envPrefix>] - [--log-file=<logFile>] [--log-level=<logLevel>]] - ] [--store=_variableName - _ ] [--to-file=<outputFile>_]] [<action>]
+fcli ssc action import [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[=<propertyNames>]] + [--to-file=<outputFile>]] [<action>]
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. 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.+
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.
@@ -126,7 +156,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.
fcli ssc action run [-y] [--progress=<type>] [-z=<source>] +
fcli ssc action run [-y] [--progress=<type>] [--pubkey=source] [-z=<source>] [--<action-parameter>=<value>]… [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] @@ -74,6 +74,35 @@
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.
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. 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.+
Confirm running an action with invalid signature.
@@ -131,7 +160,7 @@The action to load; either simple name or local or remote action YAML file location.
+The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.
Fcli supports workflow-style actions defined in YAML files. Many built-in actions are provided, focusing on data export and CI/CD integration. Users can also develop their own custom actions, either from scratch or by customizing built-in actions. Note though that the ability to run custom actions is currently considered PREVIEW functionality; custom actions developed for this fcli version may fail on other fcli versions. We will stabilize action syntax over the next couple of fcli versions, and provide proper backward compatibility so that newer fcli versions can run actions developed for older fcli versions.
+Fcli supports workflow-style actions defined in YAML files. Many built-in actions are provided, focusing on data export and CI/CD integration. Users can also develop their own custom actions, either from scratch or by customizing built-in actions.
+Note that the ability to run custom actions is currently considered PREVIEW functionality; custom actions developed for this fcli version may fail on other fcli versions, even between minor fcli releases. We will stabilize action syntax over the next couple of fcli versions, after which any major action schema changes will be considered a major fcli version change. This fcli version supports the following action schema versions: null.
Actions can potentially perform dangerous operations like deleting data or posting data to 3rd-party systems, so it is recommended to only run trusted actions. Action authors can sign their actions using the action sign
command; actions without a (valid) signature will require confirmation when trying to run them. Trusted public keys can be configured through the fcli config public-key
commands.