CLI
Introduction
The Portabase command-line tool — install and manage agents and dashboards without touching Docker Compose.
The Portabase CLI is a wrapper on top of Docker Compose. It:
- Generates valid and secure configurations for agents and dashboards.
- Administers an agent's databases and a dashboard's settings and login providers — no hand-editing of
.env, JSON or YAML. - Manages the container lifecycle (start / stop / restart / logs / uninstall).
- Decrypts encrypted backups offline.
Quickstart
curl -sL https://portabase.io/install | bash
portabase dashboard create my-dashboard --start
portabase agent create my-agent
portabase agent db add my-agent
portabase start my-agentWhere to go
Guides
Step-by-step: set up a dashboard, an agent, SSO, decrypt a backup.
Commands
Every command and option.
Concepts
Folders, generated compose, secrets, exit codes.
Troubleshooting
Fix common errors.
Upgrading from CLI 26.08.12 or earlier? Read the migration guide. Older syntax: legacy reference.
Last updated on