postman-cli 1.56.3 → 1.57.0

package/man/postman.1

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2026-09-15" "v1.56.3" "Postman CLI Manual"
+.TH POSTMAN 1 "2026-09-16" "v1.57.0" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -40,6 +40,20 @@ Specify the region for authentication. Use "eu" for EU region.
 .B \-\-verbose
 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.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-\-browser
+Open a browser to sign up and sign this CLI in, instead of printing a URL.
+.TP
+.B \-\-json
+Print the sign\-up details as machine\-readable JSON.
+
 .SS "logout"
 Delete the stored Postman API key.
 
@@ -436,16 +450,175 @@ Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
 
 
 .SS "environment"
-Work with local Postman environments from the command line.
+Work with local Postman environments from the command line. Also read cloud environments by ID.
 
 .B Usage:
 [options] [command]
 
 .B Subcommands:
 .TP
+.B environment list
+List environments in a Postman workspace.
+.TP
+.B environment get
+Read an environment by ID or local environment file path.
+.TP
+.B environment var
+Read and update environment variables.
+.TP
 .B environment lint
 Run linting on a local Postman environment at the given file or directory path.
 
+.SS "environment list"
+List environments in a Postman workspace.
+
+.B Usage:
+[workspacePath] [options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Workspace ID to list environments from.
+.TP
+.B \-f, \-\-filter <name>
+Filter environments by name.
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman environment list \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef
+  postman environment list \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-filter "dev"
+  postman environment list ./my\-postman\-workspace
+  postman environment list \-\-json
+
+
+
+.SS "environment get"
+Read an environment by ID or local environment file path.
+
+.B Usage:
+<environment> [options]
+
+.B Options:
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-json
+JSON output
+.TP
+.B \-\-show\-secrets
+Show secret variable values in output
+
+.TP Examples:
+
+Examples:
+  postman environment get 123456\-11111111\-2222\-3333\-4444\-555555555555
+  postman environment get ./postman/environments/dev.environment.yaml
+  postman environment get ./postman/environments/dev.environment.yaml \-\-json
+  postman environment get ./postman/environments/dev.environment.yaml \-\-show\-secrets
+
+
+
+.SS "environment var"
+Read and update environment variables.
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B environment var set
+Set one variable in an environment.
+.TP
+.B environment var get
+Read one variable value from an environment.
+.TP
+.B environment var unset
+Remove one variable from an environment.
+
+.SS "environment var set"
+Set one variable in an environment.
+
+.B Usage:
+[options] <key> <value>
+
+.B Options:
+.TP
+.B \-e, \-\-environment <environment>
+Cloud Environment ID or local environment file path.
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman environment var set baseUrl https://api.example.com \e
+    \-\-environment ./postman/environments/dev.environment.yaml
+  postman environment var set token abc123 \-\-environment 123456\-11111111\-2222\-3333\-4444\-555555555555
+
+
+
+.SS "environment var get"
+Read one variable value from an environment.
+
+.B Usage:
+[options] <key>
+
+.B Options:
+.TP
+.B \-e, \-\-environment <environment>
+Cloud Environment ID or local environment file path.
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman environment var get baseUrl \-\-environment ./postman/environments/dev.environment.yaml
+  postman environment var get token \-\-environment 123456\-11111111\-2222\-3333\-4444\-555555555555
+
+
+
+.SS "environment var unset"
+Remove one variable from an environment.
+
+.B Usage:
+[options] <key>
+
+.B Options:
+.TP
+.B \-e, \-\-environment <environment>
+Cloud Environment ID or local environment file path.
+.TP
+.B \-\-verbose
+Verbose output
+.TP
+.B \-\-json
+JSON output
+
+.TP Examples:
+
+Examples:
+  postman environment var unset token \-\-environment ./postman/environments/dev.environment.yaml
+  postman environment var unset token \-\-environment 123456\-11111111\-2222\-3333\-4444\-555555555555
+
+
+
 .SS "environment lint"
 Run linting on a local Postman environment at the given file or directory path.
 
@@ -645,6 +818,12 @@ Run linting on the given specification by ID or local file path.
 .B spec ai-readiness
 Score an OpenAPI specification for AI readiness by ID or local file path.
 
+.TP
+.B spec list
+List local spec files under a path, or (no path) a workspace's cloud specs.
+.TP
+.B spec get
+Read a spec definition, including every file of a multi\-file spec.
 
 .SS "spec lint"
 Run linting on the given specification by ID or local file path.
@@ -693,6 +872,57 @@ Examples:
   $ postman spec ai\-readiness ./openapi.yaml \-\-min\-score 70
 
 
+.SS "spec list"
+List local spec files under a path, or (no path) a workspace's cloud specs.
+
+.B Usage:
+[options] [pathOrDir]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <id>
+Workspace ID (defaults to .postman/resources.yaml binding)
+.TP
+.B \-\-api\-key <key>
+Postman API key
+.TP
+.B \-\-json
+Output as JSON
+
+.TP Examples:
+
+Examples:
+  postman spec list ./postman/specs
+  postman spec list ./openapi.yaml
+  postman spec list
+  postman spec list \-w 12345\-abcde \-\-json
+
+
+
+.SS "spec get"
+Read a spec definition, including every file of a multi\-file spec.
+
+.B Usage:
+[options] <spec...>
+
+.B Options:
+.TP
+.B \-\-api\-key <key>
+Postman API key
+.TP
+.B \-\-json
+Output as JSON (full spec definition)
+
+.TP Examples:
+
+Examples:
+  postman spec get ./openapi.yaml
+  postman spec get "postman/specs/My API/index.yaml"
+  postman spec get 12345678\-abcd\-1234\-efgh\-567890abcdef
+  postman spec get 12345678\-abcd\-1234\-efgh\-567890abcdef \-\-json
+
+
+
 .SS "monitor"
 Invoke a monitor run and display results
 
@@ -2057,7 +2287,7 @@ Run and manage Postman mocks, locally and in the cloud.
 .B Subcommands:
 .TP
 .B mock generate
-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.
+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 shopping\-cart mock (POST /cart/items, GET /cart, POST /checkout). Writes a local mock by default, or a cloud mock with \-\-workspace.
 .TP
 .B mock run
 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.
@@ -2078,7 +2308,7 @@ Browse a deployed mock server's request/response logs by its id (see `mock get`)
 Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.
 
 .SS "mock generate"
-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.
+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 shopping\-cart mock (POST /cart/items, GET /cart, POST /checkout). Writes a local mock by default, or a cloud mock with \-\-workspace.
 
 .B Usage:
 [sourcePath] [options]
@@ -2112,7 +2342,7 @@ Always exit with code 0, even on failure
 .TP Examples:
 
 Eg. postman mock generate ./my\-collection.json
-    postman mock generate \-\-name "My Mock"                  # sample mock with a GET /health endpoint
+    postman mock generate \-\-name "My Mock"                  # sample shopping\-cart mock
     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
@@ -2705,6 +2935,114 @@ Get a single environment by ID
 .B \-e, \-\-environment\-id <id>
 Environment ID
 
+.SS "context\-graph"
+Ask natural\-language questions about your team's Context Graph.
+
+.B Usage:
+[options] [command]
+
+.TP Examples:
+
+The team a query runs against is derived from your API key.
+
+`ask <query> \-\-wait` is the one to reach for: it asks and blocks until the
+answer arrives. Without \-\-wait, `ask` returns an id immediately and
+`status <askId>` checks on it later.
+
+
+
+.B Subcommands:
+.TP
+.B context-graph ask
+Ask a natural\-language question about your team's Context Graph.
+.TP
+.B context-graph status
+Check an ask submitted by `ask`, without blocking. Prints the answer when ready.
+
+.SS "context\-graph ask"
+Ask a natural\-language question about your team's Context Graph.
+
+.B Usage:
+[options] <query>
+
+.B Options:
+.TP
+.B \-\-wait
+Block until the answer arrives, then print it
+.TP
+.B \-\-api\-key <key>
+Postman API key (falls back to POSTMAN_API_KEY, then a `postman login` session)
+.TP
+.B \-\-json
+Output the ask record as JSON
+.TP
+.B \-\-no\-include\-answer
+Do not ask the service to include the answer inline
+.TP
+.B \-\-max\-steps <count>
+Cap the reasoning steps the service may take (its default applies when omitted)
+.TP
+.B \-\-interval <seconds>
+With \-\-wait, seconds between polls (default: 2)
+.TP
+.B \-\-timeout <seconds>
+With \-\-wait, seconds to wait before giving up (default: 300)
+
+.TP Examples:
+
+The team a query runs against is derived from the API key \- there is no
+workspace or team option.
+
+Without \-\-wait this returns an ask id straight away; check on it later with
+`context\-graph status <askId>`. With \-\-wait it polls for you and prints the
+answer. On timeout the ask keeps running and the printed id stays valid.
+
+Exit codes:
+  0  the ask completed, or without \-\-wait was accepted
+  1  the request failed (auth, network, malformed input, unknown status)
+  2  the ask reached a failed state
+  4  \-\-timeout elapsed before the ask finished (\-\-wait only)
+
+Examples:
+  postman context\-graph ask "What does postman\-app do?" \-\-wait
+  postman context\-graph ask "What depends on billing\-api?" \-\-wait \-\-json
+  postman context\-graph ask "Which APIs are in the graph?" \-\-wait \-\-timeout 120
+  postman context\-graph ask "Summarize the graph" \-\-max\-steps 5
+
+
+
+.SS "context\-graph status"
+Check an ask submitted by `ask`, without blocking. Prints the answer when ready.
+
+.B Usage:
+[options] <askId>
+
+.B Options:
+.TP
+.B \-\-api\-key <key>
+Postman API key (falls back to POSTMAN_API_KEY, then a `postman login` session)
+.TP
+.B \-\-json
+Output the ask record as JSON
+
+.TP Examples:
+
+Returns immediately with whatever state the ask is in, printing the answer
+once it has one. Exits 3 while still in progress, so a script can poll on its
+own cadence; `ask <query> \-\-wait` does the polling for you.
+
+Exit codes:
+  0  the ask completed
+  1  the request failed (auth, network, unknown ask id or status)
+  2  the ask reached a failed state
+  3  the ask is still in progress
+
+Examples:
+  postman context\-graph status 018f3a2b\-1c2d\-4e5f\-8a9b\-0c1d2e3f4a5b
+  postman context\-graph status 018f3a2b\-1c2d\-4e5f\-8a9b\-0c1d2e3f4a5b \-\-json
+
+
+
 .SS "search"
 Search for Postman element types (requests, collections, workspaces, and more).
 
@@ -4157,6 +4495,43 @@ Examples:
 
 
 
+.SS "dependency"
+Manage workspace dependencies (Postman entities reused from other workspaces).
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B dependency add
+Add a Postman collection, environment, or mock as a workspace dependency.
+
+.SS "dependency add"
+Add a Postman collection, environment, or mock as a workspace dependency.
+
+.B Usage:
+[options] <type> <nameOrId>
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <id>
+Workspace id to resolve a name in (defaults to the current workspace).
+.TP
+.B \-y, \-\-yes
+Skip all confirmation prompts.
+.TP
+.B \-\-json
+Output the result as JSON.
+
+.TP Examples:
+
+Examples:
+  postman dependency add collection 844951\-51ea04bb\-8d1a\-439e\-aa70\-fe91852efcda
+  postman dependency add collection "My Collection" \-\-workspace <workspaceId>
+  postman dependency add environment 844951\-1b4d90f0\-b724\-4aa2\-b1bb\-b5d4f6435fc3
+
+
+
 .SH SEE ALSO
 Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
 .SH AUTHOR

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postman-cli",
-  "version": "1.56.3",
+  "version": "1.57.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.56.3",
-    "@postman/pm-bin-macos-x64": "1.56.3",
-    "@postman/pm-bin-linux-x64": "1.56.3",
-    "@postman/pm-bin-linux-arm64": "1.56.3",
-    "@postman/pm-bin-windows-x64": "1.56.3"
+    "@postman/pm-bin-macos-arm64": "1.57.0",
+    "@postman/pm-bin-macos-x64": "1.57.0",
+    "@postman/pm-bin-linux-x64": "1.57.0",
+    "@postman/pm-bin-linux-arm64": "1.57.0",
+    "@postman/pm-bin-windows-x64": "1.57.0"
   }
 }