postman-cli 1.67.0 → 1.68.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 +109 -4
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-
|
|
1
|
+
.TH POSTMAN 1 "2026-10-01" "v1.68.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -305,6 +305,9 @@ Add, update, or remove requests in a local v3 collection.
|
|
|
305
305
|
.B collection folder
|
|
306
306
|
Add, update, or remove folders in a local v3 collection.
|
|
307
307
|
.TP
|
|
308
|
+
.B collection import
|
|
309
|
+
Import a cURL or HAR source into a v3 collection (local, or cloud with \-\-workspace).
|
|
310
|
+
.TP
|
|
308
311
|
.B collection list
|
|
309
312
|
List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
|
|
310
313
|
.TP
|
|
@@ -787,6 +790,50 @@ Examples:
|
|
|
787
790
|
|
|
788
791
|
|
|
789
792
|
|
|
793
|
+
.SS "collection import"
|
|
794
|
+
Import a cURL or HAR source into a v3 collection (local, or cloud with \-\-workspace).
|
|
795
|
+
|
|
796
|
+
.B Usage:
|
|
797
|
+
[options] <src>
|
|
798
|
+
|
|
799
|
+
.B Options:
|
|
800
|
+
.TP
|
|
801
|
+
.B \-\-type <format>
|
|
802
|
+
Source format: curl or har. Auto\-detected from the extension/content when omitted.
|
|
803
|
+
.TP
|
|
804
|
+
.B \-\-name <name>
|
|
805
|
+
Collection display name. Defaults to a per\-format fallback.
|
|
806
|
+
.TP
|
|
807
|
+
.B \-o, \-\-output <dir>
|
|
808
|
+
Output directory for the local collection (default: postman/collections/<name>).
|
|
809
|
+
.TP
|
|
810
|
+
.B \-w, \-\-workspace <id>
|
|
811
|
+
Create the collection in a Postman cloud workspace by id (cloud mode).
|
|
812
|
+
.TP
|
|
813
|
+
.B \-\-force
|
|
814
|
+
Overwrite an existing local target directory.
|
|
815
|
+
.TP
|
|
816
|
+
.B \-\-timeout <ms>
|
|
817
|
+
Max time for a cloud import, in milliseconds (default 120000).
|
|
818
|
+
.TP
|
|
819
|
+
.B \-\-verbose
|
|
820
|
+
Verbose output (cloud import diagnostics).
|
|
821
|
+
.TP
|
|
822
|
+
.B \-\-json
|
|
823
|
+
JSON output.
|
|
824
|
+
|
|
825
|
+
.TP Examples:
|
|
826
|
+
|
|
827
|
+
<src> is a file path, `\-` for stdin, or an inline cURL command.
|
|
828
|
+
|
|
829
|
+
Examples:
|
|
830
|
+
postman collection import ./login.curl
|
|
831
|
+
postman collection import ./session.har \-\-name "Recorded session"
|
|
832
|
+
pbpaste | postman collection import \- \-\-type curl \-\-name Users
|
|
833
|
+
postman collection import ./session.har \-\-name Session \-\-workspace <workspaceId>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
790
837
|
.SS "collection list"
|
|
791
838
|
List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
|
|
792
839
|
|
|
@@ -838,7 +885,7 @@ Specify an Id or path to a file containing Postman Globals
|
|
|
838
885
|
Specify the reporters to use for the run: cli,json,junit,html. For multiple reporters, provide their names as a comma\-separated list (E.g., \-r cli,json) (default: cli)
|
|
839
886
|
.TP
|
|
840
887
|
.B \-\-output <folder>
|
|
841
|
-
Write a YAML\-based run report to the given folder. Creates a paired `<prefix>.collection\-run\-summary.yaml` (refreshed during the run) and streaming `<prefix>.collection\-run\-executions.yaml`, where prefix defaults to `<collection\-slug>\-<timestamp>`. Gotcha: \-\-output streams run data to file
|
|
888
|
+
Write a YAML\-based run report to the given folder. Creates a paired `<prefix>.collection\-run\-summary.yaml` (refreshed during the run) and streaming `<prefix>.collection\-run\-executions.yaml`, where prefix defaults to `<collection\-slug>\-<timestamp>`. Gotcha: \-\-output streams run data to file, which keeps large runs from buffering an entire report in memory.
|
|
842
889
|
.TP
|
|
843
890
|
.B \-\-reporter\-[reporter]\-export <path>
|
|
844
891
|
[Optional] Specify a path to save the report. By default, reports are saved to the /postman\-cli\-reports directory in your current working directory. If the directory doesn't exist, it will be created automatically. If the specified path is an existing directory, the report file will be saved within it. Supported reporters: json, junit and html.
|
|
@@ -1781,7 +1828,7 @@ Invoke a monitor run and display results.
|
|
|
1781
1828
|
Create a collection\-based monitor.
|
|
1782
1829
|
.TP
|
|
1783
1830
|
.B monitor update
|
|
1784
|
-
Update a monitor's schedule, runner, notifications or run options.
|
|
1831
|
+
Update a monitor's schedule, runner, notifications, request selection or run options.
|
|
1785
1832
|
.TP
|
|
1786
1833
|
.B monitor delete
|
|
1787
1834
|
Permanently delete a monitor. Prompts for confirmation unless \-\-yes is passed.
|
|
@@ -1859,6 +1906,9 @@ Time zone for \-\-schedule, for example America/New_York (defaults to the host m
|
|
|
1859
1906
|
.B \-\-runner <value>
|
|
1860
1907
|
A Postman region name (see `postman runner regions`) or the id of a self\-hosted runner created in Postman (list existing ones with `postman runner list`) to run from (repeatable) (default: )
|
|
1861
1908
|
.TP
|
|
1909
|
+
.B \-i, \-\-item <id>
|
|
1910
|
+
Id of a request or folder in the collection to run, in the order given (repeatable; ids only, not names or paths; defaults to every request; list ids with `postman collection get <collection\-id> \-\-json`) (default: )
|
|
1911
|
+
.TP
|
|
1862
1912
|
.B \-\-notify\-email <email>
|
|
1863
1913
|
Email to notify on a run failure or error (repeatable) (default: )
|
|
1864
1914
|
.TP
|
|
@@ -1913,12 +1963,13 @@ Examples:
|
|
|
1913
1963
|
postman monitor create \-\-collection 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
1914
1964
|
postman monitor create \-\-collection <id> \-\-schedule "0 9 * * MON" \-\-timezone America/New_York
|
|
1915
1965
|
postman monitor create \-\-collection <id> \-\-runner us\-east \-\-runner <self\-hosted\-runner\-id>
|
|
1966
|
+
postman monitor create \-\-collection <id> \-\-item <request\-id> \-\-item <folder\-id>
|
|
1916
1967
|
postman monitor create \-\-collection <id> \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
1917
1968
|
|
|
1918
1969
|
|
|
1919
1970
|
|
|
1920
1971
|
.SS "monitor update"
|
|
1921
|
-
Update a monitor's schedule, runner, notifications or run options.
|
|
1972
|
+
Update a monitor's schedule, runner, notifications, request selection or run options.
|
|
1922
1973
|
|
|
1923
1974
|
.B Usage:
|
|
1924
1975
|
[options] <monitorId>
|
|
@@ -1937,6 +1988,12 @@ Time zone for \-\-schedule, for example America/New_York (defaults to the host m
|
|
|
1937
1988
|
.B \-\-runner <value>
|
|
1938
1989
|
A Postman region name (see `postman runner regions`) or the id of a self\-hosted runner created in Postman (list existing ones with `postman runner list`) to run from (repeatable; replaces the current set) (default: )
|
|
1939
1990
|
.TP
|
|
1991
|
+
.B \-i, \-\-item <id>
|
|
1992
|
+
Id of a request or folder in the collection to run, in the order given (repeatable; ids only, not names or paths; replaces the saved selection; list ids with `postman collection get <collection\-id> \-\-json`) (default: )
|
|
1993
|
+
.TP
|
|
1994
|
+
.B \-\-clear\-items
|
|
1995
|
+
Remove the saved selection so the monitor runs every request in its collection
|
|
1996
|
+
.TP
|
|
1940
1997
|
.B \-\-notify\-email <email>
|
|
1941
1998
|
Email to notify on a run failure or error (repeatable; replaces the current list) (default: )
|
|
1942
1999
|
.TP
|
|
@@ -1998,6 +2055,8 @@ Examples:
|
|
|
1998
2055
|
postman monitor update <id> \-\-notify\-email a@example.com \-\-notify\-email b@example.com
|
|
1999
2056
|
postman monitor update <id> \-\-clear\-notifications
|
|
2000
2057
|
postman monitor update <id> \-\-runner us\-east \-\-runner <self\-hosted\-runner\-id>
|
|
2058
|
+
postman monitor update <id> \-\-item <request\-id> \-\-item <folder\-id>
|
|
2059
|
+
postman monitor update <id> \-\-clear\-items
|
|
2001
2060
|
postman monitor update <id> \-\-environment 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
2002
2061
|
|
|
2003
2062
|
This command cannot change a monitor's linked collection \-\- that is fixed when the monitor is created, so run a different collection by creating a new monitor. It does not pause or resume a monitor either; use `monitor pause`/`monitor resume` for that.
|
|
@@ -2317,6 +2376,9 @@ Filter workspaces by name.
|
|
|
2317
2376
|
.B \-t, \-\-type <type>
|
|
2318
2377
|
Filter workspaces by visibility type: team, public, private, personal.
|
|
2319
2378
|
.TP
|
|
2379
|
+
.B \-\-cursor <cursor>
|
|
2380
|
+
Fetch the page of workspaces that follows this cursor.
|
|
2381
|
+
.TP
|
|
2320
2382
|
.B \-\-verbose
|
|
2321
2383
|
Verbose output
|
|
2322
2384
|
.TP
|
|
@@ -2333,6 +2395,7 @@ Examples:
|
|
|
2333
2395
|
postman workspace list \-\-filter "my\-workspace"
|
|
2334
2396
|
postman workspace list \-\-type team
|
|
2335
2397
|
postman workspace list \-\-type team \-\-filter "project"
|
|
2398
|
+
postman workspace list \-\-cursor "<cursor>"
|
|
2336
2399
|
|
|
2337
2400
|
|
|
2338
2401
|
|
|
@@ -2346,6 +2409,9 @@ Prepare local collections and environments for push by validating and regenerati
|
|
|
2346
2409
|
.TP
|
|
2347
2410
|
.B \-\-verbose
|
|
2348
2411
|
Show detailed logging
|
|
2412
|
+
.TP
|
|
2413
|
+
.B \-\-json
|
|
2414
|
+
Print the outcome as machine\-readable JSON.
|
|
2349
2415
|
|
|
2350
2416
|
.SS "workspace push"
|
|
2351
2417
|
Push local workspace entities (collections, environments, specifications, mocks and more) to Postman workspace.
|
|
@@ -2364,6 +2430,9 @@ Skip all confirmation prompts
|
|
|
2364
2430
|
.B \-\-push\-strategy <strategy>
|
|
2365
2431
|
Push strategy. "force\-sync": mirror the whole workspace — also DELETE cloud entities that have no local counterpart (destructive). Defaults to "default" (create/update only).
|
|
2366
2432
|
.TP
|
|
2433
|
+
.B \-\-json
|
|
2434
|
+
Print the outcome as machine\-readable JSON. Implies non\-interactive: use \-\-yes to actually push.
|
|
2435
|
+
.TP
|
|
2367
2436
|
.B \-\-verbose
|
|
2368
2437
|
Show detailed logging
|
|
2369
2438
|
.TP
|
|
@@ -2455,6 +2524,9 @@ Create the workspace without binding it to the repository
|
|
|
2455
2524
|
.TP
|
|
2456
2525
|
.B \-\-force
|
|
2457
2526
|
Create even when a workspace is already recorded for this repo
|
|
2527
|
+
.TP
|
|
2528
|
+
.B \-\-json
|
|
2529
|
+
Print the created workspace as machine\-readable JSON.
|
|
2458
2530
|
|
|
2459
2531
|
.TP Examples:
|
|
2460
2532
|
|
|
@@ -2516,6 +2588,9 @@ Skip all confirmation prompts
|
|
|
2516
2588
|
.B \-\-source\-workspace <workspaceId>
|
|
2517
2589
|
Pull from a different source workspace.
|
|
2518
2590
|
.TP
|
|
2591
|
+
.B \-\-json
|
|
2592
|
+
Print the outcome as machine\-readable JSON. Implies non\-interactive: use \-\-yes to actually pull.
|
|
2593
|
+
.TP
|
|
2519
2594
|
.B \-\-verbose
|
|
2520
2595
|
Show detailed logging
|
|
2521
2596
|
|
|
@@ -2542,6 +2617,9 @@ Connect a Postman workspace to a local git repository.
|
|
|
2542
2617
|
.TP
|
|
2543
2618
|
.B \-\-verbose
|
|
2544
2619
|
Show detailed logging
|
|
2620
|
+
.TP
|
|
2621
|
+
.B \-\-json
|
|
2622
|
+
Print the outcome as machine\-readable JSON.
|
|
2545
2623
|
|
|
2546
2624
|
.TP Examples:
|
|
2547
2625
|
|
|
@@ -2568,6 +2646,9 @@ Skip all confirmation prompts
|
|
|
2568
2646
|
.TP
|
|
2569
2647
|
.B \-\-verbose
|
|
2570
2648
|
Show detailed logging
|
|
2649
|
+
.TP
|
|
2650
|
+
.B \-\-json
|
|
2651
|
+
Print the outcome as machine\-readable JSON. Requires \-\-yes to actually disconnect.
|
|
2571
2652
|
|
|
2572
2653
|
.TP Examples:
|
|
2573
2654
|
|
|
@@ -3213,6 +3294,30 @@ Preserves the original HTTP method when following redirects. By default, redirec
|
|
|
3213
3294
|
.B \-\-redirects\-remove\-referrer
|
|
3214
3295
|
Removes the Referer header when following redirects. By default, Referer header is sent with redirects.
|
|
3215
3296
|
.TP
|
|
3297
|
+
.B \-k, \-\-insecure
|
|
3298
|
+
Disable SSL certificate verification.
|
|
3299
|
+
.TP
|
|
3300
|
+
.B \-\-ssl\-client\-cert\-list <path>
|
|
3301
|
+
Specify the path to client certificate configurations (JSON).
|
|
3302
|
+
.TP
|
|
3303
|
+
.B \-\-ssl\-client\-cert <path>
|
|
3304
|
+
Specify the path to a client certificate (PEM).
|
|
3305
|
+
.TP
|
|
3306
|
+
.B \-\-ssl\-client\-key <path>
|
|
3307
|
+
Specify the path to a client certificate private key.
|
|
3308
|
+
.TP
|
|
3309
|
+
.B \-\-ssl\-client\-passphrase <passphrase>
|
|
3310
|
+
Specify the client certificate passphrase (for protected key).
|
|
3311
|
+
.TP
|
|
3312
|
+
.B \-\-ssl\-extra\-ca\-certs <path>
|
|
3313
|
+
Specify additional trusted CA certificates (PEM).
|
|
3314
|
+
.TP
|
|
3315
|
+
.B \-\-cookie\-jar <path>
|
|
3316
|
+
Specify the path to a custom cookie jar (serialized tough\-cookie JSON).
|
|
3317
|
+
.TP
|
|
3318
|
+
.B \-\-export\-cookie\-jar <path>
|
|
3319
|
+
Export the cookie jar to a file after completing the request.
|
|
3320
|
+
.TP
|
|
3216
3321
|
.B \-\-retry <n>
|
|
3217
3322
|
Number of retry attempts for failed requests (4xx, 5xx, network errors). Useful for flaky endpoints or rate\-limited APIs. (default: 0)
|
|
3218
3323
|
.TP
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.68.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.68.0",
|
|
66
|
+
"@postman/pm-bin-macos-x64": "1.68.0",
|
|
67
|
+
"@postman/pm-bin-linux-x64": "1.68.0",
|
|
68
|
+
"@postman/pm-bin-linux-arm64": "1.68.0",
|
|
69
|
+
"@postman/pm-bin-windows-x64": "1.68.0"
|
|
70
70
|
}
|
|
71
71
|
}
|