postman-cli 1.49.0 → 1.51.0

package/man/postman.1

@@ -1,4 +1,4 @@
-.TH POSTMAN 1 "2026-08-21" "v1.49.0" "Postman CLI Manual"
+.TH POSTMAN 1 "2026-08-27" "v1.51.0" "Postman CLI Manual"
 .SH NAME
 postman \- Command\-line companion utility for Postman
 .SH SYNOPSIS
@@ -575,6 +575,12 @@ Push local workspace entities (collections, environments, specifications, and mo
 .TP
 .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 pull
+Pull workspace entities from a Postman workspace into the local git\-native folder.
+.TP
+.B workspace connect-git
+Connect a Postman workspace to a local git repository.
 
 .SS "workspace list"
 List all available Postman Workspaces
@@ -662,6 +668,62 @@ Only lint the workspace configuration (.postman/resources.yaml); skip per\-entit
 .TP
 .B \-\-workspace\-id <value>
 The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.
+.TP
+.B \-\-fix
+Apply safe autofixes to repairable workspace lint issues.
+
+.SS "workspace pull"
+Pull workspace entities from a Postman workspace into the local git\-native folder.
+
+.B Usage:
+[options] [workspaceId]
+
+.B Options:
+.TP
+.B \-y, \-\-yes
+Skip all confirmation prompts
+.TP
+.B \-\-source\-workspace <workspaceId>
+Pull from a different source workspace.
+.TP
+.B \-\-verbose
+Show detailed logging
+
+.TP Examples:
+
+Examples:
+  postman workspace pull
+      Pull from the workspace connected to the current directory's git remote
+  postman workspace pull <workspaceId>
+      Connect the workspace to the current directory's git remote and pull
+      from the workspace.
+  postman workspace pull \-\-source\-workspace <workspaceId>
+      Pull from another workspace
+
+
+
+.SS "workspace connect\-git"
+Connect a Postman workspace to a local git repository.
+
+.B Usage:
+[options] <workspaceId> [path]
+
+.B Options:
+.TP
+.B \-\-verbose
+Show detailed logging
+
+.TP Examples:
+
+Examples:
+  postman workspace connect\-git <workspaceId>
+      Register the current directory's git remote with the workspace and write the
+      local .postman/resources.yaml claim. Prerequisite for `pull` and `push`.
+  postman workspace connect\-git <workspaceId> ./services/api
+      Connect a specific folder. A folder below the repo root binds to its subpath,
+      so one repository can back several workspaces.
+
+
 
 .SS "performance"
 Manage performance tests on your collections.
@@ -712,8 +774,8 @@ How rows map to VUs: round\-robin (default), fixed, random
 .B \-\-postman\-api\-key <apiKey>
 API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
 .TP
-.B \-\-cloud
-Execute the performance test on Postman Cloud (beta) (default: false)
+.B \-\-runner <runner>
+Runner to execute the performance test on (local or postman\-cloud) (default: )
 .TP
 .B \-\-pass\-if <condition>
 Pass condition in format: function(metric, value). 
@@ -1766,24 +1828,33 @@ 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.
+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.
 .TP
 .B mock run
-Start a local mock server given a manifest file (JSON or YAML).
+Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
+.TP
+.B mock get
+Show a local mock's details and run status.
+.TP
+.B mock list
+List local mocks found under a directory.
+.TP
+.B mock delete
+Permanently remove a local mock artifact.
 
 .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.
+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.
 
 .B Usage:
-<sourcePath> [options]
+[sourcePath] [options]
 
 .B Options:
 .TP
 .B \-o, \-\-output <dir>
 Output directory for the mock (default: postman/mocks/<slug>)
 .TP
-.B \-\-name <name>
-Display name for the generated mock
+.B \-n, \-\-name <name>
+Display name for the generated mock. Optional with a source (derived from it); required when generating without a source.
 .TP
 .B \-\-port <port>
 Port the mock server should listen on (default: 4500)
@@ -1800,16 +1871,17 @@ Always exit with code 0, even on failure
 .TP Examples:
 
 Eg. postman mock generate ./my\-collection.json
-    postman mock generate "./postman/collections/My Collection" \-\-port 4010
+    postman mock generate \-\-name "My Mock"                  # sample mock with a GET /health endpoint
+    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
 
 
 .SS "mock run"
-Start a local mock server given a manifest file (JSON or YAML).
+Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
 
 .B Usage:
-<manifestPath>
+<pathOrDir>
 
 .B Options:
 .TP
@@ -1823,13 +1895,67 @@ Path to a globals file (JSON or YAML) for pm.globals
 Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
 
 .TP Examples:
-Eg. postman mock run ./postman/mock\-manifest.json
+Eg. 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
     postman mock run ./manifest.yaml \-\-port auto        # OS\-assigned ephemeral port
     postman mock run ./manifest.yaml \-\-port 4600        # exact port, errors if busy
 
 
+.SS "mock get"
+Show a local mock's details and run status.
+
+.B Usage:
+<pathOrDir> [options]
+
+.B Options:
+.TP
+.B \-\-json
+Output the mock details as JSON instead of a table
+
+.TP Examples:
+
+Eg. postman mock get ./postman/mocks/orders
+    postman mock get ./postman/mocks/orders \-\-json
+
+
+.SS "mock list"
+List local mocks found under a directory.
+
+.B Usage:
+[pathOrDir] [options]
+
+.B Options:
+.TP
+.B \-\-json
+Output the mock list as JSON instead of a table
+
+.TP Examples:
+
+Eg. postman mock list
+    postman mock list ./postman/mocks
+    postman mock list ./postman/mocks \-\-json
+
+
+.SS "mock delete"
+Permanently remove a local mock artifact.
+
+.B Usage:
+<pathOrDir> [options]
+
+.B Options:
+.TP
+.B \-y, \-\-yes
+Skip the confirmation prompt
+
+.TP Examples:
+
+Eg. postman mock delete ./postman/mocks/orders
+    postman mock delete ./postman/mocks/orders \-\-yes
+    postman mock delete ./postman/mocks/orders/config.yaml \-\-yes
+
+
 .SS "application"
 Application\-level commands: initialise config and run tests.
 
@@ -1839,12 +1965,17 @@ Application\-level commands: initialise config and run tests.
 .B Subcommands:
 .TP
 .B application init
+[DEPRECATED] Use `postman app test` instead.
 Initialise a postman.config.cjs file with target collections, environment, and test command.
 .TP
 .B application test
 Run a command first (primary task), then match captured traffic against Postman collections and run assertions.
+.TP
+.B application setup-capture
+Install postman\-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().
 
 .SS "application init"
+[DEPRECATED] Use `postman app test` instead.
 Initialise a postman.config.cjs file with target collections, environment, and test command.
 
 .B Usage:
@@ -1953,6 +2084,34 @@ Examples:
   postman app test \-\-capture\-only \-\-output ./my\-captured\-traffic/
 
 
+.SS "application setup\-capture"
+Install postman\-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().
+
+.B Usage:
+[options]
+
+.B Options:
+.TP
+.B \-\-config <path>
+Path to playwright.config.* to patch (default: auto\-detect)
+
+.TP Examples:
+
+Detects the package manager (npm / yarn / pnpm / bun) from lockfiles,
+installs postman\-playwright as a dev dependency if needed, then
+wraps your Playwright config's default export with withPostman().
+
+If auto\-patching is not possible (unusual config patterns), the
+command prints manual setup steps instead.
+
+Examples:
+    postman app setup\-capture
+    postman app setup\-capture \-\-config apps/api/playwright.config.ts
+
+After setup, run your tests normally:
+    postman app test
+
+
 .SS "simulate"
 Start mock servers with simulated failure scenarios.
 
@@ -3016,11 +3175,20 @@ Examples:
 
 
 .SS "dataset"
-[BETA] Work with Postman datasets defined in local YAML files.
+[BETA] 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
@@ -3036,7 +3204,7 @@ Examples:
 [BETA] 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.
+[BETA] 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.
@@ -3107,19 +3275,23 @@ 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"
 
 
@@ -3159,7 +3331,7 @@ Examples:
 
 
 .SS "dataset delete"
-[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
+[BETA] Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
 
 .B Usage:
 [options] <datasetPathOrId>
@@ -3170,7 +3342,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)
@@ -3182,6 +3354,10 @@ 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"
@@ -3233,24 +3409,24 @@ Examples:
 [BETA] 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)
@@ -3264,14 +3440,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).
@@ -3283,14 +3456,69 @@ 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
+.TP
+.B \-\-ssh\-port <port>
+SSH bastion port
+.TP
+.B \-\-ssh\-user <user>
+SSH bastion user
+.TP
+.B \-\-ssh\-private\-key <filepath>
+Path to the SSH private key. WARNING: the path is visible in `ps` output and shell history; key contents are read locally at execution time and are not stored in the dataset config.
+.TP
+.B \-\-ssh\-host\-key <publicKey>
+SSH bastion public host key
+.TP
+.B \-\-ssh\-host\-key\-vault\-id <id>
+Shared Vault ID containing the SSH public host key
+.TP
+.B \-\-ssh\-host\-key\-secret\-id <id>
+Shared Vault secret ID containing the SSH public host key
 .TP
-.B \-\-slug <slug>
-Optional slug for the source
+.B \-\-ssh\-insecure\-skip\-host\-key\-verification
+WARNING: disable SSH host\-key verification; use only for trusted local testing
+.TP
+.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).
 
@@ -3328,23 +3556,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
@@ -3361,12 +3586,61 @@ Update DB database name
 .B \-\-table <table>
 Update DB table name
 .TP
-.B \-\-slug <slug>
-Update slug
+.B \-\-ssh\-host <host>
+Update SSH bastion host
+.TP
+.B \-\-ssh\-port <port>
+Update SSH bastion port
+.TP
+.B \-\-ssh\-user <user>
+Update SSH bastion user
+.TP
+.B \-\-ssh\-private\-key <filepath>
+Update the SSH private\-key file path. WARNING: the path is visible in `ps` output and shell history; key contents are read locally and are not stored in the dataset config.
+.TP
+.B \-\-ssh\-host\-key <publicKey>
+Update the SSH bastion public host key
+.TP
+.B \-\-ssh\-host\-key\-vault\-id <id>
+Update the Shared Vault ID containing the SSH public host key
+.TP
+.B \-\-ssh\-host\-key\-secret\-id <id>
+Update the Shared Vault secret ID containing the SSH public host key
+.TP
+.B \-\-ssh\-insecure\-skip\-host\-key\-verification
+WARNING: disable SSH host\-key verification; use only for trusted local testing
+.TP
+.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.
 
@@ -3427,20 +3701,25 @@ 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
 
 
 
@@ -3522,8 +3801,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.49.0",
+  "version": "1.51.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.49.0",
-    "@postman/pm-bin-macos-x64": "1.49.0",
-    "@postman/pm-bin-linux-x64": "1.49.0",
-    "@postman/pm-bin-linux-arm64": "1.49.0",
-    "@postman/pm-bin-windows-x64": "1.49.0"
+    "@postman/pm-bin-macos-arm64": "1.51.0",
+    "@postman/pm-bin-macos-x64": "1.51.0",
+    "@postman/pm-bin-linux-x64": "1.51.0",
+    "@postman/pm-bin-linux-arm64": "1.51.0",
+    "@postman/pm-bin-windows-x64": "1.51.0"
   }
 }