Postman Docs

This topic covers basic Postman CLI commands for getting help, version information, and updating the CLI.

`postman`

The base command of the Postman CLI is postman. Run this command with the syntax and options detailed below.

Usage

postman [options]

Options

--color <value>

'auto' | 'on' | 'off'Defaults to auto

Controls colored output in the terminal. Accepts auto, on, or off. With auto, the Postman CLI attempts to turn colored output on or off based on the terminal’s color support.

--help, -h

Returns information about Postman CLI commands and options.

--silent

Silences all terminal output.

--version, -v

Returns the version number for the Postman CLI.

You can run the man postman command to return a manual page with the Postman CLI commands and options.

Examples

postman --help
postman -v

`postman update`

Updates the Postman CLI to the latest version using the method you installed it with, such as npm, Homebrew, or the install script. Run it after a new release to upgrade in place. To check whether an update is available without installing it, pass --check.

Usage

postman update [options]

Options

--check

Checks whether a newer version of the Postman CLI is available, without installing it. If an update is available, the command tells you to run postman update. Otherwise, it reports that you’re running the latest version.

`postman feedback`

Submits feedback about the Postman CLI, such as usability issues, gaps, and improvement suggestions. You, or an AI agent, pass the feedback as text, which gives a structured way to send it from the command line.

Usage

postman feedback <text> [options]

<text>

The feedback to submit.

Options

--type <type>

'general' | 'cli_gap' | 'improvement_suggestion' | 'bug_report' | 'feature_request'Defaults to general

The kind of feedback you’re submitting.

--context <context>

The command or feature the feedback is about.

--json

Prints the result as JSON for machine-readable output.

Examples

postman feedback "The performance run output is hard to read when piped"
postman feedback "Add a dry-run flag to workspace push" --type feature_request --context "workspace push"