postman-cli 1.51.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 +210 -60
- 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
|
|
@@ -269,14 +269,22 @@ Start a mock server from manifest (.json, .yaml or .yml) file
|
|
|
269
269
|
.B \-\-port <port>
|
|
270
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
271
|
.TP
|
|
272
|
+
.B \-\-use\-mock <mapping>
|
|
273
|
+
Redirect requests for a URL or {{variable}} to a mock during the run. Format: "<url> mock|mock\-server:<path|id> [scenario]". Repeat the flag to redirect multiple URLs (one \-\-use\-mock per mock). Use "mock:<path>" for a local mock manifest (.json/.yaml/.yml), "mock:<id>" for a local mock by id (fetched from the cloud then run locally), or "mock\-server:<id>" to redirect to a deployed mock server's URL. Id\-based references require `postman login` (or \-\-postman\-api\-key). The optional third field selects a scenario (defaults to "default"). (default: )
|
|
274
|
+
.TP
|
|
272
275
|
.B \-\-simulate <path>
|
|
273
276
|
Start mock servers with fault\-injection scenarios from a .sim.yaml file
|
|
274
277
|
.TP
|
|
275
278
|
.B \-\-report\-events
|
|
276
|
-
|
|
279
|
+
Upload results for git\-native v3 collection runs. Analytics are sent by default
|
|
280
|
+
.TP
|
|
281
|
+
.B \-\-no\-report\-events
|
|
282
|
+
Do not send analytics to Postman
|
|
277
283
|
|
|
278
284
|
.TP Examples:
|
|
279
285
|
Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
|
|
286
|
+
postman collection run <id> \-\-use\-mock "{{baseurl}} mock:./mock/config.yaml delay"
|
|
287
|
+
postman collection run <id> \-\-use\-mock "{{baseurl}} mock:./a.yaml" \-\-use\-mock "api.com mock\-server:9d8e7f6a"
|
|
280
288
|
|
|
281
289
|
|
|
282
290
|
.SS "environment"
|
|
@@ -469,7 +477,10 @@ Enable the metrics server for health checks
|
|
|
469
477
|
Port for the metrics server (default: 9090)
|
|
470
478
|
.TP
|
|
471
479
|
.B \-\-report\-events
|
|
472
|
-
|
|
480
|
+
Accepted for compatibility; analytics are sent by default
|
|
481
|
+
.TP
|
|
482
|
+
.B \-\-no\-report\-events
|
|
483
|
+
Do not send analytics to Postman
|
|
473
484
|
|
|
474
485
|
.SS "spec"
|
|
475
486
|
Lint and validate Specifications from the command line
|
|
@@ -506,7 +517,10 @@ Output format for the results. [choices: "json", "csv"]
|
|
|
506
517
|
The workspace ID to use for fetching governance rulesets.
|
|
507
518
|
.TP
|
|
508
519
|
.B \-\-report\-events
|
|
509
|
-
|
|
520
|
+
Accepted for compatibility; analytics are sent by default
|
|
521
|
+
.TP
|
|
522
|
+
.B \-\-no\-report\-events
|
|
523
|
+
Do not send analytics to Postman
|
|
510
524
|
|
|
511
525
|
.SS "spec ai\-readiness"
|
|
512
526
|
Score an OpenAPI specification for AI readiness by ID or local file path.
|
|
@@ -647,7 +661,10 @@ Push strategy. "force\-sync": mirror the whole workspace — also DELETE cloud e
|
|
|
647
661
|
Show detailed logging
|
|
648
662
|
.TP
|
|
649
663
|
.B \-\-report\-events
|
|
650
|
-
|
|
664
|
+
Accepted for compatibility; analytics are sent by default
|
|
665
|
+
.TP
|
|
666
|
+
.B \-\-no\-report\-events
|
|
667
|
+
Do not send analytics to Postman
|
|
651
668
|
|
|
652
669
|
.SS "workspace lint"
|
|
653
670
|
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
@@ -750,6 +767,12 @@ Specify an Id to a Postman Environment
|
|
|
750
767
|
.B \-g, \-\-globals <id>
|
|
751
768
|
Specify an Id to a Postman Globals
|
|
752
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
|
|
753
776
|
.B \-\-vu\-count <count>
|
|
754
777
|
Number of virtual users (default: 20)
|
|
755
778
|
.TP
|
|
@@ -788,6 +811,7 @@ Example: less_than(p95, 500) or less_than(error_rate, 5)
|
|
|
788
811
|
Examples:
|
|
789
812
|
postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-vu\-count 50 \-\-duration 15
|
|
790
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
|
|
791
815
|
|
|
792
816
|
|
|
793
817
|
.SS "flows"
|
|
@@ -1005,6 +1029,12 @@ Specify whether or not to override the default exit code for the current run
|
|
|
1005
1029
|
.B \-\-workspace <workspaceId>
|
|
1006
1030
|
Workspace ID required for flows that contain connector blocks. Find it in the Postman app URL: https://postman.com/workspace/<workspaceId>
|
|
1007
1031
|
.TP
|
|
1032
|
+
.B \-\-report\-events
|
|
1033
|
+
Accepted for compatibility; analytics are sent by default
|
|
1034
|
+
.TP
|
|
1035
|
+
.B \-\-no\-report\-events
|
|
1036
|
+
Do not send analytics to Postman
|
|
1037
|
+
.TP
|
|
1008
1038
|
.B \-\-verbose
|
|
1009
1039
|
Verbose output
|
|
1010
1040
|
.TP
|
|
@@ -1209,6 +1239,12 @@ suppress all output except response body. Useful for piping to other commands.
|
|
|
1209
1239
|
.TP
|
|
1210
1240
|
.B \-\-debug
|
|
1211
1241
|
Debug mode: show detailed execution information including retry attempts, redirects, and timing breakdowns.
|
|
1242
|
+
.TP
|
|
1243
|
+
.B \-\-report\-events
|
|
1244
|
+
Accepted for compatibility; analytics are sent by default
|
|
1245
|
+
.TP
|
|
1246
|
+
.B \-\-no\-report\-events
|
|
1247
|
+
Do not send analytics to Postman
|
|
1212
1248
|
|
|
1213
1249
|
.TP Examples:
|
|
1214
1250
|
|
|
@@ -1820,7 +1856,7 @@ Examples:
|
|
|
1820
1856
|
|
|
1821
1857
|
|
|
1822
1858
|
.SS "mock"
|
|
1823
|
-
Run and manage
|
|
1859
|
+
Run and manage Postman mocks, locally and in the cloud.
|
|
1824
1860
|
|
|
1825
1861
|
.B Usage:
|
|
1826
1862
|
[options] [command]
|
|
@@ -1828,22 +1864,28 @@ Run and manage local Postman mock servers.
|
|
|
1828
1864
|
.B Subcommands:
|
|
1829
1865
|
.TP
|
|
1830
1866
|
.B mock generate
|
|
1831
|
-
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.
|
|
1832
1868
|
.TP
|
|
1833
1869
|
.B mock run
|
|
1834
|
-
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.
|
|
1835
1874
|
.TP
|
|
1836
1875
|
.B mock get
|
|
1837
|
-
Show a
|
|
1876
|
+
Show a mock's details: a cloud mock by id, or a local mock by path.
|
|
1838
1877
|
.TP
|
|
1839
1878
|
.B mock list
|
|
1840
|
-
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`).
|
|
1841
1883
|
.TP
|
|
1842
1884
|
.B mock delete
|
|
1843
|
-
Permanently remove a local mock artifact.
|
|
1885
|
+
Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.
|
|
1844
1886
|
|
|
1845
1887
|
.SS "mock generate"
|
|
1846
|
-
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.
|
|
1847
1889
|
|
|
1848
1890
|
.B Usage:
|
|
1849
1891
|
[sourcePath] [options]
|
|
@@ -1865,6 +1907,12 @@ Overwrite the config.yaml/default.js in the output directory if it already exist
|
|
|
1865
1907
|
.B \-u, \-\-update <mockPath>
|
|
1866
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.
|
|
1867
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
|
|
1868
1916
|
.B \-x, \-\-suppress\-exit\-code
|
|
1869
1917
|
Always exit with code 0, even on failure
|
|
1870
1918
|
|
|
@@ -1875,13 +1923,14 @@ Eg. postman mock generate ./my\-collection.json
|
|
|
1875
1923
|
postman mock generate \-\-name "My Mock" \-\-port 4010 # sample mock, custom port
|
|
1876
1924
|
postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
|
|
1877
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
|
|
1878
1927
|
|
|
1879
1928
|
|
|
1880
1929
|
.SS "mock run"
|
|
1881
|
-
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.
|
|
1882
1931
|
|
|
1883
1932
|
.B Usage:
|
|
1884
|
-
<
|
|
1933
|
+
<mockIdOrPath>
|
|
1885
1934
|
|
|
1886
1935
|
.B Options:
|
|
1887
1936
|
.TP
|
|
@@ -1893,9 +1942,13 @@ Path to a globals file (JSON or YAML) for pm.globals
|
|
|
1893
1942
|
.TP
|
|
1894
1943
|
.B \-p, \-\-port <port>
|
|
1895
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)
|
|
1896
1948
|
|
|
1897
1949
|
.TP Examples:
|
|
1898
|
-
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
|
|
1899
1952
|
postman mock run ./postman/mock\-manifest.json
|
|
1900
1953
|
postman mock run ./postman/mock\-manifest.yaml
|
|
1901
1954
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
@@ -1903,55 +1956,148 @@ Eg. postman mock run ./postman/mocks/orders # a mock directory
|
|
|
1903
1956
|
postman mock run ./manifest.yaml \-\-port 4600 # exact port, errors if busy
|
|
1904
1957
|
|
|
1905
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
|
+
|
|
1906
1996
|
.SS "mock get"
|
|
1907
|
-
Show a
|
|
1997
|
+
Show a mock's details: a cloud mock by id, or a local mock by path.
|
|
1908
1998
|
|
|
1909
1999
|
.B Usage:
|
|
1910
|
-
<
|
|
2000
|
+
<mockIdOrPath> [options]
|
|
1911
2001
|
|
|
1912
2002
|
.B Options:
|
|
1913
2003
|
.TP
|
|
2004
|
+
.B \-\-api\-key <key>
|
|
2005
|
+
Postman API key (defaults to the `postman login` session)
|
|
2006
|
+
.TP
|
|
1914
2007
|
.B \-\-json
|
|
1915
2008
|
Output the mock details as JSON instead of a table
|
|
1916
2009
|
|
|
1917
2010
|
.TP Examples:
|
|
1918
2011
|
|
|
1919
|
-
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
|
|
1920
2014
|
postman mock get ./postman/mocks/orders \-\-json
|
|
1921
2015
|
|
|
1922
2016
|
|
|
1923
2017
|
.SS "mock list"
|
|
1924
|
-
List local mocks
|
|
2018
|
+
List a workspace's cloud mocks, or (with a path) local mocks under a directory.
|
|
1925
2019
|
|
|
1926
2020
|
.B Usage:
|
|
1927
2021
|
[pathOrDir] [options]
|
|
1928
2022
|
|
|
1929
2023
|
.B Options:
|
|
1930
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
|
|
1931
2031
|
.B \-\-json
|
|
1932
2032
|
Output the mock list as JSON instead of a table
|
|
1933
2033
|
|
|
1934
2034
|
.TP Examples:
|
|
1935
2035
|
|
|
1936
|
-
Eg. postman mock list
|
|
1937
|
-
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
|
|
1938
2039
|
postman mock list ./postman/mocks \-\-json
|
|
1939
2040
|
|
|
1940
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
|
+
|
|
1941
2083
|
.SS "mock delete"
|
|
1942
|
-
Permanently remove a local mock artifact.
|
|
2084
|
+
Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.
|
|
1943
2085
|
|
|
1944
2086
|
.B Usage:
|
|
1945
|
-
<
|
|
2087
|
+
<mockIdOrPath> [options]
|
|
1946
2088
|
|
|
1947
2089
|
.B Options:
|
|
1948
2090
|
.TP
|
|
1949
2091
|
.B \-y, \-\-yes
|
|
1950
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)
|
|
1951
2096
|
|
|
1952
2097
|
.TP Examples:
|
|
1953
2098
|
|
|
1954
|
-
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
|
|
1955
2101
|
postman mock delete ./postman/mocks/orders \-\-yes
|
|
1956
2102
|
postman mock delete ./postman/mocks/orders/config.yaml \-\-yes
|
|
1957
2103
|
|
|
@@ -2056,8 +2202,11 @@ Overwrite the output directory if it exists and is not empty (used with \-\-capt
|
|
|
2056
2202
|
.B \-\-save\-events\-local
|
|
2057
2203
|
Write analytics events to pm\-results/test\-events\-debug.ndjson instead of sending to Postman
|
|
2058
2204
|
.TP
|
|
2059
|
-
.B \-\-report\-events
|
|
2060
|
-
Send application test run results
|
|
2205
|
+
.B \-\-report\-events [boolean]
|
|
2206
|
+
Send application test run results to Postman (default: true)
|
|
2207
|
+
.TP
|
|
2208
|
+
.B \-\-no\-report\-events
|
|
2209
|
+
Do not send run results or analytics to Postman
|
|
2061
2210
|
.TP
|
|
2062
2211
|
.B \-\-verbose
|
|
2063
2212
|
Show detailed per\-request matching, sandbox errors, and debug information
|
|
@@ -2073,7 +2222,8 @@ or via \-\-target\-collection/\-\-target\-environment flags. CLI flags override
|
|
|
2073
2222
|
Use \-\-capture\-only to skip tests and export captured traffic
|
|
2074
2223
|
as a V3 Postman collection organised by host.
|
|
2075
2224
|
|
|
2076
|
-
|
|
2225
|
+
Run results are sent to Postman automatically after analysis.
|
|
2226
|
+
Use \-\-report\-events=false (or \-\-report\-events false) to skip uploading run results.
|
|
2077
2227
|
|
|
2078
2228
|
Examples:
|
|
2079
2229
|
postman application test \-\-command "npx playwright test"
|
|
@@ -3175,7 +3325,7 @@ Examples:
|
|
|
3175
3325
|
|
|
3176
3326
|
|
|
3177
3327
|
.SS "dataset"
|
|
3178
|
-
|
|
3328
|
+
Work with Postman datasets in local YAML files or the cloud.
|
|
3179
3329
|
|
|
3180
3330
|
.B Usage:
|
|
3181
3331
|
[options] [command]
|
|
@@ -3192,28 +3342,28 @@ Targeting:
|
|
|
3192
3342
|
.B Subcommands:
|
|
3193
3343
|
.TP
|
|
3194
3344
|
.B dataset list
|
|
3195
|
-
|
|
3345
|
+
List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
3196
3346
|
.TP
|
|
3197
3347
|
.B dataset get
|
|
3198
|
-
|
|
3348
|
+
Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
3199
3349
|
.TP
|
|
3200
3350
|
.B dataset query
|
|
3201
|
-
|
|
3351
|
+
Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
3202
3352
|
.TP
|
|
3203
3353
|
.B dataset create
|
|
3204
|
-
|
|
3354
|
+
Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
3205
3355
|
.TP
|
|
3206
3356
|
.B dataset delete
|
|
3207
|
-
|
|
3357
|
+
Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
|
|
3208
3358
|
.TP
|
|
3209
3359
|
.B dataset source
|
|
3210
|
-
|
|
3360
|
+
Inspect and manage a dataset's datasources.
|
|
3211
3361
|
.TP
|
|
3212
3362
|
.B dataset view
|
|
3213
|
-
|
|
3363
|
+
Inspect and manage saved views on a dataset.
|
|
3214
3364
|
|
|
3215
3365
|
.SS "dataset list"
|
|
3216
|
-
|
|
3366
|
+
List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
3217
3367
|
|
|
3218
3368
|
.B Usage:
|
|
3219
3369
|
[options] [pathOrDir]
|
|
@@ -3239,7 +3389,7 @@ Examples:
|
|
|
3239
3389
|
|
|
3240
3390
|
|
|
3241
3391
|
.SS "dataset get"
|
|
3242
|
-
|
|
3392
|
+
Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
3243
3393
|
|
|
3244
3394
|
.B Usage:
|
|
3245
3395
|
[options] <datasetPathOrId>
|
|
@@ -3264,7 +3414,7 @@ Examples:
|
|
|
3264
3414
|
|
|
3265
3415
|
|
|
3266
3416
|
.SS "dataset query"
|
|
3267
|
-
|
|
3417
|
+
Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
3268
3418
|
|
|
3269
3419
|
.B Usage:
|
|
3270
3420
|
[options] <datasetPathOrId>
|
|
@@ -3297,7 +3447,7 @@ Examples:
|
|
|
3297
3447
|
|
|
3298
3448
|
|
|
3299
3449
|
.SS "dataset create"
|
|
3300
|
-
|
|
3450
|
+
Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
3301
3451
|
|
|
3302
3452
|
.B Usage:
|
|
3303
3453
|
[options] [path]
|
|
@@ -3331,7 +3481,7 @@ Examples:
|
|
|
3331
3481
|
|
|
3332
3482
|
|
|
3333
3483
|
.SS "dataset delete"
|
|
3334
|
-
|
|
3484
|
+
Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
|
|
3335
3485
|
|
|
3336
3486
|
.B Usage:
|
|
3337
3487
|
[options] <datasetPathOrId>
|
|
@@ -3361,7 +3511,7 @@ Local resource cleanup:
|
|
|
3361
3511
|
|
|
3362
3512
|
|
|
3363
3513
|
.SS "dataset source"
|
|
3364
|
-
|
|
3514
|
+
Inspect and manage a dataset's datasources.
|
|
3365
3515
|
|
|
3366
3516
|
.B Usage:
|
|
3367
3517
|
[options] [command]
|
|
@@ -3369,19 +3519,19 @@ Local resource cleanup:
|
|
|
3369
3519
|
.B Subcommands:
|
|
3370
3520
|
.TP
|
|
3371
3521
|
.B dataset source list
|
|
3372
|
-
|
|
3522
|
+
List the datasources defined on a dataset (local YAML path or cloud id).
|
|
3373
3523
|
.TP
|
|
3374
3524
|
.B dataset source add
|
|
3375
|
-
|
|
3525
|
+
Add a datasource to a dataset.
|
|
3376
3526
|
.TP
|
|
3377
3527
|
.B dataset source remove
|
|
3378
|
-
|
|
3528
|
+
Remove a datasource from a dataset (local YAML path or cloud id).
|
|
3379
3529
|
.TP
|
|
3380
3530
|
.B dataset source update
|
|
3381
|
-
|
|
3531
|
+
Update fields on an existing datasource. Only the flags you provide are changed.
|
|
3382
3532
|
|
|
3383
3533
|
.SS "dataset source list"
|
|
3384
|
-
|
|
3534
|
+
List the datasources defined on a dataset (local YAML path or cloud id).
|
|
3385
3535
|
|
|
3386
3536
|
.B Usage:
|
|
3387
3537
|
[options]
|
|
@@ -3406,7 +3556,7 @@ Examples:
|
|
|
3406
3556
|
|
|
3407
3557
|
|
|
3408
3558
|
.SS "dataset source add"
|
|
3409
|
-
|
|
3559
|
+
Add a datasource to a dataset.
|
|
3410
3560
|
|
|
3411
3561
|
.B Usage:
|
|
3412
3562
|
[options] [datasetPathOrId]
|
|
@@ -3520,7 +3670,7 @@ Execution:
|
|
|
3520
3670
|
|
|
3521
3671
|
|
|
3522
3672
|
.SS "dataset source remove"
|
|
3523
|
-
|
|
3673
|
+
Remove a datasource from a dataset (local YAML path or cloud id).
|
|
3524
3674
|
|
|
3525
3675
|
.B Usage:
|
|
3526
3676
|
[options] <sourceNameOrId>
|
|
@@ -3543,7 +3693,7 @@ Examples:
|
|
|
3543
3693
|
|
|
3544
3694
|
|
|
3545
3695
|
.SS "dataset source update"
|
|
3546
|
-
|
|
3696
|
+
Update fields on an existing datasource. Only the flags you provide are changed.
|
|
3547
3697
|
|
|
3548
3698
|
.B Usage:
|
|
3549
3699
|
[options] <sourceNameOrId>
|
|
@@ -3642,7 +3792,7 @@ Examples:
|
|
|
3642
3792
|
|
|
3643
3793
|
|
|
3644
3794
|
.SS "dataset view"
|
|
3645
|
-
|
|
3795
|
+
Inspect and manage saved views on a dataset.
|
|
3646
3796
|
|
|
3647
3797
|
.B Usage:
|
|
3648
3798
|
[options] [command]
|
|
@@ -3650,22 +3800,22 @@ Examples:
|
|
|
3650
3800
|
.B Subcommands:
|
|
3651
3801
|
.TP
|
|
3652
3802
|
.B dataset view list
|
|
3653
|
-
|
|
3803
|
+
List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3654
3804
|
.TP
|
|
3655
3805
|
.B dataset view run
|
|
3656
|
-
|
|
3806
|
+
Execute a saved view against a dataset and print the rows.
|
|
3657
3807
|
.TP
|
|
3658
3808
|
.B dataset view create
|
|
3659
|
-
|
|
3809
|
+
Add a saved view to a dataset (local YAML path or cloud id).
|
|
3660
3810
|
.TP
|
|
3661
3811
|
.B dataset view delete
|
|
3662
|
-
|
|
3812
|
+
Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3663
3813
|
.TP
|
|
3664
3814
|
.B dataset view update
|
|
3665
|
-
|
|
3815
|
+
Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3666
3816
|
|
|
3667
3817
|
.SS "dataset view list"
|
|
3668
|
-
|
|
3818
|
+
List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3669
3819
|
|
|
3670
3820
|
.B Usage:
|
|
3671
3821
|
[options]
|
|
@@ -3690,7 +3840,7 @@ Examples:
|
|
|
3690
3840
|
|
|
3691
3841
|
|
|
3692
3842
|
.SS "dataset view run"
|
|
3693
|
-
|
|
3843
|
+
Execute a saved view against a dataset and print the rows.
|
|
3694
3844
|
|
|
3695
3845
|
.B Usage:
|
|
3696
3846
|
[options] <viewNameOrId>
|
|
@@ -3724,7 +3874,7 @@ Examples:
|
|
|
3724
3874
|
|
|
3725
3875
|
|
|
3726
3876
|
.SS "dataset view create"
|
|
3727
|
-
|
|
3877
|
+
Add a saved view to a dataset (local YAML path or cloud id).
|
|
3728
3878
|
|
|
3729
3879
|
.B Usage:
|
|
3730
3880
|
[options]
|
|
@@ -3757,7 +3907,7 @@ Examples:
|
|
|
3757
3907
|
|
|
3758
3908
|
|
|
3759
3909
|
.SS "dataset view delete"
|
|
3760
|
-
|
|
3910
|
+
Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3761
3911
|
|
|
3762
3912
|
.B Usage:
|
|
3763
3913
|
[options] <viewNameOrId>
|
|
@@ -3779,7 +3929,7 @@ Examples:
|
|
|
3779
3929
|
|
|
3780
3930
|
|
|
3781
3931
|
.SS "dataset view update"
|
|
3782
|
-
|
|
3932
|
+
Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3783
3933
|
|
|
3784
3934
|
.B Usage:
|
|
3785
3935
|
[options] <viewNameOrId>
|
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
|
}
|