Globals commands

View as Markdown

This topic covers globals commands for the Postman CLI.

Global variables let you access and reuse a set of variables across an entire workspace, regardless of the active environment. You can use globals commands to validate your local global variables file before you push it to a Postman workspace.

postman globals lint

This command checks that a local global variables file is valid YAML and has the expected structure, field types, and required fields.

Usage

$postman globals lint <path> [options]
<path>

Path to a global variables file or directory to lint.

Options

-o, --output <format>
Defaults to cli

Specifies the format of the lint results printed to the terminal. Accepted values are cli (human-readable output), table (a human-readable table), json, and csv. Results print to the terminal rather than saving to a file. To save the results, redirect the output to a file, for example --output json > results.json.

-f, --fail-severity <level>
Defaults to error

The command always lints everything and reports all issues. This option only sets the exit code, returning a failure code if any diagnostics are at this severity level or higher.

With error, the command returns a failure code only if errors are present. With warning, it returns a failure code whether warnings or errors are present. The failure code matters most in CI/CD, where it can stop the pipeline before invalid entities reach the cloud, or fail a pull request check.

Examples

$postman globals lint ./postman/globals
$
$postman globals lint ./postman/globals/workspace.globals.yaml --fail-severity warning
$
$postman globals lint ./postman/globals/workspace.globals.yaml --output json