postman-cli 1.49.0 → 1.50.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 +220 -13
- 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-27" "v1.50.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -575,6 +575,12 @@ Push local workspace entities (collections, environments, specifications, and mo
|
|
|
575
575
|
.TP
|
|
576
576
|
.B workspace lint
|
|
577
577
|
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
578
|
+
.TP
|
|
579
|
+
.B workspace pull
|
|
580
|
+
Pull workspace entities from a Postman workspace into the local git\-native folder.
|
|
581
|
+
.TP
|
|
582
|
+
.B workspace connect-git
|
|
583
|
+
Connect a Postman workspace to a local git repository.
|
|
578
584
|
|
|
579
585
|
.SS "workspace list"
|
|
580
586
|
List all available Postman Workspaces
|
|
@@ -662,6 +668,62 @@ Only lint the workspace configuration (.postman/resources.yaml); skip per\-entit
|
|
|
662
668
|
.TP
|
|
663
669
|
.B \-\-workspace\-id <value>
|
|
664
670
|
The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.
|
|
671
|
+
.TP
|
|
672
|
+
.B \-\-fix
|
|
673
|
+
Apply safe autofixes to repairable workspace lint issues.
|
|
674
|
+
|
|
675
|
+
.SS "workspace pull"
|
|
676
|
+
Pull workspace entities from a Postman workspace into the local git\-native folder.
|
|
677
|
+
|
|
678
|
+
.B Usage:
|
|
679
|
+
[options] [workspaceId]
|
|
680
|
+
|
|
681
|
+
.B Options:
|
|
682
|
+
.TP
|
|
683
|
+
.B \-y, \-\-yes
|
|
684
|
+
Skip all confirmation prompts
|
|
685
|
+
.TP
|
|
686
|
+
.B \-\-source\-workspace <workspaceId>
|
|
687
|
+
Pull from a different source workspace.
|
|
688
|
+
.TP
|
|
689
|
+
.B \-\-verbose
|
|
690
|
+
Show detailed logging
|
|
691
|
+
|
|
692
|
+
.TP Examples:
|
|
693
|
+
|
|
694
|
+
Examples:
|
|
695
|
+
postman workspace pull
|
|
696
|
+
Pull from the workspace connected to the current directory's git remote
|
|
697
|
+
postman workspace pull <workspaceId>
|
|
698
|
+
Connect the workspace to the current directory's git remote and pull
|
|
699
|
+
from the workspace.
|
|
700
|
+
postman workspace pull \-\-source\-workspace <workspaceId>
|
|
701
|
+
Pull from another workspace
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
.SS "workspace connect\-git"
|
|
706
|
+
Connect a Postman workspace to a local git repository.
|
|
707
|
+
|
|
708
|
+
.B Usage:
|
|
709
|
+
[options] <workspaceId> [path]
|
|
710
|
+
|
|
711
|
+
.B Options:
|
|
712
|
+
.TP
|
|
713
|
+
.B \-\-verbose
|
|
714
|
+
Show detailed logging
|
|
715
|
+
|
|
716
|
+
.TP Examples:
|
|
717
|
+
|
|
718
|
+
Examples:
|
|
719
|
+
postman workspace connect\-git <workspaceId>
|
|
720
|
+
Register the current directory's git remote with the workspace and write the
|
|
721
|
+
local .postman/resources.yaml claim. Prerequisite for `pull` and `push`.
|
|
722
|
+
postman workspace connect\-git <workspaceId> ./services/api
|
|
723
|
+
Connect a specific folder. A folder below the repo root binds to its subpath,
|
|
724
|
+
so one repository can back several workspaces.
|
|
725
|
+
|
|
726
|
+
|
|
665
727
|
|
|
666
728
|
.SS "performance"
|
|
667
729
|
Manage performance tests on your collections.
|
|
@@ -712,8 +774,8 @@ How rows map to VUs: round\-robin (default), fixed, random
|
|
|
712
774
|
.B \-\-postman\-api\-key <apiKey>
|
|
713
775
|
API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
|
|
714
776
|
.TP
|
|
715
|
-
.B \-\-
|
|
716
|
-
|
|
777
|
+
.B \-\-runner <runner>
|
|
778
|
+
Runner to execute the performance test on (local or postman\-cloud) (default: )
|
|
717
779
|
.TP
|
|
718
780
|
.B \-\-pass\-if <condition>
|
|
719
781
|
Pass condition in format: function(metric, value).
|
|
@@ -1766,24 +1828,33 @@ Run and manage local Postman mock servers.
|
|
|
1766
1828
|
.B Subcommands:
|
|
1767
1829
|
.TP
|
|
1768
1830
|
.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.
|
|
1831
|
+
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.
|
|
1770
1832
|
.TP
|
|
1771
1833
|
.B mock run
|
|
1772
|
-
Start a local mock server given a manifest file (JSON or YAML).
|
|
1834
|
+
Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
|
|
1835
|
+
.TP
|
|
1836
|
+
.B mock get
|
|
1837
|
+
Show a local mock's details and run status.
|
|
1838
|
+
.TP
|
|
1839
|
+
.B mock list
|
|
1840
|
+
List local mocks found under a directory.
|
|
1841
|
+
.TP
|
|
1842
|
+
.B mock delete
|
|
1843
|
+
Permanently remove a local mock artifact.
|
|
1773
1844
|
|
|
1774
1845
|
.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.
|
|
1846
|
+
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.
|
|
1776
1847
|
|
|
1777
1848
|
.B Usage:
|
|
1778
|
-
|
|
1849
|
+
[sourcePath] [options]
|
|
1779
1850
|
|
|
1780
1851
|
.B Options:
|
|
1781
1852
|
.TP
|
|
1782
1853
|
.B \-o, \-\-output <dir>
|
|
1783
1854
|
Output directory for the mock (default: postman/mocks/<slug>)
|
|
1784
1855
|
.TP
|
|
1785
|
-
.B \-\-name <name>
|
|
1786
|
-
Display name for the generated mock
|
|
1856
|
+
.B \-n, \-\-name <name>
|
|
1857
|
+
Display name for the generated mock. Optional with a source (derived from it); required when generating without a source.
|
|
1787
1858
|
.TP
|
|
1788
1859
|
.B \-\-port <port>
|
|
1789
1860
|
Port the mock server should listen on (default: 4500)
|
|
@@ -1800,16 +1871,17 @@ Always exit with code 0, even on failure
|
|
|
1800
1871
|
.TP Examples:
|
|
1801
1872
|
|
|
1802
1873
|
Eg. postman mock generate ./my\-collection.json
|
|
1803
|
-
postman mock generate "
|
|
1874
|
+
postman mock generate \-\-name "My Mock" # sample mock with a GET /health endpoint
|
|
1875
|
+
postman mock generate \-\-name "My Mock" \-\-port 4010 # sample mock, custom port
|
|
1804
1876
|
postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
|
|
1805
1877
|
postman mock generate ./my\-collection.json \-\-update ./postman/mocks/orders
|
|
1806
1878
|
|
|
1807
1879
|
|
|
1808
1880
|
.SS "mock run"
|
|
1809
|
-
Start a local mock server given a manifest file (JSON or YAML).
|
|
1881
|
+
Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
|
|
1810
1882
|
|
|
1811
1883
|
.B Usage:
|
|
1812
|
-
<
|
|
1884
|
+
<pathOrDir>
|
|
1813
1885
|
|
|
1814
1886
|
.B Options:
|
|
1815
1887
|
.TP
|
|
@@ -1823,13 +1895,67 @@ Path to a globals file (JSON or YAML) for pm.globals
|
|
|
1823
1895
|
Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
|
|
1824
1896
|
|
|
1825
1897
|
.TP Examples:
|
|
1826
|
-
Eg. postman mock run ./postman/mock
|
|
1898
|
+
Eg. postman mock run ./postman/mocks/orders # a mock directory
|
|
1899
|
+
postman mock run ./postman/mock\-manifest.json
|
|
1827
1900
|
postman mock run ./postman/mock\-manifest.yaml
|
|
1828
1901
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1829
1902
|
postman mock run ./manifest.yaml \-\-port auto # OS\-assigned ephemeral port
|
|
1830
1903
|
postman mock run ./manifest.yaml \-\-port 4600 # exact port, errors if busy
|
|
1831
1904
|
|
|
1832
1905
|
|
|
1906
|
+
.SS "mock get"
|
|
1907
|
+
Show a local mock's details and run status.
|
|
1908
|
+
|
|
1909
|
+
.B Usage:
|
|
1910
|
+
<pathOrDir> [options]
|
|
1911
|
+
|
|
1912
|
+
.B Options:
|
|
1913
|
+
.TP
|
|
1914
|
+
.B \-\-json
|
|
1915
|
+
Output the mock details as JSON instead of a table
|
|
1916
|
+
|
|
1917
|
+
.TP Examples:
|
|
1918
|
+
|
|
1919
|
+
Eg. postman mock get ./postman/mocks/orders
|
|
1920
|
+
postman mock get ./postman/mocks/orders \-\-json
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
.SS "mock list"
|
|
1924
|
+
List local mocks found under a directory.
|
|
1925
|
+
|
|
1926
|
+
.B Usage:
|
|
1927
|
+
[pathOrDir] [options]
|
|
1928
|
+
|
|
1929
|
+
.B Options:
|
|
1930
|
+
.TP
|
|
1931
|
+
.B \-\-json
|
|
1932
|
+
Output the mock list as JSON instead of a table
|
|
1933
|
+
|
|
1934
|
+
.TP Examples:
|
|
1935
|
+
|
|
1936
|
+
Eg. postman mock list
|
|
1937
|
+
postman mock list ./postman/mocks
|
|
1938
|
+
postman mock list ./postman/mocks \-\-json
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
.SS "mock delete"
|
|
1942
|
+
Permanently remove a local mock artifact.
|
|
1943
|
+
|
|
1944
|
+
.B Usage:
|
|
1945
|
+
<pathOrDir> [options]
|
|
1946
|
+
|
|
1947
|
+
.B Options:
|
|
1948
|
+
.TP
|
|
1949
|
+
.B \-y, \-\-yes
|
|
1950
|
+
Skip the confirmation prompt
|
|
1951
|
+
|
|
1952
|
+
.TP Examples:
|
|
1953
|
+
|
|
1954
|
+
Eg. postman mock delete ./postman/mocks/orders
|
|
1955
|
+
postman mock delete ./postman/mocks/orders \-\-yes
|
|
1956
|
+
postman mock delete ./postman/mocks/orders/config.yaml \-\-yes
|
|
1957
|
+
|
|
1958
|
+
|
|
1833
1959
|
.SS "application"
|
|
1834
1960
|
Application\-level commands: initialise config and run tests.
|
|
1835
1961
|
|
|
@@ -1839,12 +1965,17 @@ Application\-level commands: initialise config and run tests.
|
|
|
1839
1965
|
.B Subcommands:
|
|
1840
1966
|
.TP
|
|
1841
1967
|
.B application init
|
|
1968
|
+
[DEPRECATED] Use `postman app test` instead.
|
|
1842
1969
|
Initialise a postman.config.cjs file with target collections, environment, and test command.
|
|
1843
1970
|
.TP
|
|
1844
1971
|
.B application test
|
|
1845
1972
|
Run a command first (primary task), then match captured traffic against Postman collections and run assertions.
|
|
1973
|
+
.TP
|
|
1974
|
+
.B application setup-capture
|
|
1975
|
+
Install postman\-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().
|
|
1846
1976
|
|
|
1847
1977
|
.SS "application init"
|
|
1978
|
+
[DEPRECATED] Use `postman app test` instead.
|
|
1848
1979
|
Initialise a postman.config.cjs file with target collections, environment, and test command.
|
|
1849
1980
|
|
|
1850
1981
|
.B Usage:
|
|
@@ -1953,6 +2084,34 @@ Examples:
|
|
|
1953
2084
|
postman app test \-\-capture\-only \-\-output ./my\-captured\-traffic/
|
|
1954
2085
|
|
|
1955
2086
|
|
|
2087
|
+
.SS "application setup\-capture"
|
|
2088
|
+
Install postman\-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().
|
|
2089
|
+
|
|
2090
|
+
.B Usage:
|
|
2091
|
+
[options]
|
|
2092
|
+
|
|
2093
|
+
.B Options:
|
|
2094
|
+
.TP
|
|
2095
|
+
.B \-\-config <path>
|
|
2096
|
+
Path to playwright.config.* to patch (default: auto\-detect)
|
|
2097
|
+
|
|
2098
|
+
.TP Examples:
|
|
2099
|
+
|
|
2100
|
+
Detects the package manager (npm / yarn / pnpm / bun) from lockfiles,
|
|
2101
|
+
installs postman\-playwright as a dev dependency if needed, then
|
|
2102
|
+
wraps your Playwright config's default export with withPostman().
|
|
2103
|
+
|
|
2104
|
+
If auto\-patching is not possible (unusual config patterns), the
|
|
2105
|
+
command prints manual setup steps instead.
|
|
2106
|
+
|
|
2107
|
+
Examples:
|
|
2108
|
+
postman app setup\-capture
|
|
2109
|
+
postman app setup\-capture \-\-config apps/api/playwright.config.ts
|
|
2110
|
+
|
|
2111
|
+
After setup, run your tests normally:
|
|
2112
|
+
postman app test
|
|
2113
|
+
|
|
2114
|
+
|
|
1956
2115
|
.SS "simulate"
|
|
1957
2116
|
Start mock servers with simulated failure scenarios.
|
|
1958
2117
|
|
|
@@ -3285,6 +3444,30 @@ DB database name
|
|
|
3285
3444
|
.B \-\-table <table>
|
|
3286
3445
|
DB table name (optional)
|
|
3287
3446
|
.TP
|
|
3447
|
+
.B \-\-ssh\-host <host>
|
|
3448
|
+
SSH bastion host
|
|
3449
|
+
.TP
|
|
3450
|
+
.B \-\-ssh\-port <port>
|
|
3451
|
+
SSH bastion port
|
|
3452
|
+
.TP
|
|
3453
|
+
.B \-\-ssh\-user <user>
|
|
3454
|
+
SSH bastion user
|
|
3455
|
+
.TP
|
|
3456
|
+
.B \-\-ssh\-private\-key <filepath>
|
|
3457
|
+
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.
|
|
3458
|
+
.TP
|
|
3459
|
+
.B \-\-ssh\-host\-key <publicKey>
|
|
3460
|
+
SSH bastion public host key
|
|
3461
|
+
.TP
|
|
3462
|
+
.B \-\-ssh\-host\-key\-vault\-id <id>
|
|
3463
|
+
Shared Vault ID containing the SSH public host key
|
|
3464
|
+
.TP
|
|
3465
|
+
.B \-\-ssh\-host\-key\-secret\-id <id>
|
|
3466
|
+
Shared Vault secret ID containing the SSH public host key
|
|
3467
|
+
.TP
|
|
3468
|
+
.B \-\-ssh\-insecure\-skip\-host\-key\-verification
|
|
3469
|
+
WARNING: disable SSH host\-key verification; use only for trusted local testing
|
|
3470
|
+
.TP
|
|
3288
3471
|
.B \-\-slug <slug>
|
|
3289
3472
|
Optional slug for the source
|
|
3290
3473
|
.TP
|
|
@@ -3361,6 +3544,30 @@ Update DB database name
|
|
|
3361
3544
|
.B \-\-table <table>
|
|
3362
3545
|
Update DB table name
|
|
3363
3546
|
.TP
|
|
3547
|
+
.B \-\-ssh\-host <host>
|
|
3548
|
+
Update SSH bastion host
|
|
3549
|
+
.TP
|
|
3550
|
+
.B \-\-ssh\-port <port>
|
|
3551
|
+
Update SSH bastion port
|
|
3552
|
+
.TP
|
|
3553
|
+
.B \-\-ssh\-user <user>
|
|
3554
|
+
Update SSH bastion user
|
|
3555
|
+
.TP
|
|
3556
|
+
.B \-\-ssh\-private\-key <filepath>
|
|
3557
|
+
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.
|
|
3558
|
+
.TP
|
|
3559
|
+
.B \-\-ssh\-host\-key <publicKey>
|
|
3560
|
+
Update the SSH bastion public host key
|
|
3561
|
+
.TP
|
|
3562
|
+
.B \-\-ssh\-host\-key\-vault\-id <id>
|
|
3563
|
+
Update the Shared Vault ID containing the SSH public host key
|
|
3564
|
+
.TP
|
|
3565
|
+
.B \-\-ssh\-host\-key\-secret\-id <id>
|
|
3566
|
+
Update the Shared Vault secret ID containing the SSH public host key
|
|
3567
|
+
.TP
|
|
3568
|
+
.B \-\-ssh\-insecure\-skip\-host\-key\-verification
|
|
3569
|
+
WARNING: disable SSH host\-key verification; use only for trusted local testing
|
|
3570
|
+
.TP
|
|
3364
3571
|
.B \-\-slug <slug>
|
|
3365
3572
|
Update slug
|
|
3366
3573
|
.TP
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.50.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.50.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.50.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.50.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.50.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.50.0"
|
|
66
66
|
}
|
|
67
67
|
}
|