Cipi Documentation

Full technical documentation for Cipi — the Laravel-first open-source deploy CLI. Choose a chapter below to get started.

Getting Started

Installation, requirements, quick start, tech stack, and app structure for Cipi.

Cipi Agent

Laravel cipi/agent package — webhook deploys, health, in-app MCP for AI assistants, cipi.yml tooling, MySQL/PostgreSQL anonymizer, panel SDK bridge, security model.

Apps

Create, manage, suspend, and configure Laravel apps — including Octane, Reverb, clones and soft disk limits — plus Node apps (SPA, static, blue/green SSR) and custom applications.

Deploy & CI/CD

Zero-downtime deployments, the deploy audit ledger, pre-deploy DB snapshots, cipi.yml, Git integration, CI/CD pipelines, notifications, and preview environments.

Infrastructure

PHP, Node runtimes, databases, SSL (incl. DNS-01 across several Cloudflare accounts), redirects and reverse proxy prefixes, Horizon, healthchecks, system monitor, disk usage per app, backups, workers, firewall, CrowdSec, Cloudflare Zero Trust, integrity scanning, compliance evidence, and server management.

CLI Client

Manage one or more Cipi servers remotely from your local terminal. Apps, deploys, SSL, databases and anonymized dumps, PHP, services, SMTP, healthchecks, multi-server profiles, global status overview, disk usage (cipi-cli disk, 1.6.0) and shell completion — all via the REST API.

PHP SDK

cipi/sdk calls the panel API from PHP, Laravel, and other frameworks. One Sanctum token covers apps, deploys, domains, databases, and the server.

Advanced

cipi/api 1.33 REST + 73 MCP tools + Swagger — disk usage, soft disk limits, DNS-01 accounts — plus server sync, vault, SMTP and chat alert channels, log retention, and advanced config.

About Cipi

History, security model, design decisions, and comparison with alternatives.