---
title: "Global Options"
description: "Flags and environment variables available on every PgBeam CLI command."
canonical: "https://pgbeam.com/docs/cli/global-options"
last-updated: "2026-09-14T19:37:21.000Z"
---

# Global Options

> Flags and environment variables available on every PgBeam CLI command.

URL: https://pgbeam.com/docs/cli/global-options

## 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

`--no-trunc`

Show full table cell values

`--debug`

Enable debug output

Use `--json` on any command to get machine-readable JSON output. This is
useful for scripting and CI/CD pipelines.

With `--json`, errors are machine-readable too: instead of human-formatted console output, a failed command prints a JSON error object to stdout and exits non-zero. The `status` field is present for API errors, and `hint` carries the same remediation hint the human output shows:

## 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:

See api ls for full details.