View Source

{section}
{column}

h1. Use cases

Petals CLI realizes the following use-cases.

h2. Interactive console

Launching the Petals CLI with the following command line starts an interactive console with a prompt where the user can enter commands:
{code}
> ./petals-cli.sh

Type 'help' for help.
------------------------------------------------------------------------------
petals-cli>
{code}

h2. 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:
{code}
> ./petals-cli.sh -c <command> <command-args>
{code}

h2. Execution of a Petals script file

Launching the Petals CLI with the following command line executes commands of a Petals script:
{code}
> ./petals-cli.sh -f <filename>
{code}
{info}A Petals script is text file containing command supported by Petals CLI.{info}

h2. Execution of an inlined Petals script

Launching the Petals CLI with the following command line executes commands provided through the 'stdin':
{code}
> cat <filename> | ./petals-cli.sh -f -
> ./petals-cli.sh -f - << EOF
<command1> <command1-args>
<command2> <command2-args>
EOF
{code}

h1. Installing petals-cli

Make sure you have downloaded petals-cli.1.x.zip.
Unzip it wherever you want to install it.
{column}

{column:width=350px}
{panel}

{panel}
*Contributors*
{contributors:order=name|mode=list}
{column}
{panel}
{panel}
{section}

h1. Starting petals-cli

h2. Linux / MacOS X

*Command line to start petals-cli*

# Go to {{petals-cli-1.x/bin}}
# Execute the following command:
{noformat}
./petals-cli.sh
{noformat}
# Done :-)

h2. Windows

*Command line to start Petals ESB*

# Go to {{petals-cli-1.x/bin}}
# Execute the following command:
{noformat}
petals-cli.bat
{noformat}
# Done :-)

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

- *\-d,--debug*: Print stack trace and debugging informations
- *\-H,--help*: Print this help message and exit
- *\-h,--host <arg>*: remote petals ESB host name
- *\-n,--port <arg>*: port number
- *\-p,--password <arg>*: password
- *\-s,--script*: Read commands from standard input
- *\-u,--user <arg>*: username
- *\-V,--version*: Print the version number and exit



h1. 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.