CLICommands
lifecycle
Start, stop, restart, read logs and uninstall an agent or a dashboard.
These commands replace direct use of docker compose. They target the folder of a component (agent or dashboard), check that Docker is running, and use the folder name (slugified) as the Compose project name. Inside the component folder, use . as the path: portabase logs .
| Command | Runs | Description |
|---|---|---|
portabase start <PATH> | docker compose up -d | Start the containers in the background. |
portabase stop <PATH> | docker compose stop | Stop the containers cleanly (containers and volumes are kept). |
portabase restart <PATH> | docker compose up -d then docker compose restart | Apply configuration changes: creates services added since the last start, then restarts everything so .env is re-read. |
portabase logs <PATH> | docker compose logs [-f] | Show logs. --follow/--no-follow (-f), follow is enabled by default. Ctrl+C to exit. |
portabase uninstall <PATH> | docker compose down -v then deletes the folder | Remove everything. --force (-f) skips the confirmation. |
uninstall runs docker compose down -v and deletes the folder. It removes the containers, the data volumes (local databases, dashboard data) and the configuration (.env, databases.json, including the Edge Key and PROJECT_SECRET). This action is irreversible.
Last updated on