Skip to main content
On this page

Documentation

User Guides

DocWhat it covers
Quick StartInstall, create a container, essential workflows
Configuration ReferenceAll TOML keys, defaults, and examples
Base packagesTools, shells, locales preinstalled in custom builds
Desktop IntegrationExporting container apps and binaries to the host
Container IntegrationHow the guest daemon bridges notifications, URI opening, clipboard
D-Bus ProxyFiltered D-Bus access via xdg-dbus-proxy
Home SetupDotfiles and provisioning steps inside the container home

Reference

DocWhat it covers
Architecture OverviewHow podbox works end-to-end
Quadlet KeysGenerated systemd unit files
Host-Guest ProtocolWire format and message types
Exit CodesProgram exit code meanings

Quick Reference

bash
1podbox use <name> # set active context
2podbox profile list # list available profiles
3podbox profile show <name> # show profile TOML
4podbox create <profile> # create + build + enable + start
5podbox enter <name> # open a shell
6podbox exec -- <cmd> # run a command
7podbox run <app> # run a GUI app
8podbox stats # show resource usage
9podbox doctor --fix # fix common issues
10podbox export app <name> # add to host launcher
11podbox diff # check installed packages vs config
12podbox remove --all # full cleanup

Most commands accept an optional <name> — defaults to the active context. See cli.md for name resolution, exit codes, and JSON output.

podbox — declarative Linux container environments
Licensed under MIT. Open Source by bethropolis.