Piglet Documentation
Build an AI-ready PostgreSQL workspace, understand how it works, and operate it with confidence.
Welcome to the Piglet documentation.
Piglet is a lightweight runtime profile built on Pigsty. It turns one Linux machine into a shared environment for AI coding, PostgreSQL, durable storage, observability, and web delivery.
Documentation Structure
Our documentation follows the Diataxis framework, organized into four categories:
| Category | Purpose | Example |
|---|---|---|
| Concept | Understand the principles | What is Piglet Run? How does snapshot work? |
| Tutorial | Learn step by step | Install Piglet Run, Create your first project |
| Task | Get specific things done | Backup database, Deploy application |
| Reference | Look up detailed info | Configuration options, CLI commands |
Quick Links
- New to Piglet Run? Start with the Installation Tutorial
- Want to understand the concepts? Read What is Piglet Run?
- Looking for how-to guides? Check the Task section
- Need detailed reference? See the Reference section
Core Features
| Feature | Description |
|---|---|
| 🤖 AI Coding | Claude Code, OpenCode, VS Code, Jupyter, Python, Go, and Node.js |
| 🐘 Data Powerhouse | PostgreSQL 18 with hundreds of available extensions |
| 💾 Shared Storage | JuiceFS stores workspace in database |
| ⏱️ Time Machine | Database PITR + filesystem snapshots |
| 🔀 Instant Clone | Copy-on-Write database forking |
| 🌐 One-Click Deploy | Built-in Nginx with auto SSL |
| 📊 Full Observability | VictoriaMetrics + Grafana |
Learn about Piglet Run project, its license, community, and how to get support.
Understand the core concepts, architecture, and design philosophy behind Piglet Run.
Step-by-step guides to learn Piglet Run from scratch.
Exact configuration, CLI, API, portal, and editor details for Piglet.
Goal-oriented guides for specific operations like backup, restore, deploy.