postman-cli 1.52.0 → 1.53.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 +137 -20
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-
|
|
1
|
+
.TH POSTMAN 1 "2026-09-02" "v1.53.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -767,6 +767,12 @@ Specify an Id to a Postman Environment
|
|
|
767
767
|
.B \-g, \-\-globals <id>
|
|
768
768
|
Specify an Id to a Postman Globals
|
|
769
769
|
.TP
|
|
770
|
+
.B \-\-setup\-collection <id>
|
|
771
|
+
Collection UID to run before the Postman Cloud performance test
|
|
772
|
+
.TP
|
|
773
|
+
.B \-\-teardown\-collection <id>
|
|
774
|
+
Collection UID to run after the Postman Cloud performance test
|
|
775
|
+
.TP
|
|
770
776
|
.B \-\-vu\-count <count>
|
|
771
777
|
Number of virtual users (default: 20)
|
|
772
778
|
.TP
|
|
@@ -805,6 +811,7 @@ Example: less_than(p95, 500) or less_than(error_rate, 5)
|
|
|
805
811
|
Examples:
|
|
806
812
|
postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-vu\-count 50 \-\-duration 15
|
|
807
813
|
postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-pass\-if "less_than(p95, 500)"
|
|
814
|
+
postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-runner postman\-cloud \-\-setup\-collection 123456\-11111111\-1111\-4111\-8111\-111111111111 \-\-teardown\-collection 123456\-22222222\-2222\-4222\-8222\-222222222222
|
|
808
815
|
|
|
809
816
|
|
|
810
817
|
.SS "flows"
|
|
@@ -1849,7 +1856,7 @@ Examples:
|
|
|
1849
1856
|
|
|
1850
1857
|
|
|
1851
1858
|
.SS "mock"
|
|
1852
|
-
Run and manage
|
|
1859
|
+
Run and manage Postman mocks, locally and in the cloud.
|
|
1853
1860
|
|
|
1854
1861
|
.B Usage:
|
|
1855
1862
|
[options] [command]
|
|
@@ -1857,22 +1864,28 @@ Run and manage local Postman mock servers.
|
|
|
1857
1864
|
.B Subcommands:
|
|
1858
1865
|
.TP
|
|
1859
1866
|
.B mock generate
|
|
1860
|
-
Generate a
|
|
1867
|
+
Generate a 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. Writes a local mock by default, or a cloud mock with \-\-workspace.
|
|
1861
1868
|
.TP
|
|
1862
1869
|
.B mock run
|
|
1863
|
-
Start a local mock server
|
|
1870
|
+
Start a local mock server from a cloud mock id (fetched and run locally), a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
|
|
1871
|
+
.TP
|
|
1872
|
+
.B mock deploy
|
|
1873
|
+
Deploy a cloud mock into a mock server.
|
|
1864
1874
|
.TP
|
|
1865
1875
|
.B mock get
|
|
1866
|
-
Show a
|
|
1876
|
+
Show a mock's details: a cloud mock by id, or a local mock by path.
|
|
1867
1877
|
.TP
|
|
1868
1878
|
.B mock list
|
|
1869
|
-
List local mocks
|
|
1879
|
+
List a workspace's cloud mocks, or (with a path) local mocks under a directory.
|
|
1880
|
+
.TP
|
|
1881
|
+
.B mock log
|
|
1882
|
+
Browse a deployed mock server's request/response logs by its id (see `mock get`).
|
|
1870
1883
|
.TP
|
|
1871
1884
|
.B mock delete
|
|
1872
|
-
Permanently remove a local mock artifact.
|
|
1885
|
+
Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.
|
|
1873
1886
|
|
|
1874
1887
|
.SS "mock generate"
|
|
1875
|
-
Generate a
|
|
1888
|
+
Generate a 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. Writes a local mock by default, or a cloud mock with \-\-workspace.
|
|
1876
1889
|
|
|
1877
1890
|
.B Usage:
|
|
1878
1891
|
[sourcePath] [options]
|
|
@@ -1894,6 +1907,12 @@ Overwrite the config.yaml/default.js in the output directory if it already exist
|
|
|
1894
1907
|
.B \-u, \-\-update <mockPath>
|
|
1895
1908
|
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.
|
|
1896
1909
|
.TP
|
|
1910
|
+
.B \-w, \-\-workspace <id>
|
|
1911
|
+
Create a cloud mock in this Postman workspace instead of a local mock. Cannot be combined with \-\-output/\-\-force/\-\-update.
|
|
1912
|
+
.TP
|
|
1913
|
+
.B \-\-api\-key <key>
|
|
1914
|
+
Postman API key for \-\-workspace (defaults to the `postman login` session)
|
|
1915
|
+
.TP
|
|
1897
1916
|
.B \-x, \-\-suppress\-exit\-code
|
|
1898
1917
|
Always exit with code 0, even on failure
|
|
1899
1918
|
|
|
@@ -1904,13 +1923,14 @@ Eg. postman mock generate ./my\-collection.json
|
|
|
1904
1923
|
postman mock generate \-\-name "My Mock" \-\-port 4010 # sample mock, custom port
|
|
1905
1924
|
postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
|
|
1906
1925
|
postman mock generate ./my\-collection.json \-\-update ./postman/mocks/orders
|
|
1926
|
+
postman mock generate ./my\-collection.json \-w 12345678\-90ab\-cdef\-1234\-567890abcdef # cloud mock
|
|
1907
1927
|
|
|
1908
1928
|
|
|
1909
1929
|
.SS "mock run"
|
|
1910
|
-
Start a local mock server
|
|
1930
|
+
Start a local mock server from a cloud mock id (fetched and run locally), a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
|
|
1911
1931
|
|
|
1912
1932
|
.B Usage:
|
|
1913
|
-
<
|
|
1933
|
+
<mockIdOrPath>
|
|
1914
1934
|
|
|
1915
1935
|
.B Options:
|
|
1916
1936
|
.TP
|
|
@@ -1922,9 +1942,13 @@ Path to a globals file (JSON or YAML) for pm.globals
|
|
|
1922
1942
|
.TP
|
|
1923
1943
|
.B \-p, \-\-port <port>
|
|
1924
1944
|
Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
|
|
1945
|
+
.TP
|
|
1946
|
+
.B \-\-api\-key <key>
|
|
1947
|
+
Postman API key for cloud mock ids (defaults to the `postman login` session)
|
|
1925
1948
|
|
|
1926
1949
|
.TP Examples:
|
|
1927
|
-
Eg. postman mock run
|
|
1950
|
+
Eg. postman mock run 12345678\-90ab\-cdef\-1234\-567890abcdef # cloud mock by id
|
|
1951
|
+
postman mock run ./postman/mocks/orders # a mock directory
|
|
1928
1952
|
postman mock run ./postman/mock\-manifest.json
|
|
1929
1953
|
postman mock run ./postman/mock\-manifest.yaml
|
|
1930
1954
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
@@ -1932,55 +1956,148 @@ Eg. postman mock run ./postman/mocks/orders # a mock directory
|
|
|
1932
1956
|
postman mock run ./manifest.yaml \-\-port 4600 # exact port, errors if busy
|
|
1933
1957
|
|
|
1934
1958
|
|
|
1959
|
+
.SS "mock deploy"
|
|
1960
|
+
Deploy a cloud mock into a mock server.
|
|
1961
|
+
|
|
1962
|
+
.B Usage:
|
|
1963
|
+
<mockId> [options]
|
|
1964
|
+
|
|
1965
|
+
.B Options:
|
|
1966
|
+
.TP
|
|
1967
|
+
.B \-w, \-\-workspace <id>
|
|
1968
|
+
Workspace that will own the mock server (defaults to the workspace linked in .postman/resources.yaml)
|
|
1969
|
+
.TP
|
|
1970
|
+
.B \-n, \-\-name <name>
|
|
1971
|
+
Display name for the mock server (prompts when omitted)
|
|
1972
|
+
.TP
|
|
1973
|
+
.B \-s, \-\-slug <slug>
|
|
1974
|
+
Slug for the deploy URL (prompts when omitted)
|
|
1975
|
+
.TP
|
|
1976
|
+
.B \-\-public
|
|
1977
|
+
Deploy as a public mock (default is private; requires an x\-api\-key header)
|
|
1978
|
+
.TP
|
|
1979
|
+
.B \-\-auto\-deploy
|
|
1980
|
+
Re\-deploy the mock automatically whenever it changes (default off)
|
|
1981
|
+
.TP
|
|
1982
|
+
.B \-y, \-\-yes
|
|
1983
|
+
Accept defaults and skip all prompts (private, no auto\-deploy)
|
|
1984
|
+
.TP
|
|
1985
|
+
.B \-\-api\-key <key>
|
|
1986
|
+
Postman API key (defaults to the `postman login` session)
|
|
1987
|
+
|
|
1988
|
+
.TP Examples:
|
|
1989
|
+
|
|
1990
|
+
Eg. postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef # interactive prompts
|
|
1991
|
+
postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-slug my\-mock \-\-public
|
|
1992
|
+
postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef \-n "My Mock" \-s my\-mock \-\-auto\-deploy
|
|
1993
|
+
postman mock deploy 12345678\-90ab\-cdef\-1234\-567890abcdef \-s my\-mock \-y # non\-interactive
|
|
1994
|
+
|
|
1995
|
+
|
|
1935
1996
|
.SS "mock get"
|
|
1936
|
-
Show a
|
|
1997
|
+
Show a mock's details: a cloud mock by id, or a local mock by path.
|
|
1937
1998
|
|
|
1938
1999
|
.B Usage:
|
|
1939
|
-
<
|
|
2000
|
+
<mockIdOrPath> [options]
|
|
1940
2001
|
|
|
1941
2002
|
.B Options:
|
|
1942
2003
|
.TP
|
|
2004
|
+
.B \-\-api\-key <key>
|
|
2005
|
+
Postman API key (defaults to the `postman login` session)
|
|
2006
|
+
.TP
|
|
1943
2007
|
.B \-\-json
|
|
1944
2008
|
Output the mock details as JSON instead of a table
|
|
1945
2009
|
|
|
1946
2010
|
.TP Examples:
|
|
1947
2011
|
|
|
1948
|
-
Eg. postman mock get
|
|
2012
|
+
Eg. postman mock get 12345678\-90ab\-cdef\-1234\-567890abcdef # cloud mock by id
|
|
2013
|
+
postman mock get ./postman/mocks/orders # local mock by path
|
|
1949
2014
|
postman mock get ./postman/mocks/orders \-\-json
|
|
1950
2015
|
|
|
1951
2016
|
|
|
1952
2017
|
.SS "mock list"
|
|
1953
|
-
List local mocks
|
|
2018
|
+
List a workspace's cloud mocks, or (with a path) local mocks under a directory.
|
|
1954
2019
|
|
|
1955
2020
|
.B Usage:
|
|
1956
2021
|
[pathOrDir] [options]
|
|
1957
2022
|
|
|
1958
2023
|
.B Options:
|
|
1959
2024
|
.TP
|
|
2025
|
+
.B \-w, \-\-workspace <id>
|
|
2026
|
+
Workspace whose cloud mocks to list (defaults to the workspace linked in .postman/resources.yaml)
|
|
2027
|
+
.TP
|
|
2028
|
+
.B \-\-api\-key <key>
|
|
2029
|
+
Postman API key (defaults to the `postman login` session)
|
|
2030
|
+
.TP
|
|
1960
2031
|
.B \-\-json
|
|
1961
2032
|
Output the mock list as JSON instead of a table
|
|
1962
2033
|
|
|
1963
2034
|
.TP Examples:
|
|
1964
2035
|
|
|
1965
|
-
Eg. postman mock list
|
|
1966
|
-
postman mock list
|
|
2036
|
+
Eg. postman mock list # linked workspace (cloud)
|
|
2037
|
+
postman mock list \-w 12345678\-90ab\-cdef\-1234\-567890abcdef # explicit workspace (cloud)
|
|
2038
|
+
postman mock list ./postman/mocks # local mocks under a dir
|
|
1967
2039
|
postman mock list ./postman/mocks \-\-json
|
|
1968
2040
|
|
|
1969
2041
|
|
|
2042
|
+
.SS "mock log"
|
|
2043
|
+
Browse a deployed mock server's request/response logs by its id (see `mock get`).
|
|
2044
|
+
|
|
2045
|
+
.B Usage:
|
|
2046
|
+
<mockServerId> [options]
|
|
2047
|
+
|
|
2048
|
+
.B Options:
|
|
2049
|
+
.TP
|
|
2050
|
+
.B \-\-limit <n>
|
|
2051
|
+
Maximum number of log entries to show (default 50 for \-\-json/non\-interactive output)
|
|
2052
|
+
.TP
|
|
2053
|
+
.B \-\-method <method>
|
|
2054
|
+
Filter by HTTP method (e.g. GET, POST)
|
|
2055
|
+
.TP
|
|
2056
|
+
.B \-\-status <code|range>
|
|
2057
|
+
Filter by response status (e.g. 404 or 5xx)
|
|
2058
|
+
.TP
|
|
2059
|
+
.B \-\-path <pattern>
|
|
2060
|
+
Filter by request path (supports * and ? wildcards)
|
|
2061
|
+
.TP
|
|
2062
|
+
.B \-\-since <duration>
|
|
2063
|
+
Show logs from this long ago onward (e.g. 2h = the last 2 hours)
|
|
2064
|
+
.TP
|
|
2065
|
+
.B \-\-until <duration>
|
|
2066
|
+
Stop this long ago (e.g. 30m = exclude the most recent 30 minutes)
|
|
2067
|
+
.TP
|
|
2068
|
+
.B \-\-api\-key <key>
|
|
2069
|
+
Postman API key (defaults to the `postman login` session)
|
|
2070
|
+
.TP
|
|
2071
|
+
.B \-\-json
|
|
2072
|
+
Output logs as JSON instead of the interactive pager
|
|
2073
|
+
|
|
2074
|
+
.TP Examples:
|
|
2075
|
+
|
|
2076
|
+
Eg. postman mock log 12345678\-90ab\-cdef\-1234\-567890abcdef # interactive pager
|
|
2077
|
+
postman mock log 12345678\-90ab\-cdef\-1234\-567890abcdef \-\-json # outputs in JSON
|
|
2078
|
+
postman mock log <mockServerId> \-\-method GET \-\-path '/users/*'
|
|
2079
|
+
postman mock log <mockServerId> \-\-status 5xx \-\-limit 50
|
|
2080
|
+
postman mock log <mockServerId> \-\-since 7h \-\-until 2h # between 7h and 2h ago
|
|
2081
|
+
|
|
2082
|
+
|
|
1970
2083
|
.SS "mock delete"
|
|
1971
|
-
Permanently remove a local mock artifact.
|
|
2084
|
+
Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.
|
|
1972
2085
|
|
|
1973
2086
|
.B Usage:
|
|
1974
|
-
<
|
|
2087
|
+
<mockIdOrPath> [options]
|
|
1975
2088
|
|
|
1976
2089
|
.B Options:
|
|
1977
2090
|
.TP
|
|
1978
2091
|
.B \-y, \-\-yes
|
|
1979
2092
|
Skip the confirmation prompt
|
|
2093
|
+
.TP
|
|
2094
|
+
.B \-\-api\-key <key>
|
|
2095
|
+
Postman API key for cloud mock ids (defaults to the `postman login` session)
|
|
1980
2096
|
|
|
1981
2097
|
.TP Examples:
|
|
1982
2098
|
|
|
1983
|
-
Eg. postman mock delete
|
|
2099
|
+
Eg. postman mock delete 12345678\-90ab\-cdef\-1234\-567890abcdef # cloud mock by id
|
|
2100
|
+
postman mock delete ./postman/mocks/orders # local mock by path
|
|
1984
2101
|
postman mock delete ./postman/mocks/orders \-\-yes
|
|
1985
2102
|
postman mock delete ./postman/mocks/orders/config.yaml \-\-yes
|
|
1986
2103
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.53.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.53.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.53.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.53.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.53.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.53.0"
|
|
66
66
|
}
|
|
67
67
|
}
|