CLICommands
Commands
Every Portabase CLI command, global options and environment variables.
Syntax: portabase [GLOBAL OPTIONS] COMMAND [ARGS] [OPTIONS]. Every command accepts --help.
Command overview
| Command | Description |
|---|---|
agent create | Create a new agent folder. |
agent show | Show an agent's settings and databases. |
agent set / agent unset | Change or reset agent settings. |
agent db add | Add a database (new container or existing server). |
agent db list | List an agent's databases. |
agent db remove | Remove a database from an agent. |
dashboard create | Create a new dashboard folder. |
dashboard show | Show a dashboard's settings and login providers. |
dashboard set / dashboard unset | Change or reset dashboard settings. |
dashboard auth add | Add an OIDC or OAuth login provider. |
dashboard auth list | List login providers. |
dashboard auth remove | Remove a login provider. |
start / stop / restart / logs / uninstall | Container lifecycle. |
build | Re-render docker-compose.yml from the configuration. |
decrypt | Decrypt .enc backup files. |
config | Global CLI configuration (update channel). |
update | Update the CLI binary. |
Global options
These options go before the command: portabase [GLOBAL OPTIONS] COMMAND ...
| Option | Environment variable | Description |
|---|---|---|
--version | Print the CLI version, check for a newer release, and exit. | |
--verbose | Show the cause and full traceback of errors. | |
--no-color | NO_COLOR | Disable colours (output and help). |
--non-interactive | PORTABASE_NON_INTERACTIVE | Never prompt; fail on missing input. |
--help | Show help. Works on every command and sub-command. |
portabase --non-interactive --no-color agent db list ./my-agentEnvironment variables
| Variable | Description |
|---|---|
PORTABASE_NON_INTERACTIVE | 1, true or yes forces non-interactive mode. |
NO_COLOR | Any value disables colours. |
PORTABASE_TEMPLATES_DIR | Use compose templates from this folder instead of the ones bundled in the binary (advanced). |
Last updated on