Use cases

Petals CLI realizes the following use-cases.

Petals CLI capabilities about script and shell usages

Interactive console

Launching the Petals CLI with the following command line starts an interactive console with a prompt where the user can enter commands:

> ./petals-cli.sh -C

Type 'help' for help.
------------------------------------------------------------------------------
petals-cli>

This command is wrapped by another shell: petals-cli-console.sh

Execution of a Petals CLI command directly on the command line

Launching the Petals CLI with the following command line executes the command specified on the command line:

> ./petals-cli.sh -c <command> <command-args>

Execution of a Petals script file

Launching the Petals CLI with the following command line executes commands of a Petals script:

> ./petals-cli.sh -f <filename>

A Petals script is text file containing command supported by Petals CLI.

Execution of an inlined Petals script

Launching the Petals CLI with the following command line executes commands provided through the 'stdin':

> cat <filename> | ./petals-cli.sh -f -
> ./petals-cli.sh -f - << EOF
<command1> <command1-args>
<command2> <command2-args>
EOF

Petals CLI commands

Deployment of an artifact

Petals CLI is able to install/deploy and start a JBI artifact without distinction between shared-library, component and service assembly using the following command:

deploy <artifact-file> [<configuration-file> | <configuration-properties>]

where:

• <artifact-file> is the local file name or the URL of the artifact to install or deploy and start
• <configuration-file> is the local file name or the URL of the properties file used to configure the artifact. This argument is used only if the component is a component. It has no sens for other artifacts. This argument is exclusive with <configuration-properties>.
• <configuration-properties> is a list of '<property-name>=<property-value>', separated by space, where <property-name> is the name of the property to configure with <property-value>. This argument is used only if the component is a component. It has no sens for other artifacts. This argument is exclusive with <configuration-file>.

List of all available commands to run with petals-cli.sh or petals-cli.bat

Usage: [-d] [-H | -v | [[-h <host>] [-n <port>] [-u <user>] [-p <password>] [-f <file> | -c <command> <command-args> | -C]]]

• -d,--debug: Print stack trace and debugging informations
• -H,--help: Print this help message and exit
• -V,--version: Print the version of Petals CLI and exit
• -h,--host <arg>: remote petals ESB host name
• -n,--port <arg>: port number
• -p,--password <arg>: password
• -u,--user <arg>: username
• -f,--file <filename>: Executes commands contained in the file, if <filename> is '-', commands are read from the 'stdin'
• -c,--command <command> <command-args>: Execute the command provided on the command line
• -C,--console: Enable the mode 'console'

List of all available interactive commands in petals-cli console

When launched petals-cli, it offers the following commands :

• deploy: Deploy and start a JBI artifact in petals container.
• exit: Exit this shell.
• help: Display this help message or help for a specific command.
• listartefacts: List JBI artifacts name and current status.
• listregistry: List the entries of the registry.
• load: Load properties from files.
• print: Print a message.
• pwd: Print the working directory.
• set: Assign a value to the system property named key.
• show: Print informations about a JBI artifact.
• shutdown: Shutdown the container.
• stop: Stop the container.
• undeploy: Stop and uninstall or undeploy JBI artifacts.
• version: Print version informations about petals container.