postman-cli 1.65.0 → 1.66.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 +73 -2
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-09-
|
|
1
|
+
.TH POSTMAN 1 "2026-09-28" "v1.66.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -860,7 +860,7 @@ Specify a data file to use for iterations (either JSON or CSV)
|
|
|
860
860
|
[BETA] Name or id of the view to execute (within \-\-iteration\-data\-dataset). The view's result set drives one iteration per row.
|
|
861
861
|
.TP
|
|
862
862
|
.B \-\-dataset <pathOrDir>
|
|
863
|
-
[BETA] Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to scripts as pm.datasets(<id>). When provided, auto\-discovery of .dataset.yaml files from the collection's parent repo is disabled. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged\-in cloud session. (default: )
|
|
863
|
+
[BETA] Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to collection scripts and local mock handlers as pm.datasets(<id>). When provided, auto\-discovery of .dataset.yaml files from the collection's parent repo is disabled. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged\-in cloud session. (default: )
|
|
864
864
|
.TP
|
|
865
865
|
.B \-i <id>
|
|
866
866
|
Specify the request/folder id, name, or path to run from the collection. Use a path (e.g. "FolderName/RequestName") to disambiguate items with the same name. Can be specified multiple times to run multiple items (default: )
|
|
@@ -1446,6 +1446,9 @@ Generate artifacts from a specification.
|
|
|
1446
1446
|
.TP
|
|
1447
1447
|
.B spec sync
|
|
1448
1448
|
Sync a generated collection with its source specification.
|
|
1449
|
+
.TP
|
|
1450
|
+
.B spec delete
|
|
1451
|
+
Delete a spec by its cloud ID or local file path. Cannot be undone.
|
|
1449
1452
|
|
|
1450
1453
|
.SS "spec lint"
|
|
1451
1454
|
Run linting on the given specification by ID or local file path.
|
|
@@ -1708,12 +1711,16 @@ Workspace ID (cloud mode)
|
|
|
1708
1711
|
.TP
|
|
1709
1712
|
.B \-\-api\-key <key>
|
|
1710
1713
|
Postman API key
|
|
1714
|
+
.TP
|
|
1715
|
+
.B \-\-force
|
|
1716
|
+
Overwrite the collection if one with this name already exists (local mode)
|
|
1711
1717
|
|
|
1712
1718
|
.TP Examples:
|
|
1713
1719
|
|
|
1714
1720
|
Examples:
|
|
1715
1721
|
postman spec generate collection ./openapi.yaml \-n "My API"
|
|
1716
1722
|
postman spec generate collection ./openapi.yaml \-n "My API" \-\-folder\-strategy Tags
|
|
1723
|
+
postman spec generate collection ./openapi.yaml \-n "My API" \-\-force
|
|
1717
1724
|
postman spec generate collection 12345678\-abcd\-1234\-abcd\-1234567890ab \-n "My API"
|
|
1718
1725
|
|
|
1719
1726
|
|
|
@@ -1751,6 +1758,29 @@ Examples:
|
|
|
1751
1758
|
|
|
1752
1759
|
|
|
1753
1760
|
|
|
1761
|
+
.SS "spec delete"
|
|
1762
|
+
Delete a spec by its cloud ID or local file path. Cannot be undone.
|
|
1763
|
+
|
|
1764
|
+
.B Usage:
|
|
1765
|
+
<spec> [options]
|
|
1766
|
+
|
|
1767
|
+
.B Options:
|
|
1768
|
+
.TP
|
|
1769
|
+
.B \-y, \-\-yes
|
|
1770
|
+
Delete without asking for confirmation first
|
|
1771
|
+
.TP
|
|
1772
|
+
.B \-\-api\-key <key>
|
|
1773
|
+
Postman API key, used with a cloud ID (defaults to your `postman login` session)
|
|
1774
|
+
|
|
1775
|
+
.TP Examples:
|
|
1776
|
+
|
|
1777
|
+
Examples:
|
|
1778
|
+
postman spec delete 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
1779
|
+
postman spec delete ./postman/specs/pet\-store
|
|
1780
|
+
postman spec delete ./postman/specs/pet\-store/index.yaml \-\-yes
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
|
|
1754
1784
|
.SS "monitor"
|
|
1755
1785
|
Run and manage Postman monitors.
|
|
1756
1786
|
|
|
@@ -2753,6 +2783,9 @@ Example: less_than(p95, 500) or less_than(error_rate, 5)
|
|
|
2753
2783
|
.B \-\-use\-mock <mapping>
|
|
2754
2784
|
Redirect a variable/host to a local code mock or cloud Mock Server (repeatable).
|
|
2755
2785
|
Format: "<{{var}}|host> mock|mock\-server:<path|id> [scenario]" (default: )
|
|
2786
|
+
.TP
|
|
2787
|
+
.B \-\-dataset <pathOrDir>
|
|
2788
|
+
Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to the handlers of the local mocks started by \-\-use\-mock as pm.datasets(<id>). Local runner only. (default: )
|
|
2756
2789
|
|
|
2757
2790
|
.TP Examples:
|
|
2758
2791
|
|
|
@@ -2762,6 +2795,7 @@ Examples:
|
|
|
2762
2795
|
postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-runner local \-\-setup\-collection 123456\-11111111\-1111\-4111\-8111\-111111111111 \-\-teardown\-collection 123456\-22222222\-2222\-4222\-8222\-222222222222
|
|
2763
2796
|
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
|
|
2764
2797
|
postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-runner postman\-cloud\-static\-ip
|
|
2798
|
+
postman performance run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab \-\-use\-mock "{{baseUrl}} mock:./postman/mocks/orders" \-\-dataset ./postman/datasets/Orders
|
|
2765
2799
|
|
|
2766
2800
|
|
|
2767
2801
|
.SS "performance list"
|
|
@@ -3940,6 +3974,9 @@ Workspace that owns the run, for recording its start history. Auto\-resolved for
|
|
|
3940
3974
|
.TP
|
|
3941
3975
|
.B \-\-no\-history
|
|
3942
3976
|
Do not record this run in the mock's start history.
|
|
3977
|
+
.TP
|
|
3978
|
+
.B \-\-dataset <pathOrDir>
|
|
3979
|
+
Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to the mock's handlers as pm.datasets(<id>). (default: )
|
|
3943
3980
|
|
|
3944
3981
|
.TP Examples:
|
|
3945
3982
|
|
|
@@ -3949,6 +3986,7 @@ Eg. postman mock run 12345678\-90ab\-cdef\-1234\-567890abcdef # by id, from Pos
|
|
|
3949
3986
|
postman mock run ./postman/mocks/orders \-\-port auto # pick any free port
|
|
3950
3987
|
postman mock run ./postman/mocks/orders \-\-port 4600 # use port 4600 (fails if it is in use)
|
|
3951
3988
|
postman mock run ./postman/mocks/orders \-\-workspace <id> # record start history for a path run
|
|
3989
|
+
postman mock run ./postman/mocks/orders \-\-dataset ./postman/datasets/Orders
|
|
3952
3990
|
|
|
3953
3991
|
Eligible runs are recorded in the mock's start history (source: cli) so they appear under
|
|
3954
3992
|
"Previous starts" in Postman. Cloud ids record automatically; a manifest\-backed path run needs
|
|
@@ -6441,6 +6479,9 @@ Materialise the dependencies declared in .postman/resources.yaml (all, or one).
|
|
|
6441
6479
|
.TP
|
|
6442
6480
|
.B dependency update
|
|
6443
6481
|
Refresh declared dependencies to the latest content from their source (all, or one).
|
|
6482
|
+
.TP
|
|
6483
|
+
.B dependency remove
|
|
6484
|
+
Remove a workspace dependency and delete its local files.
|
|
6444
6485
|
|
|
6445
6486
|
.SS "dependency add"
|
|
6446
6487
|
Add a Postman collection, environment, or mock as a workspace dependency.
|
|
@@ -6545,6 +6586,36 @@ Examples:
|
|
|
6545
6586
|
|
|
6546
6587
|
|
|
6547
6588
|
|
|
6589
|
+
.SS "dependency remove"
|
|
6590
|
+
Remove a workspace dependency and delete its local files.
|
|
6591
|
+
|
|
6592
|
+
.B Usage:
|
|
6593
|
+
[options] <nameOrId>
|
|
6594
|
+
|
|
6595
|
+
.B Options:
|
|
6596
|
+
.TP
|
|
6597
|
+
.B \-\-type <type>
|
|
6598
|
+
Only match dependencies of this type (collection, environment, or mock).
|
|
6599
|
+
.TP
|
|
6600
|
+
.B \-y, \-\-yes
|
|
6601
|
+
Skip the confirmation prompt (required outside an interactive terminal).
|
|
6602
|
+
.TP
|
|
6603
|
+
.B \-\-json
|
|
6604
|
+
Output the result as JSON.
|
|
6605
|
+
|
|
6606
|
+
.TP Examples:
|
|
6607
|
+
|
|
6608
|
+
A <nameOrId> is the cloud id, display name, or on\-disk name of a declared dependency
|
|
6609
|
+
(as shown by `postman dependency list`). Removing a collection also removes the
|
|
6610
|
+
environments pinned to it, unless another collection pins them too.
|
|
6611
|
+
|
|
6612
|
+
Examples:
|
|
6613
|
+
postman dependency remove "My Collection"
|
|
6614
|
+
postman dependency remove 844951\-51ea04bb\-8d1a\-439e\-aa70\-fe91852efcda \-\-yes
|
|
6615
|
+
postman dependency remove Prod \-\-type environment \-\-yes \-\-json
|
|
6616
|
+
|
|
6617
|
+
|
|
6618
|
+
|
|
6548
6619
|
.SH SEE ALSO
|
|
6549
6620
|
Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
|
|
6550
6621
|
.SH AUTHOR
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.66.0",
|
|
4
4
|
"description": "Official Postman CLI - Command-line companion for API development, testing, and automation",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"postman",
|
|
@@ -62,10 +62,10 @@
|
|
|
62
62
|
"scripts/"
|
|
63
63
|
],
|
|
64
64
|
"optionalDependencies": {
|
|
65
|
-
"@postman/pm-bin-macos-arm64": "1.
|
|
66
|
-
"@postman/pm-bin-macos-x64": "1.
|
|
67
|
-
"@postman/pm-bin-linux-x64": "1.
|
|
68
|
-
"@postman/pm-bin-linux-arm64": "1.
|
|
69
|
-
"@postman/pm-bin-windows-x64": "1.
|
|
65
|
+
"@postman/pm-bin-macos-arm64": "1.66.0",
|
|
66
|
+
"@postman/pm-bin-macos-x64": "1.66.0",
|
|
67
|
+
"@postman/pm-bin-linux-x64": "1.66.0",
|
|
68
|
+
"@postman/pm-bin-linux-arm64": "1.66.0",
|
|
69
|
+
"@postman/pm-bin-windows-x64": "1.66.0"
|
|
70
70
|
}
|
|
71
71
|
}
|