# Piglet Documentation

> Build an AI-ready PostgreSQL workspace, understand how it works, and operate it with confidence.

---

LLMS index: [llms.txt](/llms.txt)

---

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**](/docs/concept/) | Understand the principles | What is Piglet Run? How does snapshot work? |
| [**Tutorial**](/docs/tutorial/) | Learn step by step | Install Piglet Run, Create your first project |
| [**Task**](/docs/task/) | Get specific things done | Backup database, Deploy application |
| [**Reference**](/docs/reference/) | Look up detailed info | Configuration options, CLI commands |

## Quick Links

- **New to Piglet Run?** Start with the [Installation Tutorial](/docs/tutorial/install/)
- **Want to understand the concepts?** Read [What is Piglet Run?](/docs/concept/overview/)
- **Looking for how-to guides?** Check the [Task](/docs/task/) section
- **Need detailed reference?** See the [Reference](/docs/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 |

---

Section pages:

- [About](/docs/about/): Learn about Piglet Run project, its license, community, and how to get support.
- [Concept](/docs/concept/): Understand the core concepts, architecture, and design philosophy behind Piglet Run.
- [Tutorial](/docs/tutorial/): Step-by-step guides to learn Piglet Run from scratch.
- [Reference](/docs/reference/): Exact configuration, CLI, API, portal, and editor details for Piglet.
- [Task](/docs/task/): Goal-oriented guides for specific operations like backup, restore, deploy.