Command Line Interface (CLI)
The Pipelogic CLI tool ("ppl") is for building and deploying Pipelogic components. It lets you scaffold components, manage metadata, run tests, and automate deployment — all from a simple command-line interface.
The ppl CLI is designed to be user-friendly and requires only basic
knowledge of the terminal.
Get started by installing the Pipelogic CLI ("ppl"):
Note: The PipeLogic CLI requires a Linux-based environment.
If you're using Windows, install the CLI via WSL.
Step-by-step Installation Guide (Linux)
-
Open your terminal and run the following command to install the CLI:
curl -fsSL https://app.pipelogic.ai/api/v1/install | bash -
After installation, add the CLI binary to your
PATH:export PATH="$HOME/bin:$PATH"
Verify the Installation
Check that the CLI is installed by running:
ppl
If installed correctly, you’ll see a welcome message along with a list of available commands. Example output:
Pipelogic CLI helps you build, deploy, and manage real-time data pipelines and AI components.
Usage:
ppl [command]
Common Commands:
release Create a new component release
init Initialize a component codebase
capsules List all available capsules
compile Compile component code without releasing
Start Using the CLI
Now you can use the PipeLogic CLI normally:
ppl login
ppl capsules
ppl init
CLI vs Web App — When to Use What
| Feature / Capability | Web Application | CLI Tool (ppl) |
|---|---|---|
| Interface Type | Graphical (browser-based) | Terminal / Command-line |
| User Skill Level | All skill levels | Developers, DevOps, advanced users |
| Pipeline Design | Drag-and-drop visual editor | Code and config-driven via commands |
| Live Streaming Support | Built-in | Not supported |
| Component Debugging | Basic only | JSON, step execution |
| Type Safety Assistance | Colored connections | Manual type validation |
| Best For | Prototyping, demos | Automation, scripting, deployment |
📚 Command Categories
We organize the CLI into three key groups for clarity:
1. Essential Commands
Critical commands for operating, debugging, and working with the CLI environment.
| Command | Description |
|---|---|
2. Common Commands
These are frequently used for everyday tasks like releasing, pushing, or listing components and pipelines.
🚀 1. Project Setup & Build
These commands are typically used before deployment to initialize your project, validate its structure, and generate necessary code artifacts.
| Command | Description |
|---|---|
🧱 2. Component & Pipeline Management
Helpful during the construction of logic flows.
| Command | Description |
|---|---|
🚚 3. Deployment Lifecycle
Used to push and manage active versions of the app
| Command | Description |
|---|---|
🗃️ 4. File & Asset Management
Project-level files and internal assets.
| Command | Description |
|---|---|
🎥 5. Live Streaming & Video Input
Stream video from devices directly into PipeLogic.
| Command | Description |
|---|---|
🛠️ 6. Monitoring & Debugging
For post-deploy troubleshooting and inspection
| Command | Description |
|---|---|
3. Management Commands
Used for advanced configuration, editing, or organizing your pipelines and components.
| Command | Description |
|---|---|