About
Learn about Piglet Run project, its license, community, and how to get support.
Documentation
Piglet Run documentation - AI coding sandbox with PostgreSQL, JuiceFS, VS Code, and more.
Welcome to Piglet Run documentation!
Piglet Run is a lightweight runtime environment from Pigsty, designed as a cloud coding sandbox for AI Web Coding. It integrates PostgreSQL database, JuiceFS distributed storage, VS Code, JupyterLab, and more into a unified environment.
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 | Pre-installed Claude Code, VS Code, Jupyter, Python/Go/Node.js |
| 🐘 Data Powerhouse | PostgreSQL 18 + 400+ 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 |
Concept
Understand the core concepts, architecture, and design philosophy behind Piglet Run.
Tutorial
Step-by-step guides to learn Piglet Run from scratch.
Task
Goal-oriented guides for specific operations like backup, restore, deploy.
Reference
Detailed technical reference for CLI, configuration, services, and APIs.