CLICommands
build
Re-render docker-compose.yml from a component's configuration.
Re-renders docker-compose.yml (and databases.json for an agent) from the folder's configuration. Use it after editing .env or databases.json by hand, after upgrading the CLI to pick up new templates, or to inspect the result.
Why the compose is generated: see Concepts.
portabase build [OPTIONS] <PATH>| Option | Description | Default |
|---|---|---|
--diff | Show the unified diff between the current and the rendered compose. Writes nothing. | — |
--stdout | Print the rendered compose. Writes nothing. | — |
-o, --output <dir> | Write the files (compose, databases.json, and a copy of .env) to another directory. | — |
--inline-env | Put the actual values in the compose instead of ${VAR} references. | — |
--diff, --stdout and --output are mutually exclusive.
Example
# Preview what the CLI would change (recommended after an upgrade)
portabase build ./my-agent --diff
# Apply
portabase build ./my-agent
portabase restart ./my-agent
# Export a self-contained compose, e.g. for Portainer or Coolify
portabase build ./my-dashboard --stdout --inline-env > compose.yml--inline-env writes secrets in clear text (Edge Key, database passwords, PROJECT_SECRET) in the compose file. Never commit or share that file.
Last updated on