postman-cli 1.52.0 → 1.54.0

package/man/postman.1

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2026-08-28" "v1.52.0" "Postman CLI Manual"
+.TH POSTMAN 1 "2026-09-03" "v1.54.0" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -52,6 +52,65 @@ Delete the stored Postman API key.
 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 "init"
+Set up Postman artifacts and agent instructions in a repository.
+
+.B Usage:
+[options] [path]
+
+.B Options:
+.TP
+.B \-\-json
+Emit machine\-readable output for agents
+.TP
+.B \-\-dry\-run
+Report what would happen without writing anything
+.TP
+.B \-\-no\-seed
+Do not derive a spec from source
+.TP
+.B \-\-spec <path>
+Which spec is authoritative, when more than one could be
+.TP
+.B \-\-visibility <status>
+Create and bind a workspace non\-interactively (personal or team)
+.TP
+.B \-\-no\-cloud
+Skip the workspace step entirely
+.TP
+.B \-\-report\-events
+Send init analytics to Postman (requires login)
+
+.TP Examples:
+
+Runs entirely locally: no authentication, no network, safe in CI.
+
+Not the same as `postman app init`, which writes a postman.config.cjs
+for test\-traffic capture.
+
+Exit codes:
+  0  set up, or adopted an existing setup
+  1  init could not run: bad usage, or an unexpected error
+  2  several specs could be authoritative \- re\-run with \-\-spec <path>
+  4  refused: postman/ holds source files, or a binding names a missing file
+  5  local setup done, but the workspace \-\-visibility asked for was not made
+
+Code 5 needs \-\-visibility: without it no workspace was requested, so nothing
+can fail for not getting one. It does not mean re\-run init \- the local files
+are already written.
+
+Under \-\-json, read `exitCode` and `refusal` from the payload rather than
+matching the messages on stderr. `refusal.kind` is one of
+foreign\-postman\-dir, bound\-spec\-missing, spec\-hint\-unmatched.
+
+Examples:
+  $ postman init
+  $ postman init ./services/api \-\-json
+  $ postman init \-\-dry\-run
+  $ postman init \-\-spec postman/specs/orders.yaml
+  $ postman init \-\-visibility personal
+
+
 .SS "collection"
 Run and test your Postman collections directly from the command line.
 
@@ -590,6 +649,9 @@ Push local workspace entities (collections, environments, specifications, and mo
 .B workspace lint
 Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
 .TP
+.B workspace create
+Create a Postman workspace and bind it to this git repository.
+.TP
 .B workspace pull
 Pull workspace entities from a Postman workspace into the local git\-native folder.
 .TP
@@ -689,6 +751,43 @@ The workspace ID to use for fetching governance rulesets. Defaults to the id in
 .B \-\-fix
 Apply safe autofixes to repairable workspace lint issues.
 
+.SS "workspace create"
+Create a Postman workspace and bind it to this git repository.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-\-visibility <status>
+Required. Workspace visibility, e.g. personal or team
+.TP
+.B \-\-name <name>
+Workspace name (defaults to owner/repo from the git remote)
+.TP
+.B \-\-summary <text>
+Optional workspace summary
+.TP
+.B \-\-path <dir>
+Directory to bind (defaults to the current directory)
+.TP
+.B \-\-no\-connect
+Create the workspace without binding it to the repository
+.TP
+.B \-\-force
+Create even when a workspace is already recorded for this repo
+
+.TP Examples:
+
+Requires a login (`postman login`) or POSTMAN_API_KEY.
+Refuses to run on CI: create once locally and commit the binding.
+
+Examples:
+  $ postman workspace create \-\-visibility personal
+  $ postman workspace create \-\-visibility team \-\-name "acme/orders"
+  $ postman workspace create \-\-visibility personal \-\-no\-connect
+
+
 .SS "workspace pull"
 Pull workspace entities from a Postman workspace into the local git\-native folder.
 
@@ -767,6 +866,12 @@ Specify an Id to a Postman Environment
 .B \-g, \-\-globals <id>
 Specify an Id to a Postman Globals
 .TP
+.B \-\-setup\-collection <id>
+Collection UID to run before the Postman Cloud performance test
+.TP
+.B \-\-teardown\-collection <id>
+Collection UID to run after the Postman Cloud performance test
+.TP
 .B \-\-vu\-count <count>
 Number of virtual users (default: 20)
 .TP
@@ -805,6 +910,7 @@ Example: less_than(p95, 500) or less_than(error_rate, 5)
 Examples:
   postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-vu\-count 50 \-\-duration 15
   postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-pass\-if "less_than(p95, 500)"
+  postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-runner postman\-cloud \-\-setup\-collection 123456\-11111111\-1111\-4111\-8111\-111111111111 \-\-teardown\-collection 123456\-22222222\-2222\-4222\-8222\-222222222222
 
 
 .SS "flows"
@@ -1849,7 +1955,7 @@ Examples:
 
 
 .SS "mock"
-Run and manage local Postman mock servers.
+Run and manage Postman mocks, locally and in the cloud.
 
 .B Usage:
 [options] [command]
@@ -1857,22 +1963,28 @@ Run and manage local Postman mock servers.
 .B Subcommands:
 .TP
 .B mock generate
-Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git\-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto\-detected. Omit the source to scaffold a sample mock with a GET /health endpoint.
+Generate a runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git\-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto\-detected. Omit the source to scaffold a sample mock with a GET /health endpoint. Writes a local mock by default, or a cloud mock with \-\-workspace.
 .TP
 .B mock run
-Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
+Start a local mock server from a cloud mock id (fetched and run locally), a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
+.TP
+.B mock deploy
+Deploy a cloud mock into a mock server.
 .TP
 .B mock get
-Show a local mock's details and run status.
+Show a mock's details: a cloud mock by id, or a local mock by path.
 .TP
 .B mock list
-List local mocks found under a directory.
+List a workspace's cloud mocks, or (with a path) local mocks under a directory.
+.TP
+.B mock log
+Browse a deployed mock server's request/response logs by its id (see `mock get`).
 .TP
 .B mock delete
-Permanently remove a local mock artifact.
+Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.
 
 .SS "mock generate"
-Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git\-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto\-detected. Omit the source to scaffold a sample mock with a GET /health endpoint.
+Generate a runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git\-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto\-detected. Omit the source to scaffold a sample mock with a GET /health endpoint. Writes a local mock by default, or a cloud mock with \-\-workspace.
 
 .B Usage:
 [sourcePath] [options]
@@ -1894,6 +2006,12 @@ Overwrite the config.yaml/default.js in the output directory if it already exist
 .B \-u, \-\-update <mockPath>
 Update an existing mock in place from the source: path to its config.yaml (or the directory containing it). Regenerates the default scenario handler and preserves the existing name/port/scenarios. Cannot be combined with \-\-output.
 .TP
+.B \-w, \-\-workspace <id>
+Create a cloud mock in this Postman workspace instead of a local mock. Cannot be combined with \-\-output/\-\-force/\-\-update.
+.TP
+.B \-\-api\-key <key>
+Postman API key for \-\-workspace (defaults to the `postman login` session)
+.TP
 .B \-x, \-\-suppress\-exit\-code
 Always exit with code 0, even on failure
 
@@ -1904,13 +2022,14 @@ Eg. postman mock generate ./my\-collection.json
     postman mock generate \-\-name "My Mock" \-\-port 4010      # sample mock, custom port
     postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
     postman mock generate ./my\-collection.json \-\-update ./postman/mocks/orders
+    postman mock generate ./my\-collection.json \-w 12345678\-90ab\-cdef\-1234\-567890abcdef   # cloud mock
 
 
 .SS "mock run"
-Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
+Start a local mock server from a cloud mock id (fetched and run locally), a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
 
 .B Usage:
-<pathOrDir>
+<mockIdOrPath>
 
 .B Options:
 .TP
@@ -1922,9 +2041,13 @@ Path to a globals file (JSON or YAML) for pm.globals
 .TP
 .B \-p, \-\-port <port>
 Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
+.TP
+.B \-\-api\-key <key>
+Postman API key for cloud mock ids (defaults to the `postman login` session)
 
 .TP Examples:
-Eg. postman mock run ./postman/mocks/orders            # a mock directory
+Eg. postman mock run 12345678\-90ab\-cdef\-1234\-567890abcdef  # cloud mock by id
+    postman mock run ./postman/mocks/orders            # a mock directory
     postman mock run ./postman/mock\-manifest.json
     postman mock run ./postman/mock\-manifest.yaml
     postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
@@ -1932,55 +2055,148 @@ Eg. postman mock run ./postman/mocks/orders            # a mock directory
     postman mock run ./manifest.yaml \-\-port 4600        # exact port, errors if busy
 
 
+.SS "mock deploy"
+Deploy a cloud mock into a mock server.
+
+.B Usage:
+<mockId> [options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <id>
+Workspace that will own the mock server (defaults to the workspace linked in .postman/resources.yaml)
+.TP
+.B \-n, \-\-name <name>
+Display name for the mock server (prompts when omitted)
+.TP
+.B \-s, \-\-slug <slug>
+Slug for the deploy URL (prompts when omitted)
+.TP
+.B \-\-public
+Deploy as a public mock (default is private; requires an x\-api\-key header)
+.TP
+.B \-\-auto\-deploy
+Re\-deploy the mock automatically whenever it changes (default off)
+.TP
+.B \-y, \-\-yes
+Accept defaults and skip all prompts (private, no auto\-deploy)
+.TP
+.B \-\-api\-key <key>
+Postman API key (defaults to the `postman login` session)
+
+.TP Examples:
+
+Eg. postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef                 # interactive prompts
+    postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-slug my\-mock \-\-public
+    postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef \-n "My Mock" \-s my\-mock \-\-auto\-deploy
+    postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef \-s my\-mock \-y   # non\-interactive
+
+
 .SS "mock get"
-Show a local mock's details and run status.
+Show a mock's details: a cloud mock by id, or a local mock by path.
 
 .B Usage:
-<pathOrDir> [options]
+<mockIdOrPath> [options]
 
 .B Options:
 .TP
+.B \-\-api\-key <key>
+Postman API key (defaults to the `postman login` session)
+.TP
 .B \-\-json
 Output the mock details as JSON instead of a table
 
 .TP Examples:
 
-Eg. postman mock get ./postman/mocks/orders
+Eg. postman mock get 12345678\-90ab\-cdef\-1234\-567890abcdef     # cloud mock by id
+    postman mock get ./postman/mocks/orders                   # local mock by path
     postman mock get ./postman/mocks/orders \-\-json
 
 
 .SS "mock list"
-List local mocks found under a directory.
+List a workspace's cloud mocks, or (with a path) local mocks under a directory.
 
 .B Usage:
 [pathOrDir] [options]
 
 .B Options:
 .TP
+.B \-w, \-\-workspace <id>
+Workspace whose cloud mocks to list (defaults to the workspace linked in .postman/resources.yaml)
+.TP
+.B \-\-api\-key <key>
+Postman API key (defaults to the `postman login` session)
+.TP
 .B \-\-json
 Output the mock list as JSON instead of a table
 
 .TP Examples:
 
-Eg. postman mock list
-    postman mock list ./postman/mocks
+Eg. postman mock list                                                 # linked workspace (cloud)
+    postman mock list \-w 12345678\-90ab\-cdef\-1234\-567890abcdef        # explicit workspace (cloud)
+    postman mock list ./postman/mocks                                # local mocks under a dir
     postman mock list ./postman/mocks \-\-json
 
 
+.SS "mock log"
+Browse a deployed mock server's request/response logs by its id (see `mock get`).
+
+.B Usage:
+<mockServerId> [options]
+
+.B Options:
+.TP
+.B \-\-limit <n>
+Maximum number of log entries to show (default 50 for \-\-json/non\-interactive output)
+.TP
+.B \-\-method <method>
+Filter by HTTP method (e.g. GET, POST)
+.TP
+.B \-\-status <code|range>
+Filter by response status (e.g. 404 or 5xx)
+.TP
+.B \-\-path <pattern>
+Filter by request path (supports * and ? wildcards)
+.TP
+.B \-\-since <duration>
+Show logs from this long ago onward (e.g. 2h = the last 2 hours)
+.TP
+.B \-\-until <duration>
+Stop this long ago (e.g. 30m = exclude the most recent 30 minutes)
+.TP
+.B \-\-api\-key <key>
+Postman API key (defaults to the `postman login` session)
+.TP
+.B \-\-json
+Output logs as JSON instead of the interactive pager
+
+.TP Examples:
+
+Eg. postman mock log 12345678\-90ab\-cdef\-1234\-567890abcdef            # interactive pager
+    postman mock log 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-json     # outputs in JSON
+    postman mock log <mockServerId> \-\-method GET \-\-path '/users/*'
+    postman mock log <mockServerId> \-\-status 5xx \-\-limit 50
+    postman mock log <mockServerId> \-\-since 7h \-\-until 2h            # between 7h and 2h ago
+
+
 .SS "mock delete"
-Permanently remove a local mock artifact.
+Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.
 
 .B Usage:
-<pathOrDir> [options]
+<mockIdOrPath> [options]
 
 .B Options:
 .TP
 .B \-y, \-\-yes
 Skip the confirmation prompt
+.TP
+.B \-\-api\-key <key>
+Postman API key for cloud mock ids (defaults to the `postman login` session)
 
 .TP Examples:
 
-Eg. postman mock delete ./postman/mocks/orders
+Eg. postman mock delete 12345678\-90ab\-cdef\-1234\-567890abcdef   # cloud mock by id
+    postman mock delete ./postman/mocks/orders                 # local mock by path
     postman mock delete ./postman/mocks/orders \-\-yes
     postman mock delete ./postman/mocks/orders/config.yaml \-\-yes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postman-cli",
-  "version": "1.52.0",
+  "version": "1.54.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.52.0",
-    "@postman/pm-bin-macos-x64": "1.52.0",
-    "@postman/pm-bin-linux-x64": "1.52.0",
-    "@postman/pm-bin-linux-arm64": "1.52.0",
-    "@postman/pm-bin-windows-x64": "1.52.0"
+    "@postman/pm-bin-macos-arm64": "1.54.0",
+    "@postman/pm-bin-macos-x64": "1.54.0",
+    "@postman/pm-bin-linux-x64": "1.54.0",
+    "@postman/pm-bin-linux-arm64": "1.54.0",
+    "@postman/pm-bin-windows-x64": "1.54.0"
   }
 }