postman-cli 1.67.0 → 1.69.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.
Files changed (2) hide show
  1. package/man/postman.1 +478 -13
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-09-29" "v1.67.0" "Postman CLI Manual"
1
+ .TH POSTMAN 1 "2026-10-01" "v1.69.0" "Postman CLI Manual"
2
2
  .SH NAME
3
3
  postman \- Command\-line companion utility for Postman
4
4
  .SH SYNOPSIS
@@ -300,10 +300,16 @@ Generate artifacts from a collection.
300
300
  Sync artifacts generated from a collection.
301
301
  .TP
302
302
  .B collection request
303
- Add, update, or remove requests in a local v3 collection.
303
+ Add, get, update, or remove requests in a local v3 collection.
304
304
  .TP
305
305
  .B collection folder
306
- Add, update, or remove folders in a local v3 collection.
306
+ Add, get, update, or remove folders in a local v3 collection.
307
+ .TP
308
+ .B collection example
309
+ Add, update, remove, get, or list examples (saved responses) under a request.
310
+ .TP
311
+ .B collection import
312
+ Import a cURL or HAR source into a v3 collection (local, or cloud with \-\-workspace).
307
313
  .TP
308
314
  .B collection list
309
315
  List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
@@ -507,7 +513,7 @@ Examples:
507
513
 
508
514
 
509
515
  .SS "collection request"
510
- Add, update, or remove requests in a local v3 collection.
516
+ Add, get, update, or remove requests in a local v3 collection.
511
517
 
512
518
  .B Usage:
513
519
  [options] [command]
@@ -517,6 +523,9 @@ Add, update, or remove requests in a local v3 collection.
517
523
  .B collection request add
518
524
  Add an empty request to a local v3 collection (set its details later with `update`).
519
525
  .TP
526
+ .B collection request get
527
+ Show a request (any type) in a v3 collection: its own fields, with examples and messages as references.
528
+ .TP
520
529
  .B collection request update
521
530
  Update a request in a v3 collection (only the fields you pass).
522
531
  .TP
@@ -557,6 +566,38 @@ Examples:
557
566
 
558
567
 
559
568
 
569
+ .SS "collection request get"
570
+ Show a request (any type) in a v3 collection: its own fields, with examples and messages as references.
571
+
572
+ .B Usage:
573
+ [options] <request>
574
+
575
+ .B Options:
576
+ .TP
577
+ .B \-\-collection <id|name>
578
+ Target collection: name, directory, id, cloud id, or path. Required locally; optional in cloud mode (id only).
579
+ .TP
580
+ .B \-\-folder <id|name|path>
581
+ Folder to scope a bare\-name request selector, e.g. "Users/Admin" (local mode only).
582
+ .TP
583
+ .B \-w, \-\-workspace <id>
584
+ Target a Postman cloud workspace by id (cloud mode).
585
+ .TP
586
+ .B \-\-json
587
+ JSON output.
588
+
589
+ .TP Examples:
590
+
591
+ Prints the request's own fields in the V3 collection format. Its examples (and, for WebSocket / Socket.IO / MQTT, its messages) are listed as references ({ id, $kind } in cloud mode; { name, $kind } plus id when stored, locally). "parent" is added: the containing folder, or the collection for a top\-level request. A linked copy of a reusable request carries "uses" (its source request id) and a source carries "usedBy" (its linked copies); the source may live in another collection, so fetch it by id alone. Select the request by the <request> selector: local — a name or "Folder/Name" path (or \-\-folder to scope a bare name); cloud (\-\-workspace) — a request id, with \-\-collection (an id) optional and no \-\-folder. Read\-only: locally it reads v3 collections only and rejects a v2.1 .json instead of converting it.
592
+
593
+ Examples:
594
+ postman collection request get "Get user" \-\-collection "My API"
595
+ postman collection request get "Users/Get user" \-\-collection "My API" \-\-json
596
+ postman collection request get <requestId> \-w <workspaceId>
597
+ postman collection request get <requestId> \-\-collection <collectionId> \-w <workspaceId> \-\-json
598
+
599
+
600
+
560
601
  .SS "collection request update"
561
602
  Update a request in a v3 collection (only the fields you pass).
562
603
 
@@ -662,7 +703,7 @@ Examples:
662
703
 
663
704
 
664
705
  .SS "collection folder"
665
- Add, update, or remove folders in a local v3 collection.
706
+ Add, get, update, or remove folders in a local v3 collection.
666
707
 
667
708
  .B Usage:
668
709
  [options] [command]
@@ -672,6 +713,9 @@ Add, update, or remove folders in a local v3 collection.
672
713
  .B collection folder add
673
714
  Add an empty folder to a local v3 collection (set its details later with `update`).
674
715
  .TP
716
+ .B collection folder get
717
+ Show a folder in a v3 collection: its own fields and its direct children as references.
718
+ .TP
675
719
  .B collection folder update
676
720
  Update a folder in a v3 collection (only the fields you pass).
677
721
  .TP
@@ -709,6 +753,38 @@ Examples:
709
753
 
710
754
 
711
755
 
756
+ .SS "collection folder get"
757
+ Show a folder in a v3 collection: its own fields and its direct children as references.
758
+
759
+ .B Usage:
760
+ [options] <folder>
761
+
762
+ .B Options:
763
+ .TP
764
+ .B \-\-collection <id|name>
765
+ Target collection: name, directory, id, cloud id, or path. Required locally; optional in cloud mode (id only).
766
+ .TP
767
+ .B \-\-folder <id|name|path>
768
+ Parent folder to scope a bare\-name selector, e.g. "Users" (local mode only).
769
+ .TP
770
+ .B \-w, \-\-workspace <id>
771
+ Target a Postman cloud workspace by id (cloud mode).
772
+ .TP
773
+ .B \-\-json
774
+ JSON output.
775
+
776
+ .TP Examples:
777
+
778
+ Prints the folder's own fields in the V3 collection format. Its direct children (requests and sub\-folders) are listed under "items" as references ({ id, $kind } in cloud mode; { name, $kind } plus id when stored, locally) — run `get` on a child to go further. "parent" is added: the containing folder, or the collection for a top\-level folder. Select the folder by the <folder> selector: local — a name or "Parent/Name" path (or \-\-folder to scope a bare name); cloud (\-\-workspace) — a folder id, with \-\-collection (an id) optional and no \-\-folder. Read\-only: locally it reads v3 collections only and rejects a v2.1 .json instead of converting it.
779
+
780
+ Examples:
781
+ postman collection folder get Users \-\-collection "My API"
782
+ postman collection folder get "Users/Admin" \-\-collection "My API" \-\-json
783
+ postman collection folder get <folderId> \-w <workspaceId>
784
+ postman collection folder get <folderId> \-\-collection <collectionId> \-w <workspaceId> \-\-json
785
+
786
+
787
+
712
788
  .SS "collection folder update"
713
789
  Update a folder in a v3 collection (only the fields you pass).
714
790
 
@@ -787,6 +863,253 @@ Examples:
787
863
 
788
864
 
789
865
 
866
+ .SS "collection example"
867
+ Add, update, remove, get, or list examples (saved responses) under a request.
868
+
869
+ .B Usage:
870
+ [options] [command]
871
+
872
+ .B Subcommands:
873
+ .TP
874
+ .B collection example add
875
+ Add an empty example under a request (defaults to 200 OK; set details later with `update`).
876
+ .TP
877
+ .B collection example update
878
+ Update an example (only the fields you pass).
879
+ .TP
880
+ .B collection example rm
881
+ Remove an example from a request.
882
+ .TP
883
+ .B collection example get
884
+ Get a single example.
885
+ .TP
886
+ .B collection example list
887
+ List examples under a request.
888
+
889
+ .SS "collection example add"
890
+ Add an empty example under a request (defaults to 200 OK; set details later with `update`).
891
+
892
+ .B Usage:
893
+ [options] [example\-name]
894
+
895
+ .B Options:
896
+ .TP
897
+ .B \-\-collection <id|name>
898
+ Target collection: name, directory, id, cloud id, or path. Required.
899
+ .TP
900
+ .B \-\-request <id|name|path>
901
+ Parent request (required). Local: name/path/id; cloud: id.
902
+ .TP
903
+ .B \-\-folder <id|name|path>
904
+ Folder to scope the request selector, e.g. "Users/Admin".
905
+ .TP
906
+ .B \-\-type <type>
907
+ Example type: http (default). (default: http)
908
+ .TP
909
+ .B \-w, \-\-workspace <id>
910
+ Target a Postman cloud workspace by id (cloud mode).
911
+ .TP
912
+ .B \-\-json
913
+ JSON output.
914
+
915
+ .TP Examples:
916
+
917
+ Creates a stub example (name + type + default 200/OK/{} response). Configure it with `collection example update`. \-\-request is required.
918
+
919
+ Examples:
920
+ postman collection example add "Success" \-\-collection "My API" \-\-request "Get user"
921
+ postman collection example add \-\-collection "My API" \-\-request Ping
922
+ postman collection example add "Ok" \-\-collection <cid> \-\-request <rid> \-w <workspaceId>
923
+
924
+
925
+
926
+ .SS "collection example update"
927
+ Update an example (only the fields you pass).
928
+
929
+ .B Usage:
930
+ [options] <example>
931
+
932
+ .B Options:
933
+ .TP
934
+ .B \-\-collection <id|name>
935
+ Target collection. Required.
936
+ .TP
937
+ .B \-\-request <id|name|path>
938
+ Parent request (optional; disambiguates local names / \-\-copy\-request).
939
+ .TP
940
+ .B \-\-folder <id|name|path>
941
+ Folder to scope the request selector.
942
+ .TP
943
+ .B \-\-status\-code <code>
944
+ HTTP status code.
945
+ .TP
946
+ .B \-\-status\-text <text>
947
+ HTTP status text.
948
+ .TP
949
+ .B \-d, \-\-body <body>
950
+ Response body as contentType:content.
951
+ .TP
952
+ .B \-\-headers <key:value>
953
+ Replace response headers. Repeatable. (default: )
954
+ .TP
955
+ .B \-\-description <text>
956
+ Example description.
957
+ .TP
958
+ .B \-\-rename <name>
959
+ Rename the example.
960
+ .TP
961
+ .B \-\-url <url>
962
+ Example request snapshot URL.
963
+ .TP
964
+ .B \-\-method <method>
965
+ Example request snapshot method.
966
+ .TP
967
+ .B \-\-request\-headers <key:value>
968
+ Replace request\-snapshot headers. Repeatable. (default: )
969
+ .TP
970
+ .B \-\-request\-param <key:value>
971
+ Replace request\-snapshot query params. Repeatable. (default: )
972
+ .TP
973
+ .B \-\-request\-body <body>
974
+ Example request snapshot body.
975
+ .TP
976
+ .B \-\-copy\-request
977
+ Refresh example.request from the parent request.
978
+ .TP
979
+ .B \-\-clear\-request
980
+ Remove the example.request snapshot.
981
+ .TP
982
+ .B \-w, \-\-workspace <id>
983
+ Target a Postman cloud workspace by id (cloud mode).
984
+ .TP
985
+ .B \-\-type <type>
986
+ Example type for cloud mode: http. (default: http)
987
+ .TP
988
+ .B \-\-json
989
+ JSON output.
990
+
991
+ .SS "collection example rm"
992
+ Remove an example from a request.
993
+
994
+ .B Usage:
995
+ [options] <example>
996
+
997
+ .B Options:
998
+ .TP
999
+ .B \-\-collection <id|name>
1000
+ Target collection. Required.
1001
+ .TP
1002
+ .B \-\-request <id|name|path>
1003
+ Parent request (optional; disambiguates local names).
1004
+ .TP
1005
+ .B \-\-folder <id|name|path>
1006
+ Folder to scope the request selector.
1007
+ .TP
1008
+ .B \-w, \-\-workspace <id>
1009
+ Target a Postman cloud workspace by id (cloud mode).
1010
+ .TP
1011
+ .B \-\-type <type>
1012
+ Example type for cloud mode: http. (default: http)
1013
+ .TP
1014
+ .B \-\-json
1015
+ JSON output.
1016
+
1017
+ .SS "collection example get"
1018
+ Get a single example.
1019
+
1020
+ .B Usage:
1021
+ [options] <example>
1022
+
1023
+ .B Options:
1024
+ .TP
1025
+ .B \-\-collection <id|name>
1026
+ Target collection. Required.
1027
+ .TP
1028
+ .B \-\-request <id|name|path>
1029
+ Parent request (optional; disambiguates local names).
1030
+ .TP
1031
+ .B \-\-folder <id|name|path>
1032
+ Folder to scope the request selector.
1033
+ .TP
1034
+ .B \-w, \-\-workspace <id>
1035
+ Target a Postman cloud workspace by id (cloud mode).
1036
+ .TP
1037
+ .B \-\-type <type>
1038
+ Example type for cloud mode: http. (default: http)
1039
+ .TP
1040
+ .B \-\-json
1041
+ JSON output.
1042
+
1043
+ .SS "collection example list"
1044
+ List examples under a request.
1045
+
1046
+ .B Usage:
1047
+ [options]
1048
+
1049
+ .B Options:
1050
+ .TP
1051
+ .B \-\-collection <id|name>
1052
+ Target collection. Required.
1053
+ .TP
1054
+ .B \-\-request <id|name|path>
1055
+ Parent request (required).
1056
+ .TP
1057
+ .B \-\-folder <id|name|path>
1058
+ Folder to scope the request selector.
1059
+ .TP
1060
+ .B \-w, \-\-workspace <id>
1061
+ Target a Postman cloud workspace by id (cloud mode).
1062
+ .TP
1063
+ .B \-\-type <type>
1064
+ Example type for cloud mode: http. (default: http)
1065
+ .TP
1066
+ .B \-\-json
1067
+ JSON output.
1068
+
1069
+ .SS "collection import"
1070
+ Import a cURL or HAR source into a v3 collection (local, or cloud with \-\-workspace).
1071
+
1072
+ .B Usage:
1073
+ [options] <src>
1074
+
1075
+ .B Options:
1076
+ .TP
1077
+ .B \-\-type <format>
1078
+ Source format: curl or har. Auto\-detected from the extension/content when omitted.
1079
+ .TP
1080
+ .B \-\-name <name>
1081
+ Collection display name. Defaults to a per\-format fallback.
1082
+ .TP
1083
+ .B \-o, \-\-output <dir>
1084
+ Output directory for the local collection (default: postman/collections/<name>).
1085
+ .TP
1086
+ .B \-w, \-\-workspace <id>
1087
+ Create the collection in a Postman cloud workspace by id (cloud mode).
1088
+ .TP
1089
+ .B \-\-force
1090
+ Overwrite an existing local target directory.
1091
+ .TP
1092
+ .B \-\-timeout <ms>
1093
+ Max time for a cloud import, in milliseconds (default 120000).
1094
+ .TP
1095
+ .B \-\-verbose
1096
+ Verbose output (cloud import diagnostics).
1097
+ .TP
1098
+ .B \-\-json
1099
+ JSON output.
1100
+
1101
+ .TP Examples:
1102
+
1103
+ <src> is a file path, `\-` for stdin, or an inline cURL command.
1104
+
1105
+ Examples:
1106
+ postman collection import ./login.curl
1107
+ postman collection import ./session.har \-\-name "Recorded session"
1108
+ pbpaste | postman collection import \- \-\-type curl \-\-name Users
1109
+ postman collection import ./session.har \-\-name Session \-\-workspace <workspaceId>
1110
+
1111
+
1112
+
790
1113
  .SS "collection list"
791
1114
  List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
792
1115
 
@@ -838,7 +1161,7 @@ Specify an Id or path to a file containing Postman Globals
838
1161
  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
1162
  .TP
840
1163
  .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 and cannot be combined with the built\-in reporters (\-r/\-\-reporter\-*); doing so exits with an error. This keeps large runs from buffering an entire report in memory.
1164
+ 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
1165
  .TP
843
1166
  .B \-\-reporter\-[reporter]\-export <path>
844
1167
  [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.
@@ -1119,7 +1442,7 @@ Read and update environment variables.
1119
1442
  .B Subcommands:
1120
1443
  .TP
1121
1444
  .B environment var set
1122
- Set one variable in an environment.
1445
+ Set one variable in an environment, or link it to a shared\-vault secret.
1123
1446
  .TP
1124
1447
  .B environment var get
1125
1448
  Read one variable value from an environment.
@@ -1128,16 +1451,25 @@ Read one variable value from an environment.
1128
1451
  Remove one variable from an environment.
1129
1452
 
1130
1453
  .SS "environment var set"
1131
- Set one variable in an environment.
1454
+ Set one variable in an environment, or link it to a shared\-vault secret.
1132
1455
 
1133
1456
  .B Usage:
1134
- [options] <key> <value>
1457
+ [options] <key> [value]
1135
1458
 
1136
1459
  .B Options:
1137
1460
  .TP
1138
1461
  .B \-e, \-\-environment <environment>
1139
1462
  Cloud Environment ID or local environment file path.
1140
1463
  .TP
1464
+ .B \-\-secret\-id <id>
1465
+ Link this variable to a shared\-vault secret instead of an inline value (from `secret create`'s output).
1466
+ .TP
1467
+ .B \-\-vault\-id <id>
1468
+ Vault id for \-\-secret\-id (auto\-resolved from \-\-workspace when omitted).
1469
+ .TP
1470
+ .B \-w, \-\-workspace <workspaceId>
1471
+ Workspace to resolve \-\-vault\-id from when \-\-secret\-id is given without \-\-vault\-id (falls back to .postman/resources.yaml).
1472
+ .TP
1141
1473
  .B \-\-verbose
1142
1474
  Verbose output
1143
1475
  .TP
@@ -1150,6 +1482,8 @@ Examples:
1150
1482
  postman environment var set baseUrl https://api.example.com \e
1151
1483
  \-\-environment ./postman/environments/dev.environment.yaml
1152
1484
  postman environment var set token abc123 \-\-environment 123456\-11111111\-2222\-3333\-4444\-555555555555
1485
+ postman environment var set apiToken \-\-secret\-id b8748ab8\-d1bb\-477f\-95e2\-78625adea75f \e
1486
+ \-\-environment 123456\-11111111\-2222\-3333\-4444\-555555555555 \-\-workspace <workspaceId>
1153
1487
 
1154
1488
 
1155
1489
 
@@ -1449,7 +1783,7 @@ List local spec files under a path, or (no path) a workspace's cloud specs.
1449
1783
  Read a spec definition, including every file of a multi\-file spec.
1450
1784
  .TP
1451
1785
  .B spec file
1452
- Add, update, or remove files in a spec (cloud ID or local directory).
1786
+ Get, add, update, or remove files in a spec (cloud ID or local directory).
1453
1787
  .TP
1454
1788
  .B spec create
1455
1789
  Create a new spec in a workspace, or (with path) scaffold a local spec file.
@@ -1539,13 +1873,16 @@ Examples:
1539
1873
 
1540
1874
 
1541
1875
  .SS "spec file"
1542
- Add, update, or remove files in a spec (cloud ID or local directory).
1876
+ Get, add, update, or remove files in a spec (cloud ID or local directory).
1543
1877
 
1544
1878
  .B Usage:
1545
1879
  [options] [command]
1546
1880
 
1547
1881
  .B Subcommands:
1548
1882
  .TP
1883
+ .B spec file get
1884
+ Show a file in a spec: its path, size and content.
1885
+ .TP
1549
1886
  .B spec file add
1550
1887
  Add a new file to a spec.
1551
1888
  .TP
@@ -1555,6 +1892,29 @@ Update an existing file in a spec.
1555
1892
  .B spec file rm
1556
1893
  Remove a file from a spec.
1557
1894
 
1895
+ .SS "spec file get"
1896
+ Show a file in a spec: its path, size and content.
1897
+
1898
+ .B Usage:
1899
+ [options] <spec> <filePath>
1900
+
1901
+ .B Options:
1902
+ .TP
1903
+ .B \-\-json
1904
+ Output as JSON
1905
+ .TP
1906
+ .B \-\-api\-key <key>
1907
+ Postman API key
1908
+
1909
+ .TP Examples:
1910
+
1911
+ Examples:
1912
+ postman spec file get 12345678\-abcd\-1234\-abcd\-1234567890ab schemas/user.yaml
1913
+ postman spec file get 12345678\-abcd\-1234\-abcd\-1234567890ab index.yaml \-\-json
1914
+ postman spec file get ./postman/specs/api schemas/user.yaml
1915
+
1916
+
1917
+
1558
1918
  .SS "spec file add"
1559
1919
  Add a new file to a spec.
1560
1920
 
@@ -1734,6 +2094,9 @@ Collection ID to sync (required for cloud mode)
1734
2094
  .TP
1735
2095
  .B \-\-api\-key <key>
1736
2096
  Postman API key
2097
+ .TP
2098
+ .B \-\-force
2099
+ Overwrite hand\-written scripts that the spec would otherwise drop
1737
2100
 
1738
2101
  .TP Examples:
1739
2102
 
@@ -1781,7 +2144,7 @@ Invoke a monitor run and display results.
1781
2144
  Create a collection\-based monitor.
1782
2145
  .TP
1783
2146
  .B monitor update
1784
- Update a monitor's schedule, runner, notifications or run options.
2147
+ Update a monitor's schedule, runner, notifications, request selection or run options.
1785
2148
  .TP
1786
2149
  .B monitor delete
1787
2150
  Permanently delete a monitor. Prompts for confirmation unless \-\-yes is passed.
@@ -1859,6 +2222,9 @@ Time zone for \-\-schedule, for example America/New_York (defaults to the host m
1859
2222
  .B \-\-runner <value>
1860
2223
  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
2224
  .TP
2225
+ .B \-i, \-\-item <id>
2226
+ 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: )
2227
+ .TP
1862
2228
  .B \-\-notify\-email <email>
1863
2229
  Email to notify on a run failure or error (repeatable) (default: )
1864
2230
  .TP
@@ -1913,12 +2279,13 @@ Examples:
1913
2279
  postman monitor create \-\-collection 12345678\-90ab\-cdef\-1234\-567890abcdef
1914
2280
  postman monitor create \-\-collection <id> \-\-schedule "0 9 * * MON" \-\-timezone America/New_York
1915
2281
  postman monitor create \-\-collection <id> \-\-runner us\-east \-\-runner <self\-hosted\-runner\-id>
2282
+ postman monitor create \-\-collection <id> \-\-item <request\-id> \-\-item <folder\-id>
1916
2283
  postman monitor create \-\-collection <id> \-\-workspace 12345678\-90ab\-cdef\-1234\-567890abcdef
1917
2284
 
1918
2285
 
1919
2286
 
1920
2287
  .SS "monitor update"
1921
- Update a monitor's schedule, runner, notifications or run options.
2288
+ Update a monitor's schedule, runner, notifications, request selection or run options.
1922
2289
 
1923
2290
  .B Usage:
1924
2291
  [options] <monitorId>
@@ -1937,6 +2304,12 @@ Time zone for \-\-schedule, for example America/New_York (defaults to the host m
1937
2304
  .B \-\-runner <value>
1938
2305
  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
2306
  .TP
2307
+ .B \-i, \-\-item <id>
2308
+ 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: )
2309
+ .TP
2310
+ .B \-\-clear\-items
2311
+ Remove the saved selection so the monitor runs every request in its collection
2312
+ .TP
1940
2313
  .B \-\-notify\-email <email>
1941
2314
  Email to notify on a run failure or error (repeatable; replaces the current list) (default: )
1942
2315
  .TP
@@ -1998,6 +2371,8 @@ Examples:
1998
2371
  postman monitor update <id> \-\-notify\-email a@example.com \-\-notify\-email b@example.com
1999
2372
  postman monitor update <id> \-\-clear\-notifications
2000
2373
  postman monitor update <id> \-\-runner us\-east \-\-runner <self\-hosted\-runner\-id>
2374
+ postman monitor update <id> \-\-item <request\-id> \-\-item <folder\-id>
2375
+ postman monitor update <id> \-\-clear\-items
2001
2376
  postman monitor update <id> \-\-environment 12345678\-90ab\-cdef\-1234\-567890abcdef
2002
2377
 
2003
2378
  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 +2692,9 @@ Filter workspaces by name.
2317
2692
  .B \-t, \-\-type <type>
2318
2693
  Filter workspaces by visibility type: team, public, private, personal.
2319
2694
  .TP
2695
+ .B \-\-cursor <cursor>
2696
+ Fetch the page of workspaces that follows this cursor.
2697
+ .TP
2320
2698
  .B \-\-verbose
2321
2699
  Verbose output
2322
2700
  .TP
@@ -2333,6 +2711,7 @@ Examples:
2333
2711
  postman workspace list \-\-filter "my\-workspace"
2334
2712
  postman workspace list \-\-type team
2335
2713
  postman workspace list \-\-type team \-\-filter "project"
2714
+ postman workspace list \-\-cursor "<cursor>"
2336
2715
 
2337
2716
 
2338
2717
 
@@ -2346,6 +2725,9 @@ Prepare local collections and environments for push by validating and regenerati
2346
2725
  .TP
2347
2726
  .B \-\-verbose
2348
2727
  Show detailed logging
2728
+ .TP
2729
+ .B \-\-json
2730
+ Print the outcome as machine\-readable JSON.
2349
2731
 
2350
2732
  .SS "workspace push"
2351
2733
  Push local workspace entities (collections, environments, specifications, mocks and more) to Postman workspace.
@@ -2364,6 +2746,9 @@ Skip all confirmation prompts
2364
2746
  .B \-\-push\-strategy <strategy>
2365
2747
  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
2748
  .TP
2749
+ .B \-\-json
2750
+ Print the outcome as machine\-readable JSON. Implies non\-interactive: use \-\-yes to actually push.
2751
+ .TP
2367
2752
  .B \-\-verbose
2368
2753
  Show detailed logging
2369
2754
  .TP
@@ -2455,6 +2840,9 @@ Create the workspace without binding it to the repository
2455
2840
  .TP
2456
2841
  .B \-\-force
2457
2842
  Create even when a workspace is already recorded for this repo
2843
+ .TP
2844
+ .B \-\-json
2845
+ Print the created workspace as machine\-readable JSON.
2458
2846
 
2459
2847
  .TP Examples:
2460
2848
 
@@ -2516,6 +2904,9 @@ Skip all confirmation prompts
2516
2904
  .B \-\-source\-workspace <workspaceId>
2517
2905
  Pull from a different source workspace.
2518
2906
  .TP
2907
+ .B \-\-json
2908
+ Print the outcome as machine\-readable JSON. Implies non\-interactive: use \-\-yes to actually pull.
2909
+ .TP
2519
2910
  .B \-\-verbose
2520
2911
  Show detailed logging
2521
2912
 
@@ -2542,6 +2933,9 @@ Connect a Postman workspace to a local git repository.
2542
2933
  .TP
2543
2934
  .B \-\-verbose
2544
2935
  Show detailed logging
2936
+ .TP
2937
+ .B \-\-json
2938
+ Print the outcome as machine\-readable JSON.
2545
2939
 
2546
2940
  .TP Examples:
2547
2941
 
@@ -2568,6 +2962,9 @@ Skip all confirmation prompts
2568
2962
  .TP
2569
2963
  .B \-\-verbose
2570
2964
  Show detailed logging
2965
+ .TP
2966
+ .B \-\-json
2967
+ Print the outcome as machine\-readable JSON. Requires \-\-yes to actually disconnect.
2571
2968
 
2572
2969
  .TP Examples:
2573
2970
 
@@ -3213,6 +3610,30 @@ Preserves the original HTTP method when following redirects. By default, redirec
3213
3610
  .B \-\-redirects\-remove\-referrer
3214
3611
  Removes the Referer header when following redirects. By default, Referer header is sent with redirects.
3215
3612
  .TP
3613
+ .B \-k, \-\-insecure
3614
+ Disable SSL certificate verification.
3615
+ .TP
3616
+ .B \-\-ssl\-client\-cert\-list <path>
3617
+ Specify the path to client certificate configurations (JSON).
3618
+ .TP
3619
+ .B \-\-ssl\-client\-cert <path>
3620
+ Specify the path to a client certificate (PEM).
3621
+ .TP
3622
+ .B \-\-ssl\-client\-key <path>
3623
+ Specify the path to a client certificate private key.
3624
+ .TP
3625
+ .B \-\-ssl\-client\-passphrase <passphrase>
3626
+ Specify the client certificate passphrase (for protected key).
3627
+ .TP
3628
+ .B \-\-ssl\-extra\-ca\-certs <path>
3629
+ Specify additional trusted CA certificates (PEM).
3630
+ .TP
3631
+ .B \-\-cookie\-jar <path>
3632
+ Specify the path to a custom cookie jar (serialized tough\-cookie JSON).
3633
+ .TP
3634
+ .B \-\-export\-cookie\-jar <path>
3635
+ Export the cookie jar to a file after completing the request.
3636
+ .TP
3216
3637
  .B \-\-retry <n>
3217
3638
  Number of retry attempts for failed requests (4xx, 5xx, network errors). Useful for flaky endpoints or rate\-limited APIs. (default: 0)
3218
3639
  .TP
@@ -6613,6 +7034,50 @@ Examples:
6613
7034
 
6614
7035
 
6615
7036
 
7037
+ .SS "secret"
7038
+ Create and manage Postman secrets in a team's shared vault.
7039
+
7040
+ .B Usage:
7041
+ [options] [command]
7042
+
7043
+ .B Subcommands:
7044
+ .TP
7045
+ .B secret create
7046
+ Create a secret in a team's shared vault.
7047
+
7048
+ .SS "secret create"
7049
+ Create a secret in a team's shared vault.
7050
+
7051
+ .B Usage:
7052
+ [options] <key>
7053
+
7054
+ .B Options:
7055
+ .TP
7056
+ .B \-\-team\-id <id>
7057
+ Team id (defaults to your authenticated profile's team; must be your own team — the vault rejects any other team id, even one you otherwise have access to)
7058
+ .TP
7059
+ .B \-w, \-\-workspace <workspaceId>
7060
+ Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
7061
+ .TP
7062
+ .B \-\-api\-key <key>
7063
+ Postman API key
7064
+ .TP
7065
+ .B \-\-value\-stdin
7066
+ Read the secret value from stdin instead of prompting
7067
+
7068
+ .TP Examples:
7069
+
7070
+ The secret value is never accepted as a command\-line argument. Provide it via:
7071
+ \- an interactive masked prompt (default, when stdin is a terminal)
7072
+ \- piped stdin: printf '%s' 's3cr3t' | postman secret create MY_SECRET
7073
+ \- \-\-value\-stdin (explicit, same as piping)
7074
+
7075
+ Examples:
7076
+ postman secret create MY_SECRET \-\-team\-id 451 \-\-workspace 00000000\-0000\-0000\-0000\-000000000000
7077
+ printf '%s' 's3cr3t' | postman secret create MY_SECRET \-\-team\-id 451 \-\-value\-stdin
7078
+
7079
+
7080
+
6616
7081
  .SH SEE ALSO
6617
7082
  Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
6618
7083
  .SH AUTHOR
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.67.0",
3
+ "version": "1.69.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.67.0",
66
- "@postman/pm-bin-macos-x64": "1.67.0",
67
- "@postman/pm-bin-linux-x64": "1.67.0",
68
- "@postman/pm-bin-linux-arm64": "1.67.0",
69
- "@postman/pm-bin-windows-x64": "1.67.0"
65
+ "@postman/pm-bin-macos-arm64": "1.69.0",
66
+ "@postman/pm-bin-macos-x64": "1.69.0",
67
+ "@postman/pm-bin-linux-x64": "1.69.0",
68
+ "@postman/pm-bin-linux-arm64": "1.69.0",
69
+ "@postman/pm-bin-windows-x64": "1.69.0"
70
70
  }
71
71
  }