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.

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.

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
ppl loginLog in to your account +
ppl logoutLog out of the CLI session +
ppl versionDisplay the CLI version +
ppl upgradeUpgrade the CLI to the latest version +
ppl registerRegister a new user account +
ppl helpDisplay help information for commands +
ppl completionEnable shell autocompletion +

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
ppl initInitialize a new PipeLogic component codebase +
ppl compileCompile a component locally to verify its build +
ppl gentypesGenerate language-specific type definitions +

🧱 2. Component & Pipeline Management

Helpful during the construction of logic flows.

Command	Description
ppl componentsList all components available in your workspace +
ppl containerManage containers used in the pipeline +
ppl pipelinesDisplay a list of all Pipelogic pipelines available to you. +

🚚 3. Deployment Lifecycle

Used to push and manage active versions of the app

Command	Description
ppl deployDeploy a pipeline into a specified capsule environment for execution. +
ppl undeployGracefully stop and remove a running pipeline deployment. +
ppl releaseBuild and publish a new version of the current component. +
ppl deploymentsList all pipeline deployments across capsules and environments. +

🗃️ 4. File & Asset Management

Project-level files and internal assets.

Command	Description
ppl filesList available files in your Pipelogic workspace. +

🛠️ 5. Monitoring & Debugging

For post-deploy troubleshooting and inspection

Command	Description
ppl statsDisplay real-time performance metrics and resource statistics for a specific deployment. +
ppl logsFetch and display logs from a running container. +
ppl debugLaunch an interactive debugging session for a specific deployment. +

3. Management Commands

Used for advanced configuration, editing, or organizing your pipelines and components.

Command	Description
ppl capsuleManage capsule environments +
ppl componentManage pipeline components +
ppl containerManage containers in deployments +
ppl deploymentManage pipeline deployments +
ppl fileManage files for ML workflows +
ppl pipelineManage pipelines and their lifecycle +
ppl typeManage and define custom data types +