postman-cli 1.38.0 → 1.39.0

package/man/postman.1

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2026-05-19" "v1.38.0" "Postman CLI Manual"
+.TH POSTMAN 1 "2026-06-11" "v1.39.0" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -66,6 +66,9 @@ Migrate a v2.1 collection to the v3 format
 .B collection lint
 Run linting on a local v3 collection at the given file or directory path.
 .TP
+.B collection ai-readiness
+Score a Postman collection for AI readiness by ID, local file path, or local\-mode directory.
+.TP
 .B collection run
 Initiate a Postman collection run from a given ID or path.
 
@@ -94,6 +97,31 @@ Exit with failure if diagnostics at this level or above are present. [choices: "
 .B \-r, \-\-reporter <value>
 Output format: cli (human\-readable) or json. (default: cli)
 
+.SS "collection ai\-readiness"
+Score a Postman collection for AI readiness by ID, local file path, or local\-mode directory.
+
+.B Usage:
+<collectionId/Path> [options]
+
+.B Options:
+.TP
+.B \-o, \-\-output <value>
+Output format for the results. [choices: "cli", "json"]
+.TP
+.B \-\-min\-score <n>
+Exit with a non\-zero code if the overall score is below this threshold (0\-100).
+
+.TP Examples:
+
+Examples:
+  $ postman collection ai\-readiness ./postman/collections/My\e API
+  $ postman collection ai\-readiness ./my\-collection.json
+  $ postman collection ai\-readiness 631643\-f695cab7\-... \-\-output json
+  $ postman collection ai\-readiness ./my\-collection.json \-\-min\-score 70
+
+Resolving a collection by ID requires authentication. Use `postman login` before running this command with a UID.
+
+
 .SS "collection run"
 Initiate a Postman collection run from a given ID or path.
 
@@ -369,6 +397,10 @@ Lint and validate Specifications from the command line
 .B spec lint
 Run linting on the given specification by ID or local file path.
 
+.TP
+.B spec ai-readiness
+Score an OpenAPI specification for AI readiness by ID or local file path.
+
 
 .SS "spec lint"
 Run linting on the given specification by ID or local file path.
@@ -391,6 +423,29 @@ The workspace ID to use for fetching governance rulesets.
 .B \-\-report\-events
 Report run events
 
+.SS "spec ai\-readiness"
+Score an OpenAPI specification for AI readiness by ID or local file path.
+
+
+.B Usage:
+<spec> [options]
+
+.B Options:
+.TP
+.B \-o, \-\-output <value>
+Output format for the results. [choices: "cli", "json"]
+.TP
+.B \-\-min\-score <n>
+Exit with a non\-zero code if the overall score is below this threshold (0\-100).
+
+.TP Examples:
+
+Examples:
+  $ postman spec ai\-readiness ./openapi.yaml
+  $ postman spec ai\-readiness 6e2e5b3e\-...  \-\-output json
+  $ postman spec ai\-readiness ./openapi.yaml \-\-min\-score 70
+
+
 .SS "monitor"
 Invoke a monitor run and display results
 
@@ -714,6 +769,9 @@ Show full output without truncating long values
 .B \-\-output <format>
 Save execution result to a file (supported: json)
 .TP
+.B \-\-reporters <format>
+Save a test results report to a file (supported: html)
+.TP
 .B \-x, \-\-suppress\-exit\-code
 Specify whether or not to override the default exit code for the current run
 .TP
@@ -737,6 +795,7 @@ Example:
   postman flows run ./path/to/flow.json \-\-input\-file ./inputs.json
   postman flows run ./path/to/flow.json \-\-scenario production \-\-verbose
   postman flows run ./path/to/flow.json \-\-output json
+  postman flows run ./path/to/flow.json \-\-reporters html
   postman flows run ./path/to/flow.json \-\-workspace <workspaceId>
 
 
@@ -1620,14 +1679,14 @@ Environment override for the selected target (last value wins) (default: )
 .B \-\-command <cmd>
 Command to run first (primary task). Overrides config.
 .TP
-.B \-\-network\-log <dir>
-Directory to scan for captured artifacts. Recursively discovers `playwright\-report*.json` plus their `trace.zip` attachments, and `network\-capture\-*.ndjson` (legacy plugin stream) at the top level. Use this to point at a non\-default Playwright `outputDir`, or at a folder where you have combined per\-shard artifacts from multiple machines. By default, scans Playwright config `outputDir`, test\-results/, then pm\-results/.
+.B \-\-network\-log <path>
+Directory to scan for captured artifacts, or a direct path to a Playwright JSON report / NDJSON capture file. When a directory is given, recursively discovers `*.json` Playwright reports plus their `trace.zip` attachments, and `network\-capture\-*.ndjson` at the top level. By default, scans Playwright config `outputDir`, test\-results/, then pm\-results/.
 .TP
 .B \-\-capture\-only
 Skip collection matching and tests; capture traffic and save a V3 collection organised by host
 .TP
 .B \-\-analyse\-only
-Do not run the primary command; analyse existing network\-capture NDJSON under the network log directory
+Do not run the primary command; analyse existing network\-capture NDJSON under the network log path
 .TP
 .B \-\-run\-only
 Run only the primary command; skip analysis (use \-\-analyse\-only on merged captures later).
@@ -1642,7 +1701,7 @@ Overwrite the output directory if it exists and is not empty (used with \-\-capt
 Write analytics events to pm\-results/test\-events\-debug.ndjson instead of sending to Postman
 .TP
 .B \-\-report\-events
-Send application test analytics to Postman
+Send application test run results and analytics to Postman
 .TP
 .B \-\-verbose
 Show detailed per\-request matching, sandbox errors, and debug information
@@ -1658,7 +1717,7 @@ or via \-\-target\-collection/\-\-target\-environment flags. CLI flags override
 Use \-\-capture\-only to skip tests and export captured traffic
 as a V3 Postman collection organised by host.
 
-Analytics events are automatically sent when running in CI.
+Use \-\-report\-events to send run results to Postman. Analytics are also sent automatically when running in CI.
 
 Examples:
   postman application test \-\-command "npx playwright test"
@@ -1685,6 +1744,237 @@ Start mocks with fault\-injection scenarios defined in a .sim.yaml file
 .B Usage:
 [options] <filepath>
 
+.SS "context"
+[Beta] Get API context for AI coding agents directly from the command line.
+
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B context instructions
+Get agent instructions for using Postman Context with AI coding agents.
+
+Topics:
+  (none)          — Overview of capabilities, workflow, and API reference
+  discovery       — Agent instructions for searching for and exploring APIs
+  code\-generation — Agent instructions for generating and maintaining client code
+  maintenance     — Agent instructions for maintaining and updating client code
+
+.TP
+.B context collection
+Collection commands
+.TP
+.B context request
+Request commands
+.TP
+.B context folder
+Folder commands
+.TP
+.B context response
+Response commands
+.TP
+.B context workspace
+Workspace commands
+.TP
+.B context environment
+Environment commands
+
+.SS "context instructions"
+Get agent instructions for using Postman Context with AI coding agents.
+
+Topics:
+  (none)          — Overview of capabilities, workflow, and API reference
+  discovery       — Agent instructions for searching for and exploring APIs
+  code\-generation — Agent instructions for generating and maintaining client code
+  maintenance     — Agent instructions for maintaining and updating client code
+
+
+.B Usage:
+[options] [topic]
+
+.SS "context collection"
+Collection commands
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B context collection get
+Get a collection's metadata and a map of its folders and requests.
+
+Returns collection info (name, description, variables, auth) plus a
+recursive tree of folders and requests.
+
+.SS "context collection get"
+Get a collection's metadata and a map of its folders and requests.
+
+Returns collection info (name, description, variables, auth) plus a
+recursive tree of folders and requests.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-c, \-\-collection\-id <id>
+Collection ID
+
+.SS "context request"
+Request commands
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B context request get
+Get a request from a collection
+.TP
+.B context request context
+Fetch all context about a request and return it as a Markdown document.
+
+Returns: collection metadata, request details (method, URL, headers, body,
+auth, docs), parent folder documentation, response examples, and
+environment variables.
+
+Examples:
+  postman context request context \-c <collection\-id> \-r <request\-id>
+
+.SS "context request get"
+Get a request from a collection
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-r, \-\-request\-id <id>
+Request ID
+.TP
+.B \-c, \-\-collection\-id <id>
+Collection ID
+
+.SS "context request context"
+Fetch all context about a request and return it as a Markdown document.
+
+Returns: collection metadata, request details (method, URL, headers, body,
+auth, docs), parent folder documentation, response examples, and
+environment variables.
+
+Examples:
+  postman context request context \-c <collection\-id> \-r <request\-id>
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-c, \-\-collection\-id <id>
+Collection ID
+.TP
+.B \-r, \-\-request\-id <id>
+Request ID
+
+.SS "context folder"
+Folder commands
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B context folder get
+Get a folder from a collection
+
+.SS "context folder get"
+Get a folder from a collection
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-\-folder\-id <id>
+Folder ID
+.TP
+.B \-c, \-\-collection\-id <id>
+Collection ID
+
+.SS "context response"
+Response commands
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B context response get
+Get a saved response example from a collection
+
+.SS "context response get"
+Get a saved response example from a collection
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-\-id <id>
+Response ID
+.TP
+.B \-c, \-\-collection\-id <id>
+Collection ID
+.TP
+.B \-r, \-\-request\-id <id>
+Request ID
+
+.SS "context workspace"
+Workspace commands
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B context workspace get
+Get a workspace by ID
+
+.SS "context workspace get"
+Get a workspace by ID
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace\-id <id>
+Workspace ID
+
+.SS "context environment"
+Environment commands
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B context environment get
+Get a single environment by ID
+
+.SS "context environment get"
+Get a single environment by ID
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-e, \-\-environment\-id <id>
+Environment ID
+
 .SS "search"
 Search for Postman element types (requests, collections, workspaces, and more).
 
@@ -1721,7 +2011,7 @@ Quick start:
   postman search requests "auth"
   postman search requests "auth" \-\-filter "method=POST AND visibility=public" \-\-ownership org \-\-limit 10 \-\-output json
 
-Element types: requests, collections, workspaces, flows, specs
+Element types: requests, collections, workspaces, flows, specs, environments, mocks
 
 Detailed help is split by element type:
   postman search requests \-\-help      Request filters and examples
@@ -1729,6 +2019,8 @@ Detailed help is split by element type:
   postman search workspaces \-\-help    Workspace filters and examples
   postman search flows \-\-help         Flow filters and examples
   postman search specs \-\-help         API spec filters and examples
+  postman search mocks \-\-help         Mock filters and examples
+  postman search environments \-\-help  Environment filters and examples
 
 Pagination: \-\-limit accepts up to 25 results. Use \-\-cursor from the previous response to paginate.
 
@@ -1749,6 +2041,12 @@ Search for flows by name or keyword.
 .TP
 .B search specs
 Search for API specs by name or keyword.
+.TP
+.B search mocks
+Search for mocks by name or keyword.
+.TP
+.B search environments
+Search for environments by name or keyword.
 
 .SS "search requests"
 Search for requests by name or keyword.
@@ -2019,6 +2317,293 @@ Examples:
   postman search specs "payments" \-\-ownership external \-\-filter "publisherIsVerified=true AND visibility=public"
 
 
+.SS "search mocks"
+Search for mocks by name or keyword.
+
+.B Usage:
+[options] [query]
+
+.TP Examples:
+
+Use \-\-cursor from the previous response to paginate.
+Ownership:
+  organization, org  Search resources owned by your organization
+  external           Search resources outside your organization
+  all                Search both organization and external resources
+
+Output modes:
+  default            Card list including basic overview and web link per result
+  json               Detailed JSON response with search metadata
+
+Filter syntax:
+  Use = or != for single values: workspaceId=ws\-1
+  Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
+  Combine filters with AND. Operators are case\-insensitive.
+  Quote supported values that contain spaces or commas: <field>="value with spaces"
+
+\-\-filter\-json format:
+  {"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
+  Only a top\-level $and array is supported; $or and nested groups are not supported.
+  Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
+
+Shared filter fields:
+  privateNetwork      $eq, $ne  (true/false)
+  publisherIsVerified $eq, $ne  (true/false)
+  visibility          $eq, $ne  (internal, public, partner)
+  workspaceId         $eq, $ne, $in, $nin
+  createdBy           $eq, $ne, $in, $nin  (user ID)
+  organizationId      $eq, $ne, $in, $nin  (organization ID)
+  teamId              $eq, $ne, $in, $nin  (team ID)
+  isGitConnected      $eq, $ne  (true/false)
+
+Mock filter fields:
+  mockId              $eq, $ne, $in, $nin
+
+ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
+Use \-\-output json on a broader search result to inspect available IDs.
+
+Examples:
+  postman search mocks "Auth service mock"
+  postman search mocks "auth" \-\-filter "workspaceId=ws\-abc123"
+  postman search mocks \-\-filter "mockId=mock\-abc123"
+
+
+.SS "search environments"
+Search for environments by name or keyword.
+
+.B Usage:
+[options] [query]
+
+.TP Examples:
+
+Use \-\-cursor from the previous response to paginate.
+Ownership:
+  organization, org  Search resources owned by your organization
+  external           Search resources outside your organization
+  all                Search both organization and external resources
+
+Output modes:
+  default            Card list including basic overview and web link per result
+  json               Detailed JSON response with search metadata
+
+Filter syntax:
+  Use = or != for single values: workspaceId=ws\-1
+  Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
+  Combine filters with AND. Operators are case\-insensitive.
+  Quote supported values that contain spaces or commas: <field>="value with spaces"
+
+\-\-filter\-json format:
+  {"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
+  Only a top\-level $and array is supported; $or and nested groups are not supported.
+  Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
+
+Shared filter fields:
+  privateNetwork      $eq, $ne  (true/false)
+  publisherIsVerified $eq, $ne  (true/false)
+  visibility          $eq, $ne  (internal, public, partner)
+  workspaceId         $eq, $ne, $in, $nin
+  createdBy           $eq, $ne, $in, $nin  (user ID)
+  organizationId      $eq, $ne, $in, $nin  (organization ID)
+  teamId              $eq, $ne, $in, $nin  (team ID)
+  isGitConnected      $eq, $ne  (true/false)
+
+Environment filter fields:
+  environmentId       $eq, $ne, $in, $nin
+
+ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
+Use \-\-output json on a broader search result to inspect available IDs.
+
+Examples:
+  postman search environments "Beta Access control service"
+  postman search environments "Payment service" \-\-filter "workspaceId=ws\-abc123"
+  postman search environments \-\-filter "environmentId=env\-abc123"
+
+
+.SS "webhook"
+Create and manage Postman webhooks.
+
+.B Usage:
+[options] [command]
+
+.B Subcommands:
+.TP
+.B webhook create
+Create a new webhook and print its public URL.
+.TP
+.B webhook start
+Activate a webhook so it can receive requests.
+.TP
+.B webhook pause
+Pause a webhook so it no longer accepts requests.
+.TP
+.B webhook list
+List all webhooks in a workspace.
+.TP
+.B webhook delete
+Permanently delete a webhook.
+.TP
+.B webhook status
+Show details for a webhook.
+.TP
+.B webhook forward
+Forward incoming webhook requests to a local port.
+
+.SS "webhook create"
+Create a new webhook and print its public URL.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-t, \-\-title <title>
+Name for the webhook (default: CLI Webhook)
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman webhook create
+  postman webhook create \-\-title "My Hook"
+  postman webhook create \-\-workspace 00000000\-0000\-0000\-0000\-000000000000
+
+
+
+.SS "webhook start"
+Activate a webhook so it can receive requests.
+
+.B Usage:
+[options] <webhookIdOrUrl>
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Postman workspace ID
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman webhook start 0123456789abcdefghijklmno
+  postman webhook start https://0123456789abcdefghijklmno.webhook.pstmn.io
+
+
+
+.SS "webhook pause"
+Pause a webhook so it no longer accepts requests.
+
+.B Usage:
+[options] <webhookIdOrUrl>
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Postman workspace ID
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman webhook pause 0123456789abcdefghijklmno
+  postman webhook pause https://0123456789abcdefghijklmno.webhook.pstmn.io
+
+
+
+.SS "webhook list"
+List all webhooks in a workspace.
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman webhook list
+  postman webhook list \-\-workspace 00000000\-0000\-0000\-0000\-000000000000
+
+
+
+.SS "webhook delete"
+Permanently delete a webhook.
+
+.B Usage:
+[options] <webhookId>
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Postman workspace ID
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman webhook delete 0123456789abcdefghijklmno
+
+
+
+.SS "webhook status"
+Show details for a webhook.
+
+.B Usage:
+[options] <webhookId>
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Postman workspace ID
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman webhook status 0123456789abcdefghijklmno
+
+
+
+.SS "webhook forward"
+Forward incoming webhook requests to a local port.
+
+.B Usage:
+[options] <webhookIdOrUrl> <port>
+
+.B Options:
+.TP
+.B \-w, \-\-workspace <workspaceId>
+Postman workspace ID
+.TP
+.B \-\-api\-key <key>
+Postman API key
+
+.TP Examples:
+
+Examples:
+  postman webhook forward 00000000\-0000\-0000\-0000\-000000000000 8080
+  postman webhook forward https://abc123.webhook.pstmn.io 8080
+
+
+
 .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.38.0",
+  "version": "1.39.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.38.0",
-    "@postman/pm-bin-macos-x64": "1.38.0",
-    "@postman/pm-bin-linux-x64": "1.38.0",
-    "@postman/pm-bin-linux-arm64": "1.38.0",
-    "@postman/pm-bin-windows-x64": "1.38.0"
+    "@postman/pm-bin-macos-arm64": "1.39.0",
+    "@postman/pm-bin-macos-x64": "1.39.0",
+    "@postman/pm-bin-linux-x64": "1.39.0",
+    "@postman/pm-bin-linux-arm64": "1.39.0",
+    "@postman/pm-bin-windows-x64": "1.39.0"
   }
 }