postman-cli 1.31.3 → 1.33.0

package/man/postman.1

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2026-03-01" "v1.31.3" "Postman CLI Manual"
+.TH POSTMAN 1 "2026-03-12" "v1.33.0" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -60,9 +60,23 @@ Run and test your Postman collections directly from the command line.
 
 .B Subcommands:
 .TP
+.B collection migrate
+Migrate a v2.1 collection to the v3 format
+.TP
 .B collection run
 Initiate a Postman collection run from a given ID or path.
 
+.SS "collection migrate"
+Migrate a v2.1 collection to the v3 format
+
+.B Usage:
+[options] <path>
+
+.B Options:
+.TP
+.B \-o, \-\-output <dir>
+Output directory (default: ./<collection\-name>)
+
 .SS "collection run"
 Initiate a Postman collection run from a given ID or path.
 
@@ -147,9 +161,6 @@ Prevents Postman CLI from showing output to CLI
 .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
@@ -490,44 +501,312 @@ Examples:
 
 
 .SS "flows"
-Run Postman Flows from the command line.
+Manage and interact with flows.
 
 .B Usage:
 [options] [command]
 
 .B Subcommands:
 .TP
+.B flows list
+List all flows
+.TP
+.B flows trigger
+Trigger a deployed flow
+.TP
+.B flows deploy
+Deploy a flow (required to trigger it)
+.TP
 .B flows run
-Run a single flow by local path (e.g. ./path/to/flow.postman_flow.json)
+Run a single flow from a file (e.g. ./path/to/flow.json)
+.TP
+.B flows update
+Update settings for a deployed flow
+.TP
+.B flows list-runs
+List run history for a deployed flow
+.TP
+.B flows get-run
+Analyze a specific flow run
 
-.SS "flows run"
-Run a single flow by local path (e.g. ./path/to/flow.postman_flow.json)
+.SS "flows list"
+List all flows
 
 .B Usage:
-<path> [options]
+[options]
 
 .B Options:
 .TP
-.B \-x, \-\-suppress\-exit\-code
-Specify whether or not to override the default exit code for the current run
+.B \-w, \-\-workspace <workspaceId>
+Specify the workspace ID to list flows from
+.TP
+.B \-p, \-\-paginate
+Paginates the list of flows
+.TP
+.B \-f, \-\-filter <pattern>
+Filter flows by name. Pattern may be a regex, or a name prefix.
+.TP
+.B \-s, \-\-sort <criteria>
+Sort flows by criteria: "name" or "updated" (default: updated) (default: updated)
 .TP
 .B \-\-verbose
-Show detailed information of flow run and each request (method, URL, assertions)
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman flows list \-\-workspace 12345\-67890\-abcdef
+  postman flows list \-\-workspace 12345\-67890\-abcdef \-\-filter "My"
+  postman flows list \-\-workspace 12345\-67890\-abcdef \-\-filter "^Test.*" \-\-paginate
+  postman flows list \-\-workspace 12345\-67890\-abcdef \-\-sort name
+  postman flows list \-\-workspace 12345\-67890\-abcdef \-\-sort updated \-\-filter "API"
+
+
+
+.SS "flows trigger"
+Trigger a deployed flow
+
+.B Usage:
+<flowId> [options]
+
+.B Options:
+.TP
+.B \-i, \-\-input <key=value>
+Set key=value pairs in the trigger payload (e.g. \-\-input foo=bar \-\-input baz=qux) (default: )
 .TP
-.B \-\-input <key=value>
+.B \-f, \-\-input\-file <path.json>
+Set payload values from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-file ./config.json) (default: )
+.TP
+.B \-q, \-\-query <key=value>
+Set query parameters as key=value pairs (e.g. \-\-query foo=bar \-\-query baz=qux) (default: )
+.TP
+.B \-\-headers <key=value>
+Set custom headers as key=value pairs (e.g. \-\-headers X\-API\-Key=12345 \-\-headers User\-Agent=MyApp) (default: )
+.TP
+.B \-n, \-\-dry\-run
+Show the flow requestURL and payload that would be sent without making the actual request (default: false)
+.TP
+.B \-\-show\-secrets
+Show actual authentication tokens in dry\-run output (otherwise secrets are masked) (default: false)
+.TP
+.B \-r, \-\-result
+Show only the response body (default: false)
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman flows trigger 12345\-67890\-abcdef
+  postman flows trigger 12345\-67890\-abcdef \-i name=John \-i age=30
+  postman flows trigger 12345\-67890\-abcdef \-\-input\-file ./inputs.json
+  postman flows trigger 12345\-67890\-abcdef \-f ./inputs.json \-i override=value
+  postman flows trigger 12345\-67890\-abcdef \-\-headers X\-API\-Key=12345 \-\-headers User\-Agent=MyApp
+  postman flows trigger 12345\-67890\-abcdef \-\-query version=v2 \-q debug=true
+  postman flows trigger 12345\-67890\-abcdef \-\-result
+  postman flows trigger 12345\-67890\-abcdef \-\-dry\-run
+  postman flows trigger 12345\-67890\-abcdef \-\-dry\-run \-\-show\-secrets
+
+
+
+.SS "flows deploy"
+Deploy a flow (required to trigger it)
+
+.B Usage:
+<flowId> [options]
+
+.B Options:
+.TP
+.B \-p, \-\-path <path>
+Specify the URL path for the trigger
+.TP
+.B \-t, \-\-timeout <timeout>
+Specify the HTTP session timeout (5000ms to 60000ms) (default: 10000ms)
+.TP
+.B \-a, \-\-auth
+Enable authentication for the trigger (default: false)
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman flows deploy 12345\-67890\-abcdef \-\-path /my\-trigger
+  postman flows deploy 12345\-67890\-abcdef \-\-path /my\-trigger \-\-auth
+  postman flows deploy 12345\-67890\-abcdef \-\-path /my\-trigger \-\-timeout 5000ms
+
+
+
+.SS "flows run"
+Run a single flow from a file (e.g. ./path/to/flow.json)
+
+.B Usage:
+<path> [options]
+
+.B Options:
+.TP
+.B \-i, \-\-input <key=value>
 Set flow inputs as key=value pairs (e.g. \-\-input foo=bar \-\-input baz=qux) (default: )
 .TP
-.B \-\-input\-file <path.json>
+.B \-f, \-\-input\-file <path.json>
 Set flow inputs from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-file ./config.json) (default: )
 .TP
-.B \-\-scenario <name>
+.B \-s, \-\-scenario <name>
 Use a pre\-built scenario as flow inputs (by scenario name). Can be combined with \-\-input and \-\-input\-file to override values.
 .TP
+.B \-e, \-\-environment <path>
+Specify a path to a Postman Environment file (JSON or YAML)
+.TP
 .B \-\-working\-dir <path>
 Specify the path to the working directory
+.TP
+.B \-\-verbose
+Show detailed information of flow run and each request (method, URL, assertions)
+.TP
+.B \-x, \-\-suppress\-exit\-code
+Specify whether or not to override the default exit code for the current run
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Example:
+  postman flows run ./path/to/flow.json
+  postman flows run ./path/to/flow.json \-i name=John \-i age=30
+  postman flows run ./path/to/flow.json \-\-input\-file ./inputs.json
+  postman flows run ./path/to/flow.json \-\-scenario production \-\-verbose
+
+
+
+.SS "flows update"
+Update settings for a deployed flow
+
+.B Usage:
+<flowId> [options]
+
+.B Options:
+.TP
+.B \-t, \-\-trigger <on|off>
+Enable or disable the flow trigger
+.TP
+.B \-a, \-\-auth <on|off>
+Enable or disable authentication for the flow trigger
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman flows update 12345\-67890\-abcdef \-\-trigger on
+  postman flows update 12345\-67890\-abcdef \-\-trigger off
+  postman flows update 12345\-67890\-abcdef \-\-auth on
+  postman flows update 12345\-67890\-abcdef \-\-auth off
+
+
+
+.SS "flows list\-runs"
+List run history for a deployed flow
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Specify the workspace ID
+.TP
+.B \-f, \-\-flow <flowId>
+Filter sessions by flow ID
+.TP
+.B \-r, \-\-range <range>
+Time range to list runs (e.g. 30m, 2h, 3d) (default: 1h)
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
 
 .TP Examples:
-Eg. postman flows run ./path/to/flow.postman_flow.json
+
+Examples:
+  postman flows list\-runs \-\-workspace 12345\-67890\-abcdef
+  postman flows list\-runs \-\-workspace 12345\-67890\-abcdef \-\-flow <flowId>
+  postman flows list\-runs \-\-workspace 12345\-67890\-abcdef \-\-range 30m
+  postman flows list\-runs \-\-workspace 12345\-67890\-abcdef \-\-range 3d
+
+
+
+.SS "flows get\-run"
+Analyze a specific flow run
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-r, \-\-run\-id <runId>
+Specify the run ID to analyze
+.TP
+.B \-l, \-\-logs
+Show detailed event log (default: false)
+.TP
+.B \-\-filter <blockId>
+Filter event log by block ID prefix (can be specified multiple times) (default: )
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman flows get\-run \-\-run\-id session\-abc123
+  postman flows get\-run \-\-run\-id session\-abc123 \-\-logs
+  postman flows get\-run \-\-run\-id session\-abc123 \-\-logs \-\-filter blockId1
+
 
 
 .SS "request"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postman-cli",
-  "version": "1.31.3",
+  "version": "1.33.0",
   "description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
   "keywords": [
     "postman",
@@ -58,10 +58,10 @@
     "man/"
   ],
   "optionalDependencies": {
-    "@postman/pm-bin-macos-arm64": "1.31.3",
-    "@postman/pm-bin-macos-x64": "1.31.3",
-    "@postman/pm-bin-linux-x64": "1.31.3",
-    "@postman/pm-bin-linux-arm64": "1.31.3",
-    "@postman/pm-bin-windows-x64": "1.31.3"
+    "@postman/pm-bin-macos-arm64": "1.33.0",
+    "@postman/pm-bin-macos-x64": "1.33.0",
+    "@postman/pm-bin-linux-x64": "1.33.0",
+    "@postman/pm-bin-linux-arm64": "1.33.0",
+    "@postman/pm-bin-windows-x64": "1.33.0"
   }
 }