cli

Portabase CLI is the official command-line interface for managing and deploying Portabase instances. It simplifies database backup and restore operations across a wide range of database systems, including PostgreSQL, MySQL/MariaDB, MongoDB, Redis, Valkey, MSSQL, Firebird, SQLite, and Docker volumes. ## Installation Install via a single bash command: ```bash curl -sSL https://portabase.io/install | bash ``` For development setup and alternative installation methods, refer to the official documentation at [portabase.io/docs/cli](https://portabase.io/docs/cli). ## Key Features - **Agent Management**: Create, configure, and manage agent folders with commands like `portabase agent create`, `show`, `set`, `unset`, and database operations (`add`, `remove`, `list`). - **Dashboard Management**: Create and manage dashboard folders, including authentication settings (`auth add`, `list`, `remove`). - **Instance Control**: Start, stop, restart, view logs, uninstall, or build Portabase instances with simple commands. - **Database Operations**: Database commands are scoped to agents (e.g., `portabase agent db add`). ## Upgrade Notes (from 26.08 or earlier) Starting from this release, the CLI takes ownership of `docker-compose.yml`. It re-renders this file from your `.env` and `databases.json` whenever you run `portabase agent db add`, `agent db remove`, or `build`. On older installations, the existing file is first copied to `docker-compose.legacy.yml`. - Preview changes before applying: `portabase build <name> --diff` - Keep customizations in `docker-compose.override.yml`; Docker Compose merges it automatically, and the CLI never modifies it. ## License Distributed under the Apache License. See `LICENSE.txt` for details. ## Technology Stack Built with Python, Typer (CLI framework), and Rich (terminal formatting). ## Resources - Website: [portabase.io](https://portabase.io) - Documentation: [portabase.io/docs](https://portabase.io/docs) - Report bugs or request features via GitHub Issues.