Postman CLI

1.34.1 · active · verified Wed Apr 22

The Postman CLI is the official command-line companion for the Postman API platform, enabling developers to automate API development, testing, and integration into CI/CD pipelines. It allows users to run Postman Collections, execute monitors, and enforce API governance rules directly from the terminal. The current stable version is 1.34.1, indicating active development with regular updates to support the evolving Postman ecosystem. Key differentiators include its tight integration with Postman's cloud platform, providing a seamless bridge between collaborative API design and automated execution, and its capability to enforce quality gates in CI/CD workflows. It is a lightweight tool designed for local debugging, scaling systems, and embedding API workflows into build systems, supporting macOS, Linux (x64 & ARM64), and Windows (x64) platforms.

Common errors

```
Binary not found
```
cause The platform-specific Postman CLI executable was not successfully downloaded during installation or is inaccessible in the system's PATH.

fix Reinstall the CLI globally using `npm install -g postman-cli`, ensuring no `--no-optional` or `--omit=optional` flags are used. Check your `.npmrc` file for `optional=false` and verify network access to `@postman/*` packages. Ensure your system's PATH includes the global npm binary directory.

Warnings

gotcha Installation failures can occur if `npm install` is run with `--no-optional` or `--omit=optional` flags, preventing the download of necessary platform-specific binaries.
Fix: Ensure these flags are not used during installation. If present, remove `optional=false` from your `.npmrc` file and retry installation.
gotcha Users on unsupported Linux distributions, specifically Alpine Linux, will encounter `libc` compatibility issues as the distributed CLI binaries are not compatible.
Fix: Use a supported Linux distribution (x64 & ARM64, excluding Alpine) or refer to the official documentation for alternative installation methods.
gotcha Network or npm registry access issues can prevent the download of `@postman/*` scoped optional packages, leading to incomplete installation and 'Binary not found' errors.
Fix: Verify network connectivity and ensure your npm registry configuration allows access to packages under the `@postman` scope.
gotcha When running collections that involve sensitive data (like API keys), ensure they are handled securely, preferably via environment variables or a secure CI/CD secret management system, rather than hardcoding them in scripts.
Fix: Utilize environment variables (e.g., `POSTMAN_API_KEY`) for authentication and sensitive data. In CI/CD, integrate with your platform's secret management.

Install

npm install postman-cli npm
yarn add postman-cli yarn
pnpm add postman-cli pnpm

Quickstart

Installs the Postman CLI globally, demonstrates how to get help, log in using an API key, run a collection with an environment, and lint an API for governance rules.

npm install -g postman-cli

# Get help and verify installation
postman --help

# Sign in to Postman using an API key (replace with your actual API key or environment variable)
# It's recommended to use environment variables for sensitive data.
postman login --with-api-key "${process.env.POSTMAN_API_KEY || 'pk_YOUR_API_KEY'}"

# Run a Postman collection (replace with your actual collection ID and environment ID)
postman collection run "<collection-id>" -e "<environment-id>"

# Check API governance and security rules for a specific API (replace with your actual API ID)
postman api lint "<api-id>"

view raw JSON →