New Documentation of Petals CLI-Command Line Interface

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (7)

View Page History
Petals CLI realizes the following use-cases.

h2. Interactive console
h2. Petals CLI capabilities about script and shell usages

h3. 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}
This command is wrapped by another shell: petals-cli-console.sh

h23. 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}

h23. Execution of a Petals script file

Launching the Petals CLI with the following command line executes commands of a Petals script:
{info}A Petals script is text file containing command supported by Petals CLI.{info}

h23. Execution of an inlined Petals script

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

h2. Petals CLI commands

h3. 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:
{code}
deploy <artifact> <configuration>
{code}
where:
- <artifact> is the local file name or the URL of the artifact to install or deploy and start
- <configuration> 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.

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