kuflowctl command reference

NOTE

The CLI development is in early preview status. Commands and options can be added or modified.

NOTE

This documentation reflects kuflowctl latest version

The KuFlow CLI (kuflowctl) is a command line tool that allows you to interact with the KuFlow Rest API without the need to interact with the API explicitly or through the application GUI interface. The set of operations supported is less than the set of actions that can be performed through the Rest API or the KuFlow application. However, the development of this utility is constantly evolving. Stay tuned for updates.

kuflowctl commands

• kuflowctl append-log
• kuflowctl save-element-document-by-reference
• kuflowctl save-element-document
• kuflowctl save-element-field
• kuflowctl save-element-principal

Install

IMPORTANT

Currently, for its correct operation, it is necessary to have JAVA installed and available in the system path. The minimum version required is 11.

You can install kuflowctl in the following ways.

• A) Download the archive from Github releases, and unpack it to a location of your choice. Recommended choice.

• B) Build it locally:

  • Clone the KuFlow Cli repo.

To see help for kuflowctl commands, enter the following commands.

Command	Description
kuflowctl -h	Display help for top-level commands and global options
kuflowctl COMMAND -h	Display help for the specified command. See the available commands in the top-level help

Authentication

IMPORTANT

To connect to the KuFlow API it is necessary to have an identifier and password that must be configured in the "Applications" section of the administrative part of the KuFlow application. In addition, although it is not required by default, it is possible to explicitly specify the API access endpoint.

There are different ways to provision the CLI commands with this information. Through, command line options, configuration file or environment variables.

The order of precedence for locating this configuration is as follows:

1. Command line options, through:
   • Individual options
   • Specified configuration file
2. Environment Variables
3. Default configuration file location
   • Try to locate a .kuflow.yml file in the user's home directory

With command line options

We have two options, indicate Client Identifier (--client-id) and Client Secret (--client-secret) or indicate the path to a Configuration File (--environment-file) in YAML format that includes these settings. The format of the configuration file is as follows:

kuflow:
    # ID of the APPLICATION configured in KUFLOW.
    # Get it in "Application details" in the Kuflow APP.
    client-id: YOUR_IDENTIFIER

    # TOKEN of the APPLICATION configured in KUFLOW.
    # Get it in "Application details" in the Kuflow APP.
    client-secret: YOUR_SECRET

For more information, see the application help with kuflowctl --help.

With environment Variables

It is possible to specify settings in the following variables:

KUFLOW_CLIENT_ID=YOUR_IDENTIFIER
KUFLOW_CLIENT_SECRET=YOUR_SECRET

Global modifiers

You can provide the values of some of these modifiers by setting a environment variables or specified environment files instead of including the modifiers in a kuflowctl command.

-h, --help

Show the command line help.

-s, --[no-]silent

Silent output. False by default.

-v, --verbose

Console output verbosity. Specify multiple -v options to increase verbosity. For example, -v -v -v or -vvv.

-V, --version

Print version information.

--endpoint

KuFlow Api endpoint. By default is https://api.kuflow.com. Normally, you should not specify this modifier.

--environment-file

Configuration file in YAML format. Mutually exclusive with respect to the pair "client-id" and "client-secret". For more information, see the previous section.

--client-id

The 'Application identifier' . For more information, see the previous section

--client-secret

The 'Application token'. For more information, see the previous section