Skip to main content

Available Flags

SettingFlagEnvironment VariableDefault
Port--portPORT9876
Config file--configpgconsole.toml
Command line flags take precedence over environment variables.

Examples

npx

npx @pgplex/pgconsole --port 3000 --config /path/to/config.toml

Docker

docker run -p 9876:9876 -v ./pgconsole.toml:/etc/pgconsole.toml pgplex/pgconsole

# Custom port
docker run -p 3000:3000 -e PORT=3000 -v ./pgconsole.toml:/etc/pgconsole.toml pgplex/pgconsole

# Pass config via environment variable (useful for PaaS like Railway where we can't mount file)
docker run -p 9876:9876 -e PGCONSOLE_CONFIG="$(cat pgconsole.toml)" pgplex/pgconsole
PGCONSOLE_CONFIG is only available for Docker deployments. When set, its content is written to the config file at startup. This is useful for PaaS platforms where you cannot mount files and can only set environment variables.