PantryPal documentation
Plan meals, track food, and shop for what you need.
New here? Start with Overview, then Install.
Start
- Overview — what PantryPal does and its limits.
- Install — Docker setup and first launch.
- Example data — try sample recipes, stock, and a meal plan.
Use PantryPal
- Pantry — add food and change stock.
- Recipes — servings, recipe status, cook mode, and cooking together.
- Create and edit recipes — the editor, step ingredient links, delete and archive.
- Meal plans — meals, leftovers, swaps, and prep tasks.
- Ingredient icons — how icons are chosen, and how to change one.
- Ingredient sticker book — collect stickers as you cook.
- Shopping — create a list and record purchases.
- Dietary rules — set rules through the API or MCP.
Connect an AI assistant
- MCP setup — tokens, transport, and client setup.
- Common tasks — plan a week, update stock, and record a cook.
- Tool reference — available tools and key inputs.
Host PantryPal
- Configuration — environment variables and storage.
- Access and security — browser login, tokens, and network trust.
- Public hosting — Cloudflare Tunnel and password login.
- Backups and restore — save and recover the database.
- Updates — build a new version and apply migrations.
- Troubleshooting — checks for common problems.
Develop and contribute
- Local setup — run the API and web app.
- Tests and checks — check code and API types.
- Architecture — code layout and data rules.
- Contribute — issues and pull requests.
- Documentation site — edit, preview, and publish these guides.
Reference
- REST API — endpoints, errors, and OpenAPI.
- CLI commands — household, tokens, migrations, and imports.
- Data import — load a household snapshot from JSON.
- Import format — fields and allowed values.