Guides

Start with the quickstart for a working example or your first project to create a shared configuration. Then choose the behavior your workflow needs.

Run your project

I want to…	Read…
Start services when I enter a directory	Shell hooks and project sessions
Wait for dependencies to be ready	Ready checks
Restart after editing source files	File watching
Recover from a crash	Automatic retries
Detect a service that stops responding	Health checks
Share ports and connection details between services	Configuration templates
Use stable local URLs	Ports and reverse proxy

See what is happening

I want to…	Read…
Follow or filter output	Logs
Manage services from the terminal	TUI dashboard
Use a browser dashboard	Web UI
Make HTTP requests to the supervisor	HTTP API
Diagnose a failure	Troubleshooting

Automate and integrate

I want to…	Read…
Use project tool versions and environment variables	mise integration
React to lifecycle events or output	Lifecycle hooks
Run a task on a schedule	Cron scheduling
Start services at login or boot	Boot registration
Connect an AI assistant	MCP server
Supervise processes inside a container	Container mode (experimental)

Looking up a field or flag? Use the configuration reference, settings reference, or CLI reference.