...
Required license:
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
Since version:
| Status | ||||
|---|---|---|---|---|
|
| Table of Contents |
|---|
What is the CLI?
The PIPEFORCE Command Line Tool (in short just “CLI”) is a command line tool which simplifies working with PIPEFORCE.
...
We also recommend you to install Visual Studio Code since it works nicely together with the CLI.
Most important actions
The main structure of a CLI command is always like this:
...
Below you can find the description of the most important actions.
pi command
Executes a single pipeline command at server side and returns the result.
...
| Info |
|---|
Note Use the command Or use the command |
pi delete
Deletes the remote resources inside a given app. It doesn’t delete any local resource.
...
| Note |
|---|
This command deletes remote resources without the option to recover. So be careful in using it! |
pi get
Downloads all resources of a given app, stores them into the local workspace in order to be able to edit them. If a local resource already exists, asks for overwrite or skip.
...
| Code Block |
|---|
pi get global/app/myapp/pipeline/hello |
pi help
Lists all available CLI options or pipeline commands.
...
| Code Block | ||
|---|---|---|
| ||
---
log:
type: "object"
description: "Logs the given input message without changing it. Sets the log message\
\ in the body in case body is empty. Doesn't overwrite any existing content in\
\ the body."
inputType: "JsonNode"
outputType: "JsonNode"
properties:
message:
type: "number"
description: "The message to log. Can be a string or a pipe expression. If null\
\ or empty, the full pipe message will be logged."
default: null
level:
type: "string"
description: "The log level. Can be one of DEBUG, TRACE, INFO, WARN, ERROR.\
\ If null or empty, INFO will be used."
default: "INFO"
required:
- "message" |
pi list
Lists all remote resources of a given path.
...
Lists all resources of the folder myapp but not the resources inside any sub-folder.
pi localrun
| Status | ||||
|---|---|---|---|---|
|
Since version 6.0 this command has been deprecated. Please use pi pipeline instead.
pi new
Creates a new resource based on a wizard.
...
| Code Block |
|---|
~ pipeforce> cd src/global/app/myapp ~ app/myapp> pi new pipeline |
pi pipeline
Executes a locally stored pipeline file, a remote pipeline or a pipeline uri.
...
| Info |
|---|
Also see the CLI command |
pi publish
Uploads your created or changed resources like pipeline or form configurations to the server.
...
For security reasons (for example to no accidentally publish a huge path structure of your file system to the server), publish is only possible in case your current working dir is inside the workspace folder.
pi pull
| Status | ||||
|---|---|---|---|---|
|
Since version 6.0 this command has been deprecated. Please use pi get instead.
pi push
| Status | ||||
|---|---|---|---|---|
|
Since version 6.0 this command has been deprecated. Please use pi publish instead.
pi setup
Changes the settings of the CLI tool using a wizard and/or installs the CLI if not already done.
...
| Code Block |
|---|
pi setup advanced |
pi status
Returns status information about the CLI.
Example:
| Code Block |
|---|
pi status |
pi update
Looks for an update of the CLI and installs it if a newer version exists.
...