Postman CLI commands and options overview

The Postman CLI provides a comprehensive set of commands for working with Postman from the command line. These commands are organized by functionality to help you quickly find the tools you need for your specific workflow.

Command categories

The Postman CLI commands are organized into the following categories:

Basic CLI commands

• postman --help — Display help information.
• postman --version — Display version information.

Authentication commands

• postman login — Sign in to Postman.
• postman logout — Sign out of Postman.

Workspace commands

• postman workspace prepare — Validate and prepare local collections and environments.
• postman workspace push — Push local changes to Postman workspaces.

Collection commands

• postman collection run — Run collections with extensive options and configurations.
• postman collection migrate — Migrate collections from v2.1 to v3 format.

Request commands

• postman request — Test and debug individual HTTP requests from the command line.

Monitoring and performance commands

• postman monitor run — Trigger monitor runs in CI/CD pipelines.
• postman runner start — Start private API monitoring runners.
• postman performance run — Configure and run performance tests.

Application commands

• postman app init — Initialize your project as an Application Inventory application.

• postman app test — Run your application’s existing UI test command, capture the network traffic generated during the run, and validate observed API calls against requests in your collections.

Flows commands

• postman flows list — List flows in a workspace.
• postman flows trigger — Trigger deployed flows to run.
• postman flows deploy — Deploy flows to the Postman cloud.
• postman flows run — Run flows locally from your repo.
• postman flows update — Update flow settings.
• postman flows list-runs — View flow run history.
• postman flows get-run — Analyze specific flow runs.

API governance commands

• postman spec lint — Validate API specifications against governance rules.
• postman api lint — Check Postman API Builder specifications (Postman v11 only).

Mock server commands

• postman mock run — Start mock servers from configuration files.

Search commands

• postman search — Search for Postman entities across your workspace.

• postman search requests — Search for requests by name, keyword, or URL.

• postman search collections — Search for collections by name or keyword.

• postman search workspaces — Search for workspaces by name or keyword.

• postman search flows — Search for flows by name or keyword.

• postman search mocks — Search for mocks by name or keyword.

• postman search environments — Search for environments by name or keyword.

• postman search specs — Search for API specifications by name or keyword.

Simulator commands

• postman simulate run — Run a simulation using a configuration file.

Publish API versions commands

• postman api publish — Publish API versions in the Postman API Builder (Postman v11 only).

SDK commands

• postman sdk init — Create or update the .postman/config.json SDK configuration file.
• postman sdk generate — Generate a client SDK from a collection or API specification.
• postman sdk track — Update the change-tracking manifest for a generated SDK.
• postman sdk list — List SDK build jobs and their statuses.
• postman sdk fetch — Download a generated SDK from a server-side build.
• postman sdk connect github — Connect a Postman entity to a GitHub repository for automated SDK regeneration.
• postman sdk connections list — List GitHub connections for a collection or specification.
• postman sdk connections delete — Delete a GitHub connection by its numeric connection ID.

CLI Commands for coding agents

• postman context — Aggregate all the information that a coding agent needs to generate accurate code.

Webhooks commands

• postman webhook create — Create a new webhook in the specified workspace.

• postman webhook list — List all webhooks in the specified workspace.

• postman webhook delete — Delete a webhook.

• postman webhook status — Show details for a webhook, including its title, current status (active or inactive), invoke URL, and creation date.

• postman webhook start — Start a paused or inactive webhook, enabling it to begin receiving events.

• postman webhook pause — Pause an active webhook, stopping it from receiving events.

• postman webhook forward — Forward events received on a webhook from external services (such as Stripe or Slack) to a port on your local server.

Get started

To begin using the Postman CLI, do the following:

1. Install the Postman CLI.
2. Explore the specific command categories that match your workflow.

Each command category page provides detailed options, examples, and use cases to help you integrate the Postman CLI into your development and testing workflows.