postman-cli 1.50.0 → 1.52.0

package/man/postman.1

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2026-08-27" "v1.50.0" "Postman CLI Manual"
+.TH POSTMAN 1 "2026-08-28" "v1.52.0" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -269,14 +269,22 @@ Start a mock server from manifest (.json, .yaml or .yml) file
 .B \-\-port <port>
 Port for the \-\-mock server; pass "auto" for an OS\-assigned ephemeral port (default: configured port, falls back to an ephemeral one if busy). Only valid with \-\-mock.
 .TP
+.B \-\-use\-mock <mapping>
+Redirect requests for a URL or {{variable}} to a mock during the run. Format: "<url> mock|mock\-server:<path|id> [scenario]". Repeat the flag to redirect multiple URLs (one \-\-use\-mock per mock). Use "mock:<path>" for a local mock manifest (.json/.yaml/.yml), "mock:<id>" for a local mock by id (fetched from the cloud then run locally), or "mock\-server:<id>" to redirect to a deployed mock server's URL. Id\-based references require `postman login` (or \-\-postman\-api\-key). The optional third field selects a scenario (defaults to "default"). (default: )
+.TP
 .B \-\-simulate <path>
 Start mock servers with fault\-injection scenarios from a .sim.yaml file
 .TP
 .B \-\-report\-events
-Send run results and analytics to Postman
+Upload results for git\-native v3 collection runs. Analytics are sent by default
+.TP
+.B \-\-no\-report\-events
+Do not send analytics to Postman
 
 .TP Examples:
 Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
+    postman collection run <id> \-\-use\-mock "{{baseurl}} mock:./mock/config.yaml delay"
+    postman collection run <id> \-\-use\-mock "{{baseurl}} mock:./a.yaml" \-\-use\-mock "api.com mock\-server:9d8e7f6a"
 
 
 .SS "environment"
@@ -469,7 +477,10 @@ Enable the metrics server for health checks
 Port for the metrics server (default: 9090)
 .TP
 .B \-\-report\-events
-Send run events and analytics to Postman
+Accepted for compatibility; analytics are sent by default
+.TP
+.B \-\-no\-report\-events
+Do not send analytics to Postman
 
 .SS "spec"
 Lint and validate Specifications from the command line
@@ -506,7 +517,10 @@ Output format for the results. [choices: "json", "csv"]
 The workspace ID to use for fetching governance rulesets.
 .TP
 .B \-\-report\-events
-Send lint results and analytics to Postman
+Accepted for compatibility; analytics are sent by default
+.TP
+.B \-\-no\-report\-events
+Do not send analytics to Postman
 
 .SS "spec ai\-readiness"
 Score an OpenAPI specification for AI readiness by ID or local file path.
@@ -647,7 +661,10 @@ Push strategy. "force\-sync": mirror the whole workspace — also DELETE cloud e
 Show detailed logging
 .TP
 .B \-\-report\-events
-Send workspace push events to Postman
+Accepted for compatibility; analytics are sent by default
+.TP
+.B \-\-no\-report\-events
+Do not send analytics to Postman
 
 .SS "workspace lint"
 Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
@@ -1005,6 +1022,12 @@ Specify whether or not to override the default exit code for the current run
 .B \-\-workspace <workspaceId>
 Workspace ID required for flows that contain connector blocks. Find it in the Postman app URL: https://postman.com/workspace/<workspaceId>
 .TP
+.B \-\-report\-events
+Accepted for compatibility; analytics are sent by default
+.TP
+.B \-\-no\-report\-events
+Do not send analytics to Postman
+.TP
 .B \-\-verbose
 Verbose output
 .TP
@@ -1209,6 +1232,12 @@ suppress all output except response body. Useful for piping to other commands.
 .TP
 .B \-\-debug
 Debug mode: show detailed execution information including retry attempts, redirects, and timing breakdowns.
+.TP
+.B \-\-report\-events
+Accepted for compatibility; analytics are sent by default
+.TP
+.B \-\-no\-report\-events
+Do not send analytics to Postman
 
 .TP Examples:
 
@@ -2056,8 +2085,11 @@ Overwrite the output directory if it exists and is not empty (used with \-\-capt
 .B \-\-save\-events\-local
 Write analytics events to pm\-results/test\-events\-debug.ndjson instead of sending to Postman
 .TP
-.B \-\-report\-events
-Send application test run results and analytics to Postman
+.B \-\-report\-events [boolean]
+Send application test run results to Postman (default: true)
+.TP
+.B \-\-no\-report\-events
+Do not send run results or analytics to Postman
 .TP
 .B \-\-verbose
 Show detailed per\-request matching, sandbox errors, and debug information
@@ -2073,7 +2105,8 @@ 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.
 
-Use \-\-report\-events to send run results to Postman. Analytics are also sent automatically when running in CI.
+Run results are sent to Postman automatically after analysis.
+Use \-\-report\-events=false (or \-\-report\-events false) to skip uploading run results.
 
 Examples:
   postman application test \-\-command "npx playwright test"
@@ -3175,36 +3208,45 @@ Examples:
 
 
 .SS "dataset"
-[BETA] Work with Postman datasets defined in local YAML files.
+Work with Postman datasets in local YAML files or the cloud.
 
 .B Usage:
 [options] [command]
 
+.TP Examples:
+
+Targeting:
+  Local datasets: pass a .dataset.yaml path.
+  Cloud datasets: pass a dataset id; list/create use \-w <workspace\-id>.
+  Cloud operations require a paid Postman plan and `postman login` or \-\-api\-key.
+
+
+
 .B Subcommands:
 .TP
 .B dataset list
-[BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
+List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
 .TP
 .B dataset get
-[BETA] Print a dataset's metadata and structure summary (local YAML path or cloud id).
+Print a dataset's metadata and structure summary (local YAML path or cloud id).
 .TP
 .B dataset query
-[BETA] Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
+Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
 .TP
 .B dataset create
-[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
+Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
 .TP
 .B dataset delete
-[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
+Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
 .TP
 .B dataset source
-[BETA] Inspect and manage a dataset's datasources.
+Inspect and manage a dataset's datasources.
 .TP
 .B dataset view
-[BETA] Inspect and manage saved views on a dataset.
+Inspect and manage saved views on a dataset.
 
 .SS "dataset list"
-[BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
+List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
 
 .B Usage:
 [options] [pathOrDir]
@@ -3230,7 +3272,7 @@ Examples:
 
 
 .SS "dataset get"
-[BETA] Print a dataset's metadata and structure summary (local YAML path or cloud id).
+Print a dataset's metadata and structure summary (local YAML path or cloud id).
 
 .B Usage:
 [options] <datasetPathOrId>
@@ -3255,7 +3297,7 @@ Examples:
 
 
 .SS "dataset query"
-[BETA] Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
+Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
 
 .B Usage:
 [options] <datasetPathOrId>
@@ -3266,25 +3308,29 @@ Examples:
 SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
 .TP
 .B \-p, \-\-param <value...>
-Positional parameter values for $1, $2, ... bindings; repeatable
+Bind values to $1, $2, ... in order; pass multiple values after \-p or repeat \-p
 .TP
 .B \-\-api\-key <key>
 Postman API key (defaults to the `postman login` session)
 .TP
 .B \-\-json
 Output rows as JSON instead of a table
+.TP
+.B \-\-debug
+Include safe classified dataset diagnostics
 
 .TP Examples:
 
 Examples:
   postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
-  postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users WHERE id = $1" \-p 42
+  postman dataset query ./users.dataset.yaml \e
+    \-q 'SELECT * FROM source_users WHERE id = $1 AND active = $2' \-p 42 true
   postman dataset query 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users LIMIT 5"
 
 
 
 .SS "dataset create"
-[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
+Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
 
 .B Usage:
 [options] [path]
@@ -3318,7 +3364,7 @@ Examples:
 
 
 .SS "dataset delete"
-[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
+Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
 
 .B Usage:
 [options] <datasetPathOrId>
@@ -3329,7 +3375,7 @@ Examples:
 Skip the confirmation prompt
 .TP
 .B \-\-keep\-resources
-Delete only the YAML file; leave the .resources/ directory intact (local only)
+Preserve the local resource directory even when it is empty (local only)
 .TP
 .B \-\-api\-key <key>
 Postman API key (defaults to the `postman login` session)
@@ -3341,10 +3387,14 @@ Examples:
   postman dataset delete ./postman/datasets/users/users.dataset.yaml \-\-yes
   postman dataset delete 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-\-yes
 
+Local resource cleanup:
+  Local source files are preserved because references can cross directory boundaries.
+  An empty resource directory is removed unless \-\-keep\-resources is passed.
+
 
 
 .SS "dataset source"
-[BETA] Inspect and manage a dataset's datasources.
+Inspect and manage a dataset's datasources.
 
 .B Usage:
 [options] [command]
@@ -3352,19 +3402,19 @@ Examples:
 .B Subcommands:
 .TP
 .B dataset source list
-[BETA] List the datasources defined on a dataset (local YAML path or cloud id).
+List the datasources defined on a dataset (local YAML path or cloud id).
 .TP
 .B dataset source add
-[BETA] Add a datasource to a dataset.
+Add a datasource to a dataset.
 .TP
 .B dataset source remove
-[BETA] Remove a datasource from a dataset (local YAML path or cloud id).
+Remove a datasource from a dataset (local YAML path or cloud id).
 .TP
 .B dataset source update
-[BETA] Update fields on an existing datasource. Only the flags you provide are changed.
+Update fields on an existing datasource. Only the flags you provide are changed.
 
 .SS "dataset source list"
-[BETA] List the datasources defined on a dataset (local YAML path or cloud id).
+List the datasources defined on a dataset (local YAML path or cloud id).
 
 .B Usage:
 [options]
@@ -3389,27 +3439,27 @@ Examples:
 
 
 .SS "dataset source add"
-[BETA] Add a datasource to a dataset.
+Add a datasource to a dataset.
 
 .B Usage:
-[options]
+[options] [datasetPathOrId]
 
 .B Options:
 .TP
 .B \-d, \-\-dataset <datasetPathOrId>
-Dataset to add the source to — a local .dataset.yaml path or a cloud dataset id
+Dataset to add the source to; positional target is also accepted for v1.45 compatibility
 .TP
 .B \-n, \-\-name <name>
 Logical name for the source (becomes the SQL table name)
 .TP
 .B \-\-source\-id <uuid>
-Override the generated source id
+Override the generated source id (local dataset only)
 .TP
-.B \-\-format <csv|json|mysql|postgres>
-Override the inferred format
+.B \-\-format <csv|json|mysql|postgres|sqlserver>
+Use this format instead of extension/type inference; file contents are not sniffed
 .TP
-.B \-\-type <local|remote\-url|mysql|postgresql>
-Source kind; inferred from \-\-file/\-\-url when omitted
+.B \-\-type <local|mysql|postgresql|sqlserver>
+Source kind; local is inferred when \-\-file is provided
 .TP
 .B \-\-file <path>
 Path to a local CSV/JSON file (absolute or cwd\-relative)
@@ -3423,14 +3473,11 @@ When copying, overwrite an existing file at the destination (local dataset)
 .B \-\-upload
 Cloud dataset only: upload \-\-file as a postmancloudfile source (runs via /exec). Without \-\-upload, \-\-file is registered as a local_filesystem csv/json source read by the local engine.
 .TP
-.B \-\-url <url>
-HTTP(S) URL to a remote CSV/JSON file
-.TP
 .B \-\-host <host>
-DB host (mysql/postgresql)
+DB host (mysql/postgresql/sqlserver)
 .TP
 .B \-\-port <port>
-DB port
+DB port (defaults to 1433 for sqlserver)
 .TP
 .B \-\-user <user>
 DB user (warning: stored as plaintext in the YAML).
@@ -3442,7 +3489,7 @@ DB password. WARNING: passing it here exposes it in `ps` output and shell histor
 DB database name
 .TP
 .B \-\-table <table>
-DB table name (optional)
+DB table name (required for sqlserver)
 .TP
 .B \-\-ssh\-host <host>
 SSH bastion host
@@ -3468,14 +3515,45 @@ Shared Vault secret ID containing the SSH public host key
 .B \-\-ssh\-insecure\-skip\-host\-key\-verification
 WARNING: disable SSH host\-key verification; use only for trusted local testing
 .TP
-.B \-\-slug <slug>
-Optional slug for the source
+.B \-\-schema <schema>
+DB schema (postgresql/sqlserver; defaults to dbo for sqlserver)
+.TP
+.B \-\-encrypt <true|false>
+SQL Server TLS encryption (default: true)
+.TP
+.B \-\-trust\-server\-certificate <true|false>
+SQL Server: skip certificate verification (default: false; insecure)
+.TP
+.B \-\-tls\-certificate <path>
+SQL Server CA/server certificate file path
+.TP
+.B \-\-host\-name\-in\-certificate <hostname>
+SQL Server certificate hostname override
+.TP
+.B \-\-tls\-min\-version <1.2|1.3>
+SQL Server minimum TLS version (default: 1.2)
 .TP
 .B \-\-api\-key <key>
 Postman API key (defaults to the `postman login` session)
 
+.TP Examples:
+
+Examples:
+  postman dataset source add \-d ./users.dataset.yaml \-n users \-\-file ./users.csv
+  postman dataset source add \-d ./users.dataset.yaml \-n users \-\-file ./users.txt \-\-format json
+  postman dataset source add \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \e
+    \-n users \-\-file ./users.csv \-\-upload
+
+Format selection:
+  File extensions are used only when \-\-format is omitted. An explicit \-\-format is authoritative.
+
+Execution:
+  \-\-upload runs file\-backed queries in the cloud service. Without \-\-upload, the local engine reads the file.
+
+
+
 .SS "dataset source remove"
-[BETA] Remove a datasource from a dataset (local YAML path or cloud id).
+Remove a datasource from a dataset (local YAML path or cloud id).
 
 .B Usage:
 [options] <sourceNameOrId>
@@ -3498,7 +3576,7 @@ Examples:
 
 
 .SS "dataset source update"
-[BETA] Update fields on an existing datasource. Only the flags you provide are changed.
+Update fields on an existing datasource. Only the flags you provide are changed.
 
 .B Usage:
 [options] <sourceNameOrId>
@@ -3511,23 +3589,20 @@ Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset
 .B \-n, \-\-name <name>
 Rename the source
 .TP
-.B \-\-format <csv|json|mysql|postgres>
-Change the format
+.B \-\-format <csv|json|mysql|postgres|sqlserver>
+Change the format (local dataset only; cloud source formats are immutable)
 .TP
 .B \-\-file <path>
-Replace the source's file (local\-filesystem only)
+Replace the source file (local dataset only; cloud file replacement is unsupported)
 .TP
 .B \-\-ref\-only
-When using \-\-file, reference in place instead of copying
+With \-\-file, reference in place instead of copying (local dataset only)
 .TP
 .B \-\-force
-When copying with \-\-file, overwrite existing destination
-.TP
-.B \-\-url <url>
-Replace the remote URL (remote\-url only)
+With \-\-file, overwrite the copied destination (local dataset only)
 .TP
 .B \-\-host <host>
-Update DB host (mysql/postgresql)
+Update DB host (mysql/postgresql/sqlserver)
 .TP
 .B \-\-port <port>
 Update DB port
@@ -3568,14 +3643,39 @@ Update the Shared Vault secret ID containing the SSH public host key
 .B \-\-ssh\-insecure\-skip\-host\-key\-verification
 WARNING: disable SSH host\-key verification; use only for trusted local testing
 .TP
-.B \-\-slug <slug>
-Update slug
+.B \-\-schema <schema>
+Update DB schema (postgresql/sqlserver)
+.TP
+.B \-\-encrypt <true|false>
+Update SQL Server TLS encryption
+.TP
+.B \-\-trust\-server\-certificate <true|false>
+Update SQL Server certificate verification (true is insecure)
+.TP
+.B \-\-tls\-certificate <path>
+Update SQL Server CA/server certificate file path
+.TP
+.B \-\-host\-name\-in\-certificate <hostname>
+Update SQL Server certificate hostname override
+.TP
+.B \-\-tls\-min\-version <1.2|1.3>
+Update SQL Server minimum TLS version
 .TP
 .B \-\-api\-key <key>
 Postman API key (defaults to the `postman login` session)
 
+.TP Examples:
+
+Examples:
+  postman dataset source update users \-d ./users.dataset.yaml \-\-name customers
+  postman dataset source update users \-d ./users.dataset.yaml \-\-file ./users\-v2.csv
+  postman dataset source update orders\-db \e
+    \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-\-host db.internal.example
+
+
+
 .SS "dataset view"
-[BETA] Inspect and manage saved views on a dataset.
+Inspect and manage saved views on a dataset.
 
 .B Usage:
 [options] [command]
@@ -3583,22 +3683,22 @@ Postman API key (defaults to the `postman login` session)
 .B Subcommands:
 .TP
 .B dataset view list
-[BETA] List the saved views defined on a dataset (local YAML path or cloud id).
+List the saved views defined on a dataset (local YAML path or cloud id).
 .TP
 .B dataset view run
-[BETA] Execute a saved view against a dataset and print the rows.
+Execute a saved view against a dataset and print the rows.
 .TP
 .B dataset view create
-[BETA] Add a saved view to a dataset (local YAML path or cloud id).
+Add a saved view to a dataset (local YAML path or cloud id).
 .TP
 .B dataset view delete
-[BETA] Remove a saved view from a dataset (local YAML path or cloud id).
+Remove a saved view from a dataset (local YAML path or cloud id).
 .TP
 .B dataset view update
-[BETA] Update name and/or query on an existing view (local YAML path or cloud id).
+Update name and/or query on an existing view (local YAML path or cloud id).
 
 .SS "dataset view list"
-[BETA] List the saved views defined on a dataset (local YAML path or cloud id).
+List the saved views defined on a dataset (local YAML path or cloud id).
 
 .B Usage:
 [options]
@@ -3623,7 +3723,7 @@ Examples:
 
 
 .SS "dataset view run"
-[BETA] Execute a saved view against a dataset and print the rows.
+Execute a saved view against a dataset and print the rows.
 
 .B Usage:
 [options] <viewNameOrId>
@@ -3634,25 +3734,30 @@ Examples:
 Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
 .TP
 .B \-p, \-\-param <value...>
-Positional parameter values for $1, $2, ... bindings; repeatable
+Bind values to $1, $2, ... in order; pass multiple values after \-p or repeat \-p
 .TP
 .B \-\-api\-key <key>
 Postman API key (defaults to the `postman login` session)
 .TP
 .B \-\-json
 Output rows as JSON instead of a table
+.TP
+.B \-\-debug
+Include safe classified dataset diagnostics
 
 .TP Examples:
 
 Examples:
   postman dataset view run "Active Users" \-d ./users.dataset.yaml
+  postman dataset view run "Users By Status" \-d ./users.dataset.yaml \-p active 20
   postman dataset view run ea748a6a\-ed3c\-496d\-b91e\-6ccc8e4d0e9d \-d ./users.dataset.yaml
-  postman dataset view run "Active Users" \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
+  postman dataset view run "Active Users" \e
+    \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-p true
 
 
 
 .SS "dataset view create"
-[BETA] Add a saved view to a dataset (local YAML path or cloud id).
+Add a saved view to a dataset (local YAML path or cloud id).
 
 .B Usage:
 [options]
@@ -3685,7 +3790,7 @@ Examples:
 
 
 .SS "dataset view delete"
-[BETA] Remove a saved view from a dataset (local YAML path or cloud id).
+Remove a saved view from a dataset (local YAML path or cloud id).
 
 .B Usage:
 [options] <viewNameOrId>
@@ -3707,7 +3812,7 @@ Examples:
 
 
 .SS "dataset view update"
-[BETA] Update name and/or query on an existing view (local YAML path or cloud id).
+Update name and/or query on an existing view (local YAML path or cloud id).
 
 .B Usage:
 [options] <viewNameOrId>
@@ -3729,8 +3834,10 @@ Postman API key (defaults to the `postman login` session)
 .TP Examples:
 
 Examples:
-  postman dataset view update "Active Users" \-d ./users.dataset.yaml \-q "SELECT ..."
-  postman dataset view update "Active Users" \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT ..."
+  postman dataset view update "Active Users" \e
+    \-d ./users.dataset.yaml \-q "SELECT * FROM source_users"
+  postman dataset view update "Active Users" \e
+    \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users"
 
 
 

package/package.json

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