postman-cli

library1.34.1jsnpmunverified

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.

devops testing web-framework

npm install postman-cli

package ↗homepage ↗

INSTALL

IMPORT

SIG · POSTMAN-CLI

postman-cli

devopsjavascriptv1.34.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

postman --version

Debug

Known issues

gotchaInstallation 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.

affects: >=1.0.0

gotchaUsers 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.

affects: >=1.0.0

gotchaNetwork 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.

affects: >=1.0.0

gotchaWhen 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.

affects: >=1.0.0

Errors

Common errors & fixes

Binary not found

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.

Upgrade

Version history

1.34.1latest on npm

Audit

Dependencies

@postman/cli-<platform>-<arch>optionalPlatform-specific binary required for CLI execution, downloaded as an optional dependency during installation.

Agent activity

8 hits · last 30 days

node

Resources

packagehttps://www.npmjs.com/package/postman-cli ↗

homepagehttps://www.postman.com ↗