postman-cli 1.58.0 → 1.59.0

package/man/postman.1

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2026-09-17" "v1.58.0" "Postman CLI Manual"
+.TH POSTMAN 1 "2026-09-18" "v1.59.0" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -41,7 +41,7 @@ Specify the region for authentication. Use "eu" for EU region.
 Show detailed error information
 
 .SS "signup"
-Sign up to keep the work you created as a guest (claims your guest workspace). By default prints a single\-use sign\-up URL to open in a browser; \-\-browser signs up in a browser and signs this CLI in.
+Sign up to keep the work you created as a guest (claims your guest workspace). Waits and signs this CLI in once the sign\-up is completed in a browser — opening that browser here on a terminal, or printing the URL to hand over when output is piped.
 
 .B Usage:
 [options]
@@ -49,7 +49,13 @@ Sign up to keep the work you created as a guest (claims your guest workspace). B
 .B Options:
 .TP
 .B \-\-browser
-Open a browser to sign up and sign this CLI in, instead of printing a URL.
+Always open the sign\-up URL in a browser here, rather than printing it.
+.TP
+.B \-\-wait
+Wait for the sign\-up to complete even if no local browser is detected.
+.TP
+.B \-\-no\-wait
+Print the sign\-up URL and exit without waiting. Leaves this CLI a guest.
 .TP
 .B \-\-json
 Print the sign\-up details as machine\-readable JSON.
@@ -138,6 +144,12 @@ Show the Postman account or guest session this CLI session is using.
 .B \-\-json
 Print current identity as machine\-readable JSON.
 
+.SS "update"
+Update Postman CLI using the original installation method.
+
+.B Usage:
+[options]
+
 .SS "skills"
 Check and update the agent skills in this repository.
 
@@ -233,6 +245,9 @@ Run and test your Postman collections directly from the command line.
 
 .B Subcommands:
 .TP
+.B collection new
+Scaffold a v3 collection on disk, or create one in a cloud Postman workspace with \-\-workspace.
+.TP
 .B collection migrate
 Migrate a v2.1 collection to the v3 format
 .TP
@@ -242,9 +257,50 @@ Run linting on a local v3 collection at the given file or directory path.
 .B collection ai-readiness
 Score a Postman collection for AI readiness by ID, local file path, or local\-mode directory.
 .TP
+.B collection get
+Fetch a Postman collection in the V3 format and print it.
+.TP
+.B collection list
+List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
+.TP
 .B collection run
 Initiate a Postman collection run from a given ID or path.
 
+.SS "collection new"
+Scaffold a v3 collection on disk, or create one in a cloud Postman workspace with \-\-workspace.
+
+.B Usage:
+<name> [options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Create the collection in a cloud Postman workspace instead of scaffolding it locally. Required when the current directory is not a local Postman workspace.
+.TP
+.B \-\-force
+Rewrite the definition of an existing local collection. Existing request files are left alone.
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman collection new "Orders API"
+  postman collection new "Orders API" \-\-json
+  postman collection new "Orders API" \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef
+
+Without \-\-workspace this writes postman/collections/<name>/.resources/definition.yaml
+in the current directory, which must be a local Postman workspace (a directory holding
+\&.postman/ or postman/). Add requests as <request\-name>.request.yaml files beside it, then
+publish with `postman workspace push`. Creating a collection in a workspace requires
+authentication.
+
+
+
 .SS "collection migrate"
 Migrate a v2.1 collection to the v3 format
 
@@ -295,6 +351,59 @@ Examples:
 Resolving a collection by ID requires authentication. Use `postman login` before running this command with a UID.
 
 
+.SS "collection get"
+Fetch a Postman collection in the V3 format and print it.
+
+.B Usage:
+[options] <id>
+
+.B Options:
+.TP
+.B \-\-api\-key <key>
+Postman API key (defaults to your `postman login` session)
+.TP
+.B \-\-json
+Print the collection as machine\-readable V3 JSON instead of a table
+
+.TP Examples:
+
+Eg. postman collection get 12345\-33823532ab9e41c9b6fd12d0fd459b8b
+    postman collection get 0123456789abcdef01234567 \-\-json
+
+
+.SS "collection list"
+List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+List a Postman cloud workspace's collections by id. Omit to list the local project's collections.
+.TP
+.B \-f, \-\-filter <name>
+Filter collections by name.
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-debug
+Debug output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman collection list                       # local project collections
+  postman collection list \-\-json                # local, as JSON
+  postman collection list \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef   # a cloud workspace
+  postman collection list \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-filter "payments"
+
+
+
 .SS "collection run"
 Initiate a Postman collection run from a given ID or path.
 
@@ -470,6 +579,9 @@ Work with local Postman environments from the command line. Also read cloud envi
 
 .B Subcommands:
 .TP
+.B environment new
+Scaffold a local environment file, or create one in a Postman workspace with \-\-workspace.
+.TP
 .B environment list
 List environments in a Postman workspace.
 .TP
@@ -482,6 +594,40 @@ Read and update environment variables.
 .B environment lint
 Run linting on a local Postman environment at the given file or directory path.
 
+.SS "environment new"
+Scaffold a local environment file, or create one in a Postman workspace with \-\-workspace.
+
+.B Usage:
+<name> [options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Create the environment in a cloud Postman workspace instead of scaffolding it locally. Required when the current directory is not a local Postman workspace.
+.TP
+.B \-\-force
+Overwrite an existing local environment file.
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman environment new Dev
+  postman environment new "Staging EU" \-\-json
+  postman environment new Dev \-\-force
+  postman environment new Dev \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef
+
+Without \-\-workspace this writes postman/environments/<name>.environment.yaml in the
+current directory, which must be a local Postman workspace (a directory holding
+\&.postman/ or postman/). Creating an environment in a workspace requires authentication.
+
+
+
 .SS "environment list"
 List environments in a Postman workspace.
 
@@ -836,6 +982,9 @@ List the team's registered self\-hosted runners
 .B \-\-api\-key <key>
 Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
 .TP
+.B \-w, \-\-workspace <id>
+Filter to runners in this workspace
+.TP
 .B \-\-json
 Output the runner list as JSON instead of a table
 
@@ -880,6 +1029,9 @@ Add, update, or remove files in a spec (cloud ID or local directory).
 .TP
 .B spec create
 Create a new spec in a workspace, or (with path) scaffold a local spec file.
+.TP
+.B spec generate
+Generate artifacts from a specification.
 
 .SS "spec lint"
 Run linting on the given specification by ID or local file path.
@@ -1107,6 +1259,46 @@ Examples:
 
 
 
+.SS "spec generate"
+Generate artifacts from a specification.
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B spec generate collection
+Generate a Postman collection from a specification.
+
+.SS "spec generate collection"
+Generate a Postman collection from a specification.
+
+.B Usage:
+[options] <spec>
+
+.B Options:
+.TP
+.B \-n, \-\-name <name>
+Collection name
+.TP
+.B \-\-folder\-strategy <strategy>
+Folder strategy: Paths or Tags (default: Paths) (default: Paths)
+.TP
+.B \-w, \-\-workspace <id>
+Workspace ID (cloud mode)
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman spec generate collection ./openapi.yaml \-n "My API"
+  postman spec generate collection ./openapi.yaml \-n "My API" \-\-folder\-strategy Tags
+  postman spec generate collection 12345678\-abcd\-1234\-abcd\-1234567890ab \-n "My API"
+
+
+
 .SS "monitor"
 Run and manage Postman monitors.
 
@@ -1139,6 +1331,9 @@ List the monitors visible to you.
 .B monitor get
 Show a monitor's configuration.
 .TP
+.B monitor metrics
+Show per\-request latency and outcome history for a monitor.
+.TP
 .B monitor pause
 Pause a monitor, so it stops firing on schedule.
 .TP
@@ -1534,6 +1729,40 @@ Eg. postman monitor get 12345678\-90ab\-cdef\-1234\-567890abcdef
     postman monitor get 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-json
 
 
+.SS "monitor metrics"
+Show per\-request latency and outcome history for a monitor.
+
+.B Usage:
+[options] <monitorId>
+
+.B Options:
+.TP
+.B \-\-api\-key <key>
+Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
+.TP
+.B \-\-since <dateTime>
+Only executions at or after this ISO 8601 date\-time. Defaults to 7 days ago.
+.TP
+.B \-\-until <dateTime>
+Only executions at or before this ISO 8601 date\-time. Defaults to now.
+.TP
+.B \-f, \-\-filter <text>
+Show only requests whose name contains this text (case\-insensitive)
+.TP
+.B \-\-limit <n>
+Cap the number of rows shown: executions (newest first) under \-\-json, or table rows (worst\-behaving request first) otherwise. Not honoured by the service \-\- there is no server\-side pagination on this route.
+.TP
+.B \-\-json
+Output as JSON instead of a table
+
+.TP Examples:
+
+Eg. postman monitor metrics 12345678\-90ab\-cdef\-1234\-567890abcdef
+    postman monitor metrics 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-since 2026\-09\-01T00:00:00Z
+    postman monitor metrics 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-filter "GET /health"
+    postman monitor metrics 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-json
+
+
 .SS "monitor pause"
 Pause a monitor, so it stops firing on schedule.
 
@@ -1590,6 +1819,9 @@ Pull workspace entities from a Postman workspace into the local git\-native fold
 .TP
 .B workspace connect-git
 Connect a Postman workspace to a local git repository.
+.TP
+.B workspace diff
+Preview local\-vs\-cloud drift before pushing. Read\-only: nothing is created, updated or deleted.
 
 .SS "workspace list"
 List all available Postman Workspaces
@@ -1774,6 +2006,46 @@ Examples:
 
 
 
+.SS "workspace diff"
+Preview local\-vs\-cloud drift before pushing. Read\-only: nothing is created, updated or deleted.
+
+.B Usage:
+[options] [workspaceId]
+
+.B Options:
+.TP
+.B \-\-push\-strategy <strategy>
+Strategy to preview. "force\-sync" also shows cloud entities that would be DELETED. Defaults to "force\-sync".
+.TP
+.B \-\-summary
+Skip content comparison. Faster, but updates are listed without checking whether they changed.
+.TP
+.B \-\-json
+Print the diff as machine\-readable JSON.
+.TP
+.B \-\-exit\-code
+Exit with code 1 when drift is found (for CI gates).
+.TP
+.B \-\-verbose
+Show detailed logging
+.TP
+.B \-\-timeout <ms>
+Abort the run after this many milliseconds. Defaults to 120000.
+
+.TP Examples:
+
+Examples:
+  postman workspace diff
+      Preview what `push \-\-push\-strategy force\-sync` would do
+  postman workspace diff \-\-summary
+      Fast deletion preview, no content comparison
+  postman workspace diff \-\-json \-\-exit\-code
+      Machine\-readable output, exit 1 when there is drift (CI gate)
+  postman workspace diff \-\-push\-strategy default
+      Preview a create/update\-only push, hiding deletions
+
+
+
 .SS "performance"
 Manage performance tests on your collections.
 
@@ -1784,6 +2056,9 @@ Manage performance tests on your collections.
 .TP
 .B performance run
 Run a performance test on a collection
+.TP
+.B performance runs
+List past performance runs for a collection, newest first.
 
 .SS "performance run"
 Run a performance test on a collection
@@ -1851,6 +2126,40 @@ Examples:
   postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-runner postman\-cloud\-static\-ip
 
 
+.SS "performance runs"
+List past performance runs for a collection, newest first.
+
+.B Usage:
+\-\-collection\-id <id> [options]
+
+.B Options:
+.TP
+.B \-c, \-\-collection\-id <id>
+Collection ID whose performance runs to list
+.TP
+.B \-\-cursor <token>
+Pagination cursor from a previous page's response
+.TP
+.B \-\-json
+Output as JSON instead of a table
+.TP
+.B \-\-timeout <ms>
+Milliseconds to wait for the service before failing (default: 30000)
+
+.TP Examples:
+
+Examples:
+  postman performance runs \-\-collection\-id 1402295\-45159473\-1e45\-1f34\-5678\-1234567890ab
+  postman performance runs \-c 1402295\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-json
+  postman performance runs \-c 1402295\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-cursor eyJpZCI6...
+
+The newest 25 runs are returned. A `\-` in Duration means the run has not finished yet.
+A page shorter than 25 does not mean the end of the list: use the printed \-\-cursor
+while one is offered.
+
+Authentication uses POSTMAN_API_KEY, or the `postman login` session.
+
+
 .SS "flows"
 Manage and interact with flows.
 
@@ -2916,7 +3225,7 @@ Turn a mock in Postman cloud into a live mock server others can call over the in
 Show a mock's details using its path if it lives in your repository, or its id if it lives in Postman cloud.
 .TP
 .B mock list
-List the mocks in your Postman cloud workspace, or — with a folder path — the mocks in that folder in your repository.
+List the mocks in your repository or Postman cloud workspace
 .TP
 .B mock log
 Show the requests a live mock server has received and the responses it sent, using its id.
@@ -3088,7 +3397,7 @@ Paths can be relative (e.g. ./postman/mocks/orders) or absolute (e.g. /Users/me/
 
 
 .SS "mock list"
-List the mocks in your Postman cloud workspace, or — with a folder path — the mocks in that folder in your repository.
+List the mocks in your repository or Postman cloud workspace
 
 .B Usage:
 [pathOrDir] [options]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postman-cli",
-  "version": "1.58.0",
+  "version": "1.59.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.58.0",
-    "@postman/pm-bin-macos-x64": "1.58.0",
-    "@postman/pm-bin-linux-x64": "1.58.0",
-    "@postman/pm-bin-linux-arm64": "1.58.0",
-    "@postman/pm-bin-windows-x64": "1.58.0"
+    "@postman/pm-bin-macos-arm64": "1.59.0",
+    "@postman/pm-bin-macos-x64": "1.59.0",
+    "@postman/pm-bin-linux-x64": "1.59.0",
+    "@postman/pm-bin-linux-arm64": "1.59.0",
+    "@postman/pm-bin-windows-x64": "1.59.0"
   }
 }