Portabase Logo
CLICommands

Commands

Every Portabase CLI command, global options and environment variables.

Syntax: portabase [GLOBAL OPTIONS] COMMAND [ARGS] [OPTIONS]. Every command accepts --help.

Command overview

CommandDescription
agent createCreate a new agent folder.
agent showShow an agent's settings and databases.
agent set / agent unsetChange or reset agent settings.
agent db addAdd a database (new container or existing server).
agent db listList an agent's databases.
agent db removeRemove a database from an agent.
dashboard createCreate a new dashboard folder.
dashboard showShow a dashboard's settings and login providers.
dashboard set / dashboard unsetChange or reset dashboard settings.
dashboard auth addAdd an OIDC or OAuth login provider.
dashboard auth listList login providers.
dashboard auth removeRemove a login provider.
start / stop / restart / logs / uninstallContainer lifecycle.
buildRe-render docker-compose.yml from the configuration.
decryptDecrypt .enc backup files.
configGlobal CLI configuration (update channel).
updateUpdate the CLI binary.

Global options

These options go before the command: portabase [GLOBAL OPTIONS] COMMAND ...

OptionEnvironment variableDescription
--versionPrint the CLI version, check for a newer release, and exit.
--verboseShow the cause and full traceback of errors.
--no-colorNO_COLORDisable colours (output and help).
--non-interactivePORTABASE_NON_INTERACTIVENever prompt; fail on missing input.
--helpShow help. Works on every command and sub-command.
portabase --non-interactive --no-color agent db list ./my-agent

Environment variables

VariableDescription
PORTABASE_NON_INTERACTIVE1, true or yes forces non-interactive mode.
NO_COLORAny value disables colours.
PORTABASE_TEMPLATES_DIRUse compose templates from this folder instead of the ones bundled in the binary (advanced).

Last updated on

On this page