Getting Started¶

Welcome to Pipelit! This section guides you through installing, configuring, and running the platform.

Two Ways to Run Pipelit¶

The easiest way to run Pipelit is through the plit CLI, which manages Pipelit as a Docker container alongside the message gateway:

curl -fsSL https://raw.githubusercontent.com/theuselessai/plit/main/install.sh | bash
plit init
plit start

See the plit documentation for details.

If you're contributing to Pipelit or want to run it outside Docker, follow the steps below.

Requirement	Minimum Version	Purpose
Python	3.10+	Backend runtime
Redis	8.0+	Task queue, pub/sub, search
Node.js	18+	Frontend build
bubblewrap	0.4+	Sandboxed shell execution (Linux)

Clone the repository, set up a Python virtual environment, and install dependencies.

Generate an encryption key, configure Redis, and set up your .env file.

Start the backend, workers, and frontend. Create your admin account via CLI.

Build your first workflow end-to-end — a chat agent that can answer questions using tools.