Global Options
Flags and environment variables available on every PgBeam CLI command.
Global flags
| Flag | Description |
|---|---|
--token | API token (overrides profile) |
--profile | Auth profile to use |
--project | Project ID (overrides linked project) |
--org | Organization ID (overrides profile) |
--json | Output as JSON |
--no-color | Disable color output |
--debug | Enable debug output |
JSON output
Use --json on any command to get machine-readable JSON output. This is useful
for scripting and CI/CD pipelines.
Environment variables
| Variable | Description |
|---|---|
PGBEAM_TOKEN | Use a token directly (skips profile lookup) |
PGBEAM_PROFILE | Select a named profile without --profile |
PGBEAM_NO_UPDATE_CHECK | Disable automatic update checks |
Raw API access
The CLI includes a built-in HTTP client for making raw API requests:
pgbeam api ls # List all API endpoints
pgbeam api request GET /v1/regions # Make a raw API request
pgbeam api schema listRegions # Show operation schemaSee api ls for full details.