The official command line interface (CLI) for managing and deploying Portabase instances with ease.
Website • Documentation • Installation • Report Bug • Request Feature
You can install Portabase CLI using bash with the following command:
curl -sSL https://portabase.io/install | bash- Development setup - details
For more installation options, please refer to the official documentation.
Distributed under the Apache License. See LICENSE.txt for more details.
portabase agent create NAME create an agent folder
portabase agent show|set|unset NAME
portabase agent db add|remove|list NAME
portabase dashboard create NAME create a dashboard folder
portabase dashboard show|set|unset NAME
portabase dashboard auth add|list|remove NAME
portabase start|stop|restart|logs|uninstall|build PATH
portabase db was removed: database commands only apply to an agent, use portabase agent db.
From this release the CLI owns docker-compose.yml: it is re-rendered from your
.env and databases.json whenever you run portabase agent db add, agent db remove or
build. The first time that happens on an older install, the existing file is
copied to docker-compose.legacy.yml first.
- Preview the change before applying it:
portabase build <name> --diff - Keep your own customisations in
docker-compose.override.yml; Docker Compose merges it automatically and the CLI never touches it.