postman-cli 1.46.1 → 1.48.0
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 +88 -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-19" "v1.48.0" "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
|
|
@@ -569,6 +572,9 @@ Prepare local collections and environments for push by validating and regenerati
|
|
|
569
572
|
.TP
|
|
570
573
|
.B workspace push
|
|
571
574
|
Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.
|
|
575
|
+
.TP
|
|
576
|
+
.B workspace lint
|
|
577
|
+
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
572
578
|
|
|
573
579
|
.SS "workspace list"
|
|
574
580
|
List all available Postman Workspaces
|
|
@@ -637,6 +643,26 @@ Show detailed logging
|
|
|
637
643
|
.B \-\-report\-events
|
|
638
644
|
Send workspace push events to Postman
|
|
639
645
|
|
|
646
|
+
.SS "workspace lint"
|
|
647
|
+
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
648
|
+
|
|
649
|
+
.B Usage:
|
|
650
|
+
[options]
|
|
651
|
+
|
|
652
|
+
.B Options:
|
|
653
|
+
.TP
|
|
654
|
+
.B \-f, \-\-fail\-severity <value>
|
|
655
|
+
Exit with failure if diagnostics at this level or above are present. [choices: "error", "warning", "info", "hint"] (default: error)
|
|
656
|
+
.TP
|
|
657
|
+
.B \-o, \-\-output <value>
|
|
658
|
+
Output format: cli (human\-readable), table, or json. (default: cli)
|
|
659
|
+
.TP
|
|
660
|
+
.B \-\-meta
|
|
661
|
+
Only lint the workspace configuration (.postman/resources.yaml); skip per\-entity linting.
|
|
662
|
+
.TP
|
|
663
|
+
.B \-\-workspace\-id <value>
|
|
664
|
+
The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.
|
|
665
|
+
|
|
640
666
|
.SS "performance"
|
|
641
667
|
Manage performance tests on your collections.
|
|
642
668
|
|
|
@@ -674,6 +700,21 @@ Load profile type: fixed, ramp\-up, spike, peak (default: ramp\-up)
|
|
|
674
700
|
.B \-\-data\-file <path>
|
|
675
701
|
Path to a JSON or CSV data file to use with the collection
|
|
676
702
|
.TP
|
|
703
|
+
.B \-\-dataset\-id <id>
|
|
704
|
+
Use a Postman Dataset as iteration data (with \-\-dataset\-view\-id)
|
|
705
|
+
.TP
|
|
706
|
+
.B \-\-dataset\-view\-id <id>
|
|
707
|
+
Dataset view to execute for iteration data (requires \-\-dataset\-id)
|
|
708
|
+
.TP
|
|
709
|
+
.B \-\-dataset\-offset <offset>
|
|
710
|
+
Row offset into the view result (optional range)
|
|
711
|
+
.TP
|
|
712
|
+
.B \-\-dataset\-limit <limit>
|
|
713
|
+
Max rows to fetch from the view (optional range)
|
|
714
|
+
.TP
|
|
715
|
+
.B \-\-dataset\-distribution <strategy>
|
|
716
|
+
How rows map to VUs: round\-robin (default), pinned, random
|
|
717
|
+
.TP
|
|
677
718
|
.B \-\-postman\-api\-key <apiKey>
|
|
678
719
|
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
720
|
.TP
|
|
@@ -1724,9 +1765,46 @@ Run and manage local Postman mock servers.
|
|
|
1724
1765
|
|
|
1725
1766
|
.B Subcommands:
|
|
1726
1767
|
.TP
|
|
1768
|
+
.B mock generate
|
|
1769
|
+
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.
|
|
1770
|
+
.TP
|
|
1727
1771
|
.B mock run
|
|
1728
1772
|
Start a local mock server given a manifest file (JSON or YAML).
|
|
1729
1773
|
|
|
1774
|
+
.SS "mock generate"
|
|
1775
|
+
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.
|
|
1776
|
+
|
|
1777
|
+
.B Usage:
|
|
1778
|
+
<sourcePath> [options]
|
|
1779
|
+
|
|
1780
|
+
.B Options:
|
|
1781
|
+
.TP
|
|
1782
|
+
.B \-o, \-\-output <dir>
|
|
1783
|
+
Output directory for the mock (default: postman/mocks/<slug>)
|
|
1784
|
+
.TP
|
|
1785
|
+
.B \-\-name <name>
|
|
1786
|
+
Display name for the generated mock
|
|
1787
|
+
.TP
|
|
1788
|
+
.B \-\-port <port>
|
|
1789
|
+
Port the mock server should listen on (default: 4500)
|
|
1790
|
+
.TP
|
|
1791
|
+
.B \-\-force
|
|
1792
|
+
Overwrite the config.yaml/default.js in the output directory if it already exists
|
|
1793
|
+
.TP
|
|
1794
|
+
.B \-u, \-\-update <mockPath>
|
|
1795
|
+
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.
|
|
1796
|
+
.TP
|
|
1797
|
+
.B \-x, \-\-suppress\-exit\-code
|
|
1798
|
+
Always exit with code 0, even on failure
|
|
1799
|
+
|
|
1800
|
+
.TP Examples:
|
|
1801
|
+
|
|
1802
|
+
Eg. postman mock generate ./my\-collection.json
|
|
1803
|
+
postman mock generate "./postman/collections/My Collection" \-\-port 4010
|
|
1804
|
+
postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
|
|
1805
|
+
postman mock generate ./my\-collection.json \-\-update ./postman/mocks/orders
|
|
1806
|
+
|
|
1807
|
+
|
|
1730
1808
|
.SS "mock run"
|
|
1731
1809
|
Start a local mock server given a manifest file (JSON or YAML).
|
|
1732
1810
|
|
|
@@ -1740,11 +1818,16 @@ Path to an environment file (JSON or YAML) for pm.environment
|
|
|
1740
1818
|
.TP
|
|
1741
1819
|
.B \-g, \-\-globals <path>
|
|
1742
1820
|
Path to a globals file (JSON or YAML) for pm.globals
|
|
1821
|
+
.TP
|
|
1822
|
+
.B \-p, \-\-port <port>
|
|
1823
|
+
Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
|
|
1743
1824
|
|
|
1744
1825
|
.TP Examples:
|
|
1745
1826
|
Eg. postman mock run ./postman/mock\-manifest.json
|
|
1746
1827
|
postman mock run ./postman/mock\-manifest.yaml
|
|
1747
1828
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1829
|
+
postman mock run ./manifest.yaml \-\-port auto # OS\-assigned ephemeral port
|
|
1830
|
+
postman mock run ./manifest.yaml \-\-port 4600 # exact port, errors if busy
|
|
1748
1831
|
|
|
1749
1832
|
|
|
1750
1833
|
.SS "application"
|
|
@@ -1818,6 +1901,9 @@ Environment override for the selected target (last value wins) (default: )
|
|
|
1818
1901
|
.B \-\-command <cmd>
|
|
1819
1902
|
Command to run first (primary task). Overrides config.
|
|
1820
1903
|
.TP
|
|
1904
|
+
.B \-\-deployed\-version <version>
|
|
1905
|
+
Version identity of the application under test (e.g. a build ID, release tag, or version string). Also read from the APP_DEPLOYED_VERSION environment variable.
|
|
1906
|
+
.TP
|
|
1821
1907
|
.B \-\-network\-log <path>
|
|
1822
1908
|
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/.
|
|
1823
1909
|
.TP
|
|
@@ -1861,6 +1947,7 @@ Use \-\-report\-events to send run results to Postman. Analytics are also sent a
|
|
|
1861
1947
|
Examples:
|
|
1862
1948
|
postman application test \-\-command "npx playwright test"
|
|
1863
1949
|
postman application test \-\-target prod
|
|
1950
|
+
postman application test \-\-command "npx playwright test" \-\-deployed\-version $BUILD_ID
|
|
1864
1951
|
postman application test \-\-target beta \-\-target\-collection api.json \-\-target\-environment staging.json
|
|
1865
1952
|
postman app test \-\-capture\-only \-\-command "npx playwright test"
|
|
1866
1953
|
postman app test \-\-capture\-only \-\-output ./my\-captured\-traffic/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.48.0",
|
|
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.48.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.48.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.48.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.48.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.48.0"
|
|
66
66
|
}
|
|
67
67
|
}
|