New Documentation of Petals CLI-Command Line Interface

Use cases

Petals CLI realizes the following use-cases.

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

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

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

Installing petals-cli

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

Contributors

No contributors found for: authors on selected page(s)

Starting petals-cli

Linux / MacOS X

Command line to start petals-cli

  1. Go to petals-cli-1.x/bin
  2. Execute the following command:
    ./petals-cli.sh
    
  3. Done

Windows

Command line to start Petals ESB

  1. Go to petals-cli-1.x/bin
  2. Execute the following command:
    petals-cli.bat
    
  3. Done

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

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.
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.