postman-cli 1.46.1 → 1.47.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/man/postman.1 +61 -1
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-08-
|
|
1
|
+
.TH POSTMAN 1 "2026-08-17" "v1.47.2" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -266,6 +266,9 @@ Show detailed information of collection run and each request sent
|
|
|
266
266
|
.B \-\-mock <path>
|
|
267
267
|
Start a mock server from manifest (.json, .yaml or .yml) file
|
|
268
268
|
.TP
|
|
269
|
+
.B \-\-port <port>
|
|
270
|
+
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.
|
|
271
|
+
.TP
|
|
269
272
|
.B \-\-simulate <path>
|
|
270
273
|
Start mock servers with fault\-injection scenarios from a .sim.yaml file
|
|
271
274
|
.TP
|
|
@@ -674,6 +677,21 @@ Load profile type: fixed, ramp\-up, spike, peak (default: ramp\-up)
|
|
|
674
677
|
.B \-\-data\-file <path>
|
|
675
678
|
Path to a JSON or CSV data file to use with the collection
|
|
676
679
|
.TP
|
|
680
|
+
.B \-\-dataset\-id <id>
|
|
681
|
+
Use a Postman Dataset as iteration data (with \-\-dataset\-view\-id)
|
|
682
|
+
.TP
|
|
683
|
+
.B \-\-dataset\-view\-id <id>
|
|
684
|
+
Dataset view to execute for iteration data (requires \-\-dataset\-id)
|
|
685
|
+
.TP
|
|
686
|
+
.B \-\-dataset\-offset <offset>
|
|
687
|
+
Row offset into the view result (optional range)
|
|
688
|
+
.TP
|
|
689
|
+
.B \-\-dataset\-limit <limit>
|
|
690
|
+
Max rows to fetch from the view (optional range)
|
|
691
|
+
.TP
|
|
692
|
+
.B \-\-dataset\-distribution <strategy>
|
|
693
|
+
How rows map to VUs: round\-robin (default), pinned, random
|
|
694
|
+
.TP
|
|
677
695
|
.B \-\-postman\-api\-key <apiKey>
|
|
678
696
|
API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
|
|
679
697
|
.TP
|
|
@@ -1724,9 +1742,46 @@ Run and manage local Postman mock servers.
|
|
|
1724
1742
|
|
|
1725
1743
|
.B Subcommands:
|
|
1726
1744
|
.TP
|
|
1745
|
+
.B mock generate
|
|
1746
|
+
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.
|
|
1747
|
+
.TP
|
|
1727
1748
|
.B mock run
|
|
1728
1749
|
Start a local mock server given a manifest file (JSON or YAML).
|
|
1729
1750
|
|
|
1751
|
+
.SS "mock generate"
|
|
1752
|
+
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.
|
|
1753
|
+
|
|
1754
|
+
.B Usage:
|
|
1755
|
+
<sourcePath> [options]
|
|
1756
|
+
|
|
1757
|
+
.B Options:
|
|
1758
|
+
.TP
|
|
1759
|
+
.B \-o, \-\-output <dir>
|
|
1760
|
+
Output directory for the mock (default: postman/mocks/<slug>)
|
|
1761
|
+
.TP
|
|
1762
|
+
.B \-\-name <name>
|
|
1763
|
+
Display name for the generated mock
|
|
1764
|
+
.TP
|
|
1765
|
+
.B \-\-port <port>
|
|
1766
|
+
Port the mock server should listen on (default: 4500)
|
|
1767
|
+
.TP
|
|
1768
|
+
.B \-\-force
|
|
1769
|
+
Overwrite the config.yaml/default.js in the output directory if it already exists
|
|
1770
|
+
.TP
|
|
1771
|
+
.B \-u, \-\-update <mockPath>
|
|
1772
|
+
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.
|
|
1773
|
+
.TP
|
|
1774
|
+
.B \-x, \-\-suppress\-exit\-code
|
|
1775
|
+
Always exit with code 0, even on failure
|
|
1776
|
+
|
|
1777
|
+
.TP Examples:
|
|
1778
|
+
|
|
1779
|
+
Eg. postman mock generate ./my\-collection.json
|
|
1780
|
+
postman mock generate "./postman/collections/My Collection" \-\-port 4010
|
|
1781
|
+
postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
|
|
1782
|
+
postman mock generate ./my\-collection.json \-\-update ./postman/mocks/orders
|
|
1783
|
+
|
|
1784
|
+
|
|
1730
1785
|
.SS "mock run"
|
|
1731
1786
|
Start a local mock server given a manifest file (JSON or YAML).
|
|
1732
1787
|
|
|
@@ -1740,11 +1795,16 @@ Path to an environment file (JSON or YAML) for pm.environment
|
|
|
1740
1795
|
.TP
|
|
1741
1796
|
.B \-g, \-\-globals <path>
|
|
1742
1797
|
Path to a globals file (JSON or YAML) for pm.globals
|
|
1798
|
+
.TP
|
|
1799
|
+
.B \-p, \-\-port <port>
|
|
1800
|
+
Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
|
|
1743
1801
|
|
|
1744
1802
|
.TP Examples:
|
|
1745
1803
|
Eg. postman mock run ./postman/mock\-manifest.json
|
|
1746
1804
|
postman mock run ./postman/mock\-manifest.yaml
|
|
1747
1805
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1806
|
+
postman mock run ./manifest.yaml \-\-port auto # OS\-assigned ephemeral port
|
|
1807
|
+
postman mock run ./manifest.yaml \-\-port 4600 # exact port, errors if busy
|
|
1748
1808
|
|
|
1749
1809
|
|
|
1750
1810
|
.SS "application"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.47.2",
|
|
4
4
|
"description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"postman",
|
|
@@ -58,10 +58,10 @@
|
|
|
58
58
|
"man/"
|
|
59
59
|
],
|
|
60
60
|
"optionalDependencies": {
|
|
61
|
-
"@postman/pm-bin-macos-arm64": "1.
|
|
62
|
-
"@postman/pm-bin-macos-x64": "1.
|
|
63
|
-
"@postman/pm-bin-linux-x64": "1.
|
|
64
|
-
"@postman/pm-bin-linux-arm64": "1.
|
|
65
|
-
"@postman/pm-bin-windows-x64": "1.
|
|
61
|
+
"@postman/pm-bin-macos-arm64": "1.47.2",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.47.2",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.47.2",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.47.2",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.47.2"
|
|
66
66
|
}
|
|
67
67
|
}
|