postman-cli 1.19.4 → 1.20.0-preview.1

package/man/postman.1

@@ -0,0 +1,332 @@
+.TH POSTMAN 1 "2025-10-07" "v1.20.0-preview.1" "Postman CLI Manual"
+.SH NAME
+postman \- Command\-line companion utility for Postman
+.SH SYNOPSIS
+.B postman
+[\fIcommand\fR] [\fIoptions\fR]
+.SH DESCRIPTION
+The Postman CLI is a command\-line companion utility that brings the power of Postman platform directly to your terminal. It enables you to run collections, lint APIs, manage monitors, and integrate API testing into CI/CD pipelines.
+.br
+Note: All commands support the --help option for more information..
+.SH OPTIONS
+.TP
+.B \-v, \-\-version
+output the version number
+.TP
+.B \-\-silent
+Silences all terminal output
+.SH COMMANDS
+.SS "login"
+Authenticate with Postman to access your resources.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-\-alias <alias>
+Specify the alias of the API key to fetch your resources using it.
+(This option is discontinued and will be removed in a future release.)
+.TP
+.B \-\-with\-api\-key <apikey>
+Specify the API key directly.
+.TP
+.B \-\-region <region>
+Specify the region for authentication. Use "eu" for EU region.
+.TP
+.B \-\-verbose
+Show detailed error information
+
+.SS "logout"
+Delete the stored Postman API key.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-\-alias <alias>
+Specify the alias of the API key to fetch your resources using it.
+(This option is discontinued and will be removed in a future release.)
+
+.SS "collection"
+Run and test your Postman collections directly from the command line.
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B collection run
+Initiate a Postman collection run from a given ID or path.
+
+.SS "collection run"
+Initiate a Postman collection run from a given ID or path.
+
+.B Usage:
+<collectionId/Path>  [options]
+
+.B Options:
+.TP
+.B \-e, \-\-environment <path>
+Specify an Id or path to a Postman Environment
+.TP
+.B \-g, \-\-globals <path>
+Specify an Id or path to a file containing Postman Globals
+.TP
+.B \-r, \-\-reporters [reporter]
+Specify the reporters to use for the run: cli,json,junit,html. For multiple reporters, provide their names as a comma\-separated list (E.g., \-r cli,json) (default: cli)
+.TP
+.B    \-\-reporter\-[reporter]\-export <path>
+[Optional] Specify a path to save the report. By default, reports are saved to the /postman\-cli\-reports directory in your current working directory. If the directory doesn't exist, it will be created automatically. If the specified path is an existing directory, the report file will be saved within it. Supported reporters: json, junit and html.
+Type: string, Default value: null
+.TP
+.B    \-\-reporter\-json\-structure newman
+[Optional] Generate JSON report using the Newman schema. By default, JSON reports use the native structure of Postman CLI. 
+Type: string, Default value: null
+.TP
+.B    \-\-reporter\-[reporter]\-omitRequestBodies
+[Optional] Remove all request bodies from the report. Supported reporters: json, html. 
+Type: boolean, Default value: false
+.TP
+.B    \-\-reporter\-[reporter]\-omitResponseBodies
+[Optional] Remove all response bodies from the report. Supported reporters: json, html. 
+Type: boolean, Default value: false
+.TP
+.B    \-\-reporter\-[reporter]\-omitHeaders
+[Optional] Remove all request and response headers from the report. Supported reporters: json, html. 
+Type: boolean, Default value: false
+.TP
+.B    \-\-reporter\-[reporter]\-omitAllHeadersAndBody
+[Optional] Remove all request and response headers, as well as request and response bodies, from the report. Supported reporters: json, html. 
+Type: boolean, Default value: false
+.TP
+.B \-n, \-\-iteration\-count <n>
+Define the number of iterations to run
+.TP
+.B \-d, \-\-iteration\-data <path>
+Specify a data file to use for iterations (either JSON or CSV)
+.TP
+.B \-i <id>
+Specify the request/folder id or name to run from the collection. Can be specified multiple times to run multiple items (default: )
+.TP
+.B \-\-global\-var <value>
+Allows the specification of global variables via the command line, in a key=value format
+.TP
+.B \-\-env\-var <value>
+Allows the specification of environment variables via the command line, in a key=value format (default: )
+.TP
+.B \-\-integration\-id <integration\-id>
+Specify the integration id for the report. (Only supported in the US region)
+.TP
+.B \-\-postman\-api\-key <apiKey>
+API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
+.TP
+.B \-\-alias <alias>
+Specify the alias of the API key to fetch remote resources using it.
+(This option is discontinued and will be removed in a future release.)
+.TP
+.B \-\-bail [modifiers]
+Specify whether or not to gracefully stop a collection run on encountering an error and whether to end the run with an error based on the optional modifier
+.TP
+.B \-\-ignore\-redirects
+Prevents Postman CLI from automatically following 3XX redirect responses
+.TP
+.B \-x , \-\-suppress\-exit\-code
+Specify whether or not to override the default exit code for the current run
+.TP
+.B \-\-silent
+Prevents Postman CLI from showing output to CLI
+.TP
+.B \-\-disable\-unicode
+Forces Unicode compliant symbols to be replaced by their plain text equivalents
+.TP
+.B \-\-color <value>
+Enable/Disable colored output (auto|on|off) (default: auto)
+.TP
+.B \-\-delay\-request [n]
+Specify the extent of delay between requests (milliseconds) (default: 0)
+.TP
+.B \-\-timeout [n]
+Specify a timeout for collection run (milliseconds) (default: 0)
+.TP
+.B \-\-timeout\-request [n]
+Specify a timeout for requests (milliseconds) (default: 0)
+.TP
+.B \-\-timeout\-script [n]
+Specify a timeout for scripts (milliseconds) (default: 0)
+.TP
+.B \-\-working\-dir <path>
+Specify the path to the working directory
+.TP
+.B \-\-no\-insecure\-file\-read
+Prevents reading the files situated outside of the working directory
+.TP
+.B \-k, \-\-insecure
+Disables SSL validations
+.TP
+.B \-\-ssl\-client\-cert\-list <path>
+Specify the path to a client certificates configurations (JSON)
+.TP
+.B \-\-ssl\-client\-cert <path>
+Specify the path to a client certificate (PEM)
+.TP
+.B \-\-ssl\-client\-key <path>
+Specify the path to a client certificate private key
+.TP
+.B \-\-ssl\-client\-passphrase <passphrase>
+Specify the client certificate passphrase (for protected key)
+.TP
+.B \-\-ssl\-extra\-ca\-certs <path>
+Specify additionally trusted CA certificates (PEM)
+.TP
+.B \-\-cookie\-jar <path>
+Specify the path to a custom cookie jar (serialized tough\-cookie JSON) 
+.TP
+.B \-\-export\-cookie\-jar <path>
+Exports the cookie jar to a file after completing the run
+.TP
+.B \-\-verbose
+Show detailed information of collection run and each request sent
+
+.TP Examples:
+Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
+
+
+.SS "api"
+Publish and test your APIs directly from the command line
+
+.B Usage:
+[options] [command]
+
+.TP Examples:
+
+Note: API commands are available in the US region only.
+
+
+.B Subcommands:
+.TP
+.B api lint
+Run linting on the schema of the given API ID or local file in the given path.
+If [api] is not provided we will run the linting on the schema present in the .postman config file
+.TP
+.B api publish
+Publish a version of an API for the given apiId. All entities added to the API will
+be published by default. User can choose which entities to publish by using additional options.
+
+.SS "api lint"
+Run linting on the schema of the given API ID or local file in the given path.
+If [api] is not provided we will run the linting on the schema present in the .postman config file
+
+.B Usage:
+<api> [options]
+
+.B Options:
+.TP
+.B \-\-integration\-id <integration\-id>
+Specify the integration ID for the report.
+.TP
+.B \-f, \-\-fail\-severity <value>
+Results of this level or above will trigger a failure exit code. [choices: "error", "warn", "info", "hint"] (default: ERROR)
+.TP
+.B \-x , \-\-suppress\-exit\-code
+Specify whether or not to override the default exit code for the current run
+
+.SS "api publish"
+Publish a version of an API for the given apiId. All entities added to the API will
+be published by default. User can choose which entities to publish by using additional options.
+
+.B Usage:
+<apiId> <options>
+
+.B Options:
+.TP
+.B \-\-name <name>
+Specify the name of the version to publish.
+.TP
+.B \-\-release\-notes <releaseNotes>
+Specify release notes for the version to publish.
+.TP
+.B \-\-collections <collectionIds/paths...>
+Specify the collections to publish. If API is connected to a repository, provide file path instead of IDs.
+.TP
+.B \-\-api\-definition <apiDefinitionId/directory/file>
+Specify the API Definition to publish. If API is connected to a repository, provide schema root file path. Note that some repository connections utilize a schema directory path; for such APIs, provide schema directory path instead of file path.
+.TP
+.B \-\-do\-not\-poll
+Specify whether or not to poll for completion status of the publish action.
+.TP
+.B \-x , \-\-suppress\-exit\-code
+Specify whether or not to override the default exit code for the current run.
+
+.TP Examples:
+Eg. postman api publish <apiId> \-\-name v1\e
+ \-\-release\-notes "# Some Release <br> Description"\e
+ \-\-collections <collectionId1> <collectionId2>\e
+ \-\-api\-definition <apiDefinitionId>
+
+
+.SS "spec"
+Lint and validate Specifications from the command line
+
+.B Usage:
+[options] [command]
+
+.TP Examples:
+
+Note: Spec commands are available in the US region only.
+
+
+.B Subcommands:
+.TP
+.B spec lint
+Run linting on the given specification by ID or local file path.
+
+
+.SS "spec lint"
+Run linting on the given specification by ID or local file path.
+
+
+.B Usage:
+<spec> [options]
+
+.B Options:
+.TP
+.B \-f, \-\-fail\-severity <value>
+Results of this level or above will trigger a failure exit code. [choices: "error", "warning", "info", "hint"] (default: ERROR)
+.TP
+.B \-o, \-\-output <value>
+Output format for the results. [choices: "json", "csv"]
+.TP
+.B \-\-workspace\-id <value>
+The workspace ID to use for fetching governance rulesets.
+
+.SS "monitor"
+Invoke a monitor run and display results
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B monitor run
+Invoke a monitor run and display results.
+
+.SS "monitor run"
+Invoke a monitor run and display results.
+
+.B Usage:
+[options] <monitorId>
+
+.B Options:
+.TP
+.B \-x, \-\-suppress\-exit\-code
+Specify whether or not to override the default exit code for the current run
+.TP
+.B \-t, \-\-timeout <ms>
+Maximum wait time for run completion in milliseconds (default: 15 minutes) (default: 900000)
+
+.SH SEE ALSO
+Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
+.SH AUTHOR
+Postman, Inc.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postman-cli",
-  "version": "1.19.4",
+  "version": "1.20.0-preview.1",
   "description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
   "keywords": [
     "postman",
@@ -49,16 +49,18 @@
   "bin": {
     "postman": "bin/postman.js"
   },
+  "man": "./man/postman.1",
   "files": [
     "bin/",
     "index.js",
     "package.json",
-    "README.md"
+    "README.md",
+    "man/"
   ],
   "optionalDependencies": {
-    "@postman/pm-bin-macos-arm64": "1.19.4",
-    "@postman/pm-bin-macos-x64": "1.19.4",
-    "@postman/pm-bin-linux-x64": "1.19.4",
-    "@postman/pm-bin-windows-x64": "1.19.4"
+    "@postman/pm-bin-macos-arm64": "1.20.0-preview.1",
+    "@postman/pm-bin-macos-x64": "1.20.0-preview.1",
+    "@postman/pm-bin-linux-x64": "1.20.0-preview.1",
+    "@postman/pm-bin-windows-x64": "1.20.0-preview.1"
   }
 }