Guzzle command-line interface (CLI) provides an easy-to-use interface to Guzzle platform. The CLI is built on top of the Guzzle REST API and is organized into command groups like activity, pipeline, batch, schedule, compute, datastore, connection, environment, access-token and user.
This CLI is under active development and is released as an Experimental client. This means that interfaces are still subject to change.
This section shows how to install and configure your environment to run the CLI.
Download Guzzle CLI package from https://guzzle-downloads.justanalytics.com/guzzle-release/cli/guzzlecli-0.0.1.zip and unzip it.
run Guzzle CLI help command
Before you can run CLI commands, you must set up authentication. To authenticate to the CLI you use a Guzzle personal access token. To configure the CLI to use a personal access token, run below command.
PROFILE_NAMEwith actual profile name. if that profile is already configured it will update its values.
GUZZLE_HOST_URLURL with your Guzzle instance URL in
PERSONAL_ACCESS_TOKENwith actual token value that you can generate from
Guzzle UI -> My Profile -> Access Token -> Generate Token
After you complete the configuration of profile, you can view list of configured profiles using below command.
your access credentials are stored in the file
~/.guzzlecliconf on Unix, Linux, or macOS, or
<USER_HOME>\.guzzlecliconf on Windows. The file contains a profile configurations:
you can change the path of this file by setting the environment variable
Guzzle encrypt CLI token using SHA-1 algorithm, it stores passphrase in the file
~/.guzzleclipassphrase on Unix, Linux, or macOS, or
<USER_HOME>\.guzzleclipassphrase on Windows. The file contains a passphrase value to encrypt and decrypt profile token. you can change the path of this file by setting the environment variable
Guzzle CLI supports the following environment variables:
An environment variable setting takes precedence over the setting in the configuration file.
By default, CLI uses the default profile from config file. you can mark any configured profile as default profile using below command.
This section shows you how to get CLI help and invoke commands in each command group.
You list the subcommands for any command group by running
./guzzlecli <group> --help (or
./guzzlecli <group> -h). For example, you list the Activity CLI subcommands by running
./guzzlecli activity -h.
You list the help for a subcommand by running
./guzzlecli <group> <subcommand> --help (or
./guzzlecli <group> <subcommand> -h). For example, you list the help for the Activity run subcommand by running
./guzzlecli activity run -h.
- Profile command is used to create, update, delete, list and view the user profiles.
- Activity command is used to create, edit, delete activity. User can also run, rerun, stop and view status and run history of activity.
- Pipeline command is used to create, edit, delete pipeline. User can also run, stop and view status and run history of pipeline.
- Batch command is used to create, edit, delete batch. User can also initialise, run, stop and view status and run history of batch.
- Schedule command is used to view status and run history of schedule.
For more information about command, subcommand and supported options view this file