postman-cli 1.60.0 → 1.62.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 +277 -44
- 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-22" "v1.62.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -145,6 +145,23 @@ Show the Postman account or guest session this CLI session is using.
|
|
|
145
145
|
.B \-\-json
|
|
146
146
|
Print current identity as machine\-readable JSON.
|
|
147
147
|
|
|
148
|
+
.SS "feedback"
|
|
149
|
+
Submit feedback about CLI usability, gaps, and improvement suggestions.
|
|
150
|
+
|
|
151
|
+
.B Usage:
|
|
152
|
+
[options] <text>
|
|
153
|
+
|
|
154
|
+
.B Options:
|
|
155
|
+
.TP
|
|
156
|
+
.B \-\-type <type>
|
|
157
|
+
Feedback type: cli_gap, improvement_suggestion, bug_report, feature_request, general (default: general)
|
|
158
|
+
.TP
|
|
159
|
+
.B \-\-context <context>
|
|
160
|
+
Command or feature context this feedback is about
|
|
161
|
+
.TP
|
|
162
|
+
.B \-\-json
|
|
163
|
+
Print result as machine\-readable JSON
|
|
164
|
+
|
|
148
165
|
.SS "update"
|
|
149
166
|
Update Postman CLI using the original installation method.
|
|
150
167
|
|
|
@@ -266,6 +283,9 @@ Score a Postman collection for AI readiness by ID, local file path, or local\-mo
|
|
|
266
283
|
.B collection get
|
|
267
284
|
Fetch a Postman collection in the V3 format and print it.
|
|
268
285
|
.TP
|
|
286
|
+
.B collection request
|
|
287
|
+
Add, update, or remove requests in a local v3 collection.
|
|
288
|
+
.TP
|
|
269
289
|
.B collection list
|
|
270
290
|
List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
|
|
271
291
|
.TP
|
|
@@ -302,8 +322,8 @@ Examples:
|
|
|
302
322
|
Without \-\-workspace this writes postman/collections/<name>/.resources/definition.yaml
|
|
303
323
|
in the current directory, which must be a local Postman workspace (a directory holding
|
|
304
324
|
\&.postman/ or postman/). Add requests as <request\-name>.request.yaml files beside it, then
|
|
305
|
-
publish with `postman workspace push`. Creating a collection in a workspace
|
|
306
|
-
|
|
325
|
+
publish with `postman workspace push`. Creating a collection in a workspace works with a
|
|
326
|
+
signed\-in credential or with the guest session `postman init` mints.
|
|
307
327
|
|
|
308
328
|
|
|
309
329
|
|
|
@@ -377,6 +397,156 @@ Eg. postman collection get 12345\-33823532ab9e41c9b6fd12d0fd459b8b
|
|
|
377
397
|
postman collection get 0123456789abcdef01234567 \-\-json
|
|
378
398
|
|
|
379
399
|
|
|
400
|
+
.SS "collection request"
|
|
401
|
+
Add, update, or remove requests in a local v3 collection.
|
|
402
|
+
|
|
403
|
+
.B Usage:
|
|
404
|
+
[options] [command]
|
|
405
|
+
|
|
406
|
+
.B Subcommands:
|
|
407
|
+
.TP
|
|
408
|
+
.B collection request add
|
|
409
|
+
Add an empty request to a local v3 collection (set its details later with `update`).
|
|
410
|
+
.TP
|
|
411
|
+
.B collection request update
|
|
412
|
+
Update a request in a v3 collection (only the fields you pass).
|
|
413
|
+
.TP
|
|
414
|
+
.B collection request rm
|
|
415
|
+
Remove a request (any type) from a v3 collection.
|
|
416
|
+
|
|
417
|
+
.SS "collection request add"
|
|
418
|
+
Add an empty request to a local v3 collection (set its details later with `update`).
|
|
419
|
+
|
|
420
|
+
.B Usage:
|
|
421
|
+
[options] [request\-name]
|
|
422
|
+
|
|
423
|
+
.B Options:
|
|
424
|
+
.TP
|
|
425
|
+
.B \-\-collection <id|name>
|
|
426
|
+
Target collection: name, directory, id, cloud id, or path. Required.
|
|
427
|
+
.TP
|
|
428
|
+
.B \-\-folder <id|name|path>
|
|
429
|
+
Folder within the collection, e.g. "Users/Admin". Defaults to the root.
|
|
430
|
+
.TP
|
|
431
|
+
.B \-\-type <type>
|
|
432
|
+
Request type: http, graphql, grpc, websocket, socketio. (default: http)
|
|
433
|
+
.TP
|
|
434
|
+
.B \-w, \-\-workspace <id>
|
|
435
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
436
|
+
.TP
|
|
437
|
+
.B \-\-json
|
|
438
|
+
JSON output.
|
|
439
|
+
|
|
440
|
+
.TP Examples:
|
|
441
|
+
|
|
442
|
+
Creates an empty request (name + type only). Configure it with `collection request update`.
|
|
443
|
+
|
|
444
|
+
Examples:
|
|
445
|
+
postman collection request add "Get user" \-\-collection "My API"
|
|
446
|
+
postman collection request add \-\-collection "My API" # named "New request"
|
|
447
|
+
postman collection request add "List" \-\-collection "My API" \-\-folder Users \-\-type http
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
.SS "collection request update"
|
|
452
|
+
Update a request in a v3 collection (only the fields you pass).
|
|
453
|
+
|
|
454
|
+
.B Usage:
|
|
455
|
+
[options] <request>
|
|
456
|
+
|
|
457
|
+
.B Options:
|
|
458
|
+
.TP
|
|
459
|
+
.B \-\-collection <id|name>
|
|
460
|
+
Target collection: name, directory, id, cloud id, or path (cloud: id only). Required.
|
|
461
|
+
.TP
|
|
462
|
+
.B \-\-folder <id|name|path>
|
|
463
|
+
Folder to scope the request selector, e.g. "Users/Admin" (local: name/path; cloud: id).
|
|
464
|
+
.TP
|
|
465
|
+
.B \-\-rename <name>
|
|
466
|
+
Rename the request (moves its file). Any request type.
|
|
467
|
+
.TP
|
|
468
|
+
.B \-\-url <url>
|
|
469
|
+
Request URL. Any request type.
|
|
470
|
+
.TP
|
|
471
|
+
.B \-\-method <method>
|
|
472
|
+
HTTP method (http requests only).
|
|
473
|
+
.TP
|
|
474
|
+
.B \-\-param <key:value>
|
|
475
|
+
Replace query parameters. Repeatable (http requests only). (default: )
|
|
476
|
+
.TP
|
|
477
|
+
.B \-d, \-\-body <body>
|
|
478
|
+
Request payload (inline, @file, or \- for stdin), interpreted by request type. For http, an optional "<type>:" prefix picks the content type: json/text/xml/html/javascript, file:<path>, urlencoded:key=v&k2=v2, or formdata:key=v&file=@path.
|
|
479
|
+
.TP
|
|
480
|
+
.B \-\-variables <json>
|
|
481
|
+
GraphQL variables JSON (graphql requests only).
|
|
482
|
+
.TP
|
|
483
|
+
.B \-\-description <text>
|
|
484
|
+
Request description.
|
|
485
|
+
.TP
|
|
486
|
+
.B \-\-headers <key:value>
|
|
487
|
+
Replace request headers. Repeatable; any request type with headers. (default: )
|
|
488
|
+
.TP
|
|
489
|
+
.B \-\-auth <spec>
|
|
490
|
+
Request auth: none, inherit, bearer:TOKEN, basic:USER:PASS, apikey:KEY:VALUE[:header|query], oauth2:TOKEN. Any request type.
|
|
491
|
+
.TP
|
|
492
|
+
.B \-\-scripts <event:script>
|
|
493
|
+
Replace scripts. event is prerequest or test; script is @file, \- for stdin, or inline. Repeatable; any request type. (default: )
|
|
494
|
+
.TP
|
|
495
|
+
.B \-w, \-\-workspace <id>
|
|
496
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
497
|
+
.TP
|
|
498
|
+
.B \-\-type <type>
|
|
499
|
+
Request type for cloud mode: http, graphql, grpc, websocket, socketio. (default: http)
|
|
500
|
+
.TP
|
|
501
|
+
.B \-\-json
|
|
502
|
+
JSON output.
|
|
503
|
+
|
|
504
|
+
.TP Examples:
|
|
505
|
+
|
|
506
|
+
Works on any request type; \-\-rename/\-\-url/\-\-description/\-\-headers/\-\-auth/\-\-scripts apply to all, while \-\-method/\-\-param/\-\-body are http\-only. 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 too.
|
|
507
|
+
|
|
508
|
+
Examples:
|
|
509
|
+
postman collection request update "Get user" \-\-collection "My API" \-\-url "{{baseUrl}}/users/:id"
|
|
510
|
+
postman collection request update "Get user" \-\-collection "My API" \-\-folder Users \-\-rename "Fetch user"
|
|
511
|
+
postman collection request update "Get user" \-\-collection "My API" \-\-headers "Authorization:Bearer x" \-\-auth bearer:TOKEN \-\-scripts "test:@check.js"
|
|
512
|
+
postman collection request update <requestId> \-\-collection <collectionId> \-\-url "..." \-w <workspaceId>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
.SS "collection request rm"
|
|
517
|
+
Remove a request (any type) from a v3 collection.
|
|
518
|
+
|
|
519
|
+
.B Usage:
|
|
520
|
+
[options] <request>
|
|
521
|
+
|
|
522
|
+
.B Options:
|
|
523
|
+
.TP
|
|
524
|
+
.B \-\-collection <id|name>
|
|
525
|
+
Target collection: name, directory, id, cloud id, or path (cloud: id only). Required.
|
|
526
|
+
.TP
|
|
527
|
+
.B \-\-folder <id|name|path>
|
|
528
|
+
Folder to scope the request selector, e.g. "Users/Admin" (local: name/path; cloud: id).
|
|
529
|
+
.TP
|
|
530
|
+
.B \-w, \-\-workspace <id>
|
|
531
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
532
|
+
.TP
|
|
533
|
+
.B \-\-type <type>
|
|
534
|
+
Request type for cloud mode: http, graphql, grpc, websocket, socketio. (default: http)
|
|
535
|
+
.TP
|
|
536
|
+
.B \-\-json
|
|
537
|
+
JSON output.
|
|
538
|
+
|
|
539
|
+
.TP Examples:
|
|
540
|
+
|
|
541
|
+
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 too.
|
|
542
|
+
|
|
543
|
+
Examples:
|
|
544
|
+
postman collection request rm "Get user" \-\-collection "My API"
|
|
545
|
+
postman collection request rm "Get user" \-\-collection "My API" \-\-folder Users
|
|
546
|
+
postman collection request rm <requestId> \-\-collection <collectionId> \-w <workspaceId>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
380
550
|
.SS "collection list"
|
|
381
551
|
List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
|
|
382
552
|
|
|
@@ -1358,7 +1528,7 @@ Invoke a monitor run and display results.
|
|
|
1358
1528
|
.B Options:
|
|
1359
1529
|
.TP
|
|
1360
1530
|
.B \-\-api\-key <key>
|
|
1361
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1531
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1362
1532
|
.TP
|
|
1363
1533
|
.B \-x, \-\-suppress\-exit\-code
|
|
1364
1534
|
Specify whether or not to override the default exit code for the current run
|
|
@@ -1444,7 +1614,7 @@ How iteration data is consumed, for example round_robin, repeat_last or stop_at_
|
|
|
1444
1614
|
Do not trigger an immediate run after creating the monitor
|
|
1445
1615
|
.TP
|
|
1446
1616
|
.B \-\-api\-key <key>
|
|
1447
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1617
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1448
1618
|
.TP
|
|
1449
1619
|
.B \-\-json
|
|
1450
1620
|
Output as JSON instead of a table
|
|
@@ -1528,7 +1698,7 @@ Number of iterations to run
|
|
|
1528
1698
|
How iteration data is consumed, for example round_robin, repeat_last or stop_at_end (requires \-\-iteration\-count, \-\-dataset\-id and \-\-dataset\-view\-id)
|
|
1529
1699
|
.TP
|
|
1530
1700
|
.B \-\-api\-key <key>
|
|
1531
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1701
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1532
1702
|
.TP
|
|
1533
1703
|
.B \-\-json
|
|
1534
1704
|
Output as JSON instead of a table
|
|
@@ -1557,7 +1727,7 @@ Permanently delete a monitor. Prompts for confirmation unless \-\-yes is passed.
|
|
|
1557
1727
|
Skip the confirmation prompt
|
|
1558
1728
|
.TP
|
|
1559
1729
|
.B \-\-api\-key <key>
|
|
1560
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1730
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1561
1731
|
.TP
|
|
1562
1732
|
.B \-\-json
|
|
1563
1733
|
Output the outcome, including any failure, as JSON instead of a plain message
|
|
@@ -1668,7 +1838,7 @@ List the monitors visible to you.
|
|
|
1668
1838
|
.B Options:
|
|
1669
1839
|
.TP
|
|
1670
1840
|
.B \-\-api\-key <key>
|
|
1671
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1841
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1672
1842
|
.TP
|
|
1673
1843
|
.B \-w, \-\-workspace <id>
|
|
1674
1844
|
Filter to monitors in this workspace
|
|
@@ -1731,7 +1901,7 @@ Show a monitor's configuration.
|
|
|
1731
1901
|
.B Options:
|
|
1732
1902
|
.TP
|
|
1733
1903
|
.B \-\-api\-key <key>
|
|
1734
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1904
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1735
1905
|
.TP
|
|
1736
1906
|
.B \-\-json
|
|
1737
1907
|
Output as JSON instead of a table
|
|
@@ -1751,7 +1921,7 @@ Show per\-request latency and outcome history for a monitor.
|
|
|
1751
1921
|
.B Options:
|
|
1752
1922
|
.TP
|
|
1753
1923
|
.B \-\-api\-key <key>
|
|
1754
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1924
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1755
1925
|
.TP
|
|
1756
1926
|
.B \-\-since <dateTime>
|
|
1757
1927
|
Only executions at or after this ISO 8601 date\-time (defaults to 7 days ago)
|
|
@@ -1785,7 +1955,7 @@ Pause a monitor, so it stops firing on schedule.
|
|
|
1785
1955
|
.B Options:
|
|
1786
1956
|
.TP
|
|
1787
1957
|
.B \-\-api\-key <key>
|
|
1788
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1958
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1789
1959
|
.TP
|
|
1790
1960
|
.B \-\-json
|
|
1791
1961
|
Output as JSON instead of a table
|
|
@@ -1799,7 +1969,7 @@ Resume a paused monitor, so it fires on schedule again.
|
|
|
1799
1969
|
.B Options:
|
|
1800
1970
|
.TP
|
|
1801
1971
|
.B \-\-api\-key <key>
|
|
1802
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1972
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1803
1973
|
.TP
|
|
1804
1974
|
.B \-\-json
|
|
1805
1975
|
Output as JSON instead of a table
|
|
@@ -1969,7 +2139,7 @@ Create a Postman workspace and bind it to this git repository.
|
|
|
1969
2139
|
.B Options:
|
|
1970
2140
|
.TP
|
|
1971
2141
|
.B \-\-visibility <status>
|
|
1972
|
-
Required.
|
|
2142
|
+
Required. One of: personal, private, team, public, partner.
|
|
1973
2143
|
.TP
|
|
1974
2144
|
.B \-\-name <name>
|
|
1975
2145
|
Workspace name (defaults to owner/repo from the git remote)
|
|
@@ -1977,6 +2147,12 @@ Workspace name (defaults to owner/repo from the git remote)
|
|
|
1977
2147
|
.B \-\-summary <text>
|
|
1978
2148
|
Optional workspace summary
|
|
1979
2149
|
.TP
|
|
2150
|
+
.B \-\-team\-id <id>
|
|
2151
|
+
The team inside your organisation the workspace belongs to. Required for a team workspace when your organisation has teams inside it. Find it with `postman team list`.
|
|
2152
|
+
.TP
|
|
2153
|
+
.B \-\-team\-role <level>
|
|
2154
|
+
What a team or public workspace grants: view or edit. Applies to the team named by \-\-team\-id, or to your whole organisation when none is named. Defaults to your team's configured default.
|
|
2155
|
+
.TP
|
|
1980
2156
|
.B \-\-path <dir>
|
|
1981
2157
|
Directory to bind (defaults to the current directory)
|
|
1982
2158
|
.TP
|
|
@@ -1994,6 +2170,8 @@ Refuses to run on CI: create once locally and commit the binding.
|
|
|
1994
2170
|
Examples:
|
|
1995
2171
|
$ postman workspace create \-\-visibility personal
|
|
1996
2172
|
$ postman workspace create \-\-visibility team \-\-name "acme/orders"
|
|
2173
|
+
$ postman workspace create \-\-visibility team \-\-team\-id 451
|
|
2174
|
+
$ postman workspace create \-\-visibility team \-\-team\-role view
|
|
1997
2175
|
$ postman workspace create \-\-visibility personal \-\-no\-connect
|
|
1998
2176
|
|
|
1999
2177
|
|
|
@@ -2090,6 +2268,58 @@ Examples:
|
|
|
2090
2268
|
|
|
2091
2269
|
|
|
2092
2270
|
|
|
2271
|
+
.SS "team"
|
|
2272
|
+
Work with the teams inside your organisation.
|
|
2273
|
+
|
|
2274
|
+
.B Usage:
|
|
2275
|
+
[options] [command]
|
|
2276
|
+
|
|
2277
|
+
.TP Examples:
|
|
2278
|
+
|
|
2279
|
+
These are the teams inside an organisation, which the Postman app shows
|
|
2280
|
+
under "Teams". The organisation itself is what `postman whoami` reports
|
|
2281
|
+
as your team. A Postman team that is not an organisation has none.
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
.B Subcommands:
|
|
2286
|
+
.TP
|
|
2287
|
+
.B team list
|
|
2288
|
+
List the teams inside your organisation.
|
|
2289
|
+
|
|
2290
|
+
.SS "team list"
|
|
2291
|
+
List the teams inside your organisation.
|
|
2292
|
+
|
|
2293
|
+
.B Usage:
|
|
2294
|
+
[options]
|
|
2295
|
+
|
|
2296
|
+
.B Options:
|
|
2297
|
+
.TP
|
|
2298
|
+
.B \-\-can\-create\-workspace
|
|
2299
|
+
Only list teams you could create a workspace in.
|
|
2300
|
+
.TP
|
|
2301
|
+
.B \-\-json
|
|
2302
|
+
Print the list as machine\-readable JSON.
|
|
2303
|
+
.TP
|
|
2304
|
+
.B \-\-timeout <ms>
|
|
2305
|
+
Abort the run after this many milliseconds. Defaults to 30000.
|
|
2306
|
+
|
|
2307
|
+
.TP Examples:
|
|
2308
|
+
|
|
2309
|
+
Requires a login (`postman login`) or POSTMAN_API_KEY.
|
|
2310
|
+
These are the teams inside your organisation. The organisation itself is
|
|
2311
|
+
what `postman whoami` reports as your team. `postman workspace create
|
|
2312
|
+
\-\-team\-id <id>` takes the id from this list.
|
|
2313
|
+
|
|
2314
|
+
A Postman team that is not an organisation has no teams inside it, so this
|
|
2315
|
+
lists nothing and exits 0.
|
|
2316
|
+
|
|
2317
|
+
Examples:
|
|
2318
|
+
$ postman team list
|
|
2319
|
+
$ postman team list \-\-can\-create\-workspace
|
|
2320
|
+
$ postman team list \-\-json
|
|
2321
|
+
|
|
2322
|
+
|
|
2093
2323
|
.SS "performance"
|
|
2094
2324
|
Manage performance tests on your collections.
|
|
2095
2325
|
|
|
@@ -2148,6 +2378,9 @@ How rows map to VUs: round\-robin (default), fixed, random
|
|
|
2148
2378
|
.B \-\-postman\-api\-key <apiKey>
|
|
2149
2379
|
API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
|
|
2150
2380
|
.TP
|
|
2381
|
+
.B \-\-output <format>
|
|
2382
|
+
Output format for live results: auto (default, interactive dashboard) or ndjson (one JSON object per line on stdout, ending with a "summary" event — for CI or other non\-interactive use) (default: auto)
|
|
2383
|
+
.TP
|
|
2151
2384
|
.B \-\-runner <runner>
|
|
2152
2385
|
Runner to execute the performance test on: local, postman\-cloud, or postman\-cloud\-static\-ip (egress from your account region's static\-IP cluster) (default: )
|
|
2153
2386
|
.TP
|
|
@@ -3710,7 +3943,7 @@ Start mocks with fault\-injection scenarios defined in a .sim.yaml file
|
|
|
3710
3943
|
.B Usage:
|
|
3711
3944
|
[options] <filepath>
|
|
3712
3945
|
|
|
3713
|
-
.SS "
|
|
3946
|
+
.SS "describe"
|
|
3714
3947
|
[Beta] Get API context for AI coding agents directly from the command line.
|
|
3715
3948
|
|
|
3716
3949
|
|
|
@@ -3719,7 +3952,7 @@ Start mocks with fault\-injection scenarios defined in a .sim.yaml file
|
|
|
3719
3952
|
|
|
3720
3953
|
.B Subcommands:
|
|
3721
3954
|
.TP
|
|
3722
|
-
.B
|
|
3955
|
+
.B describe instructions
|
|
3723
3956
|
Get agent instructions for using Postman Context with AI coding agents.
|
|
3724
3957
|
|
|
3725
3958
|
Topics:
|
|
@@ -3729,25 +3962,25 @@ Topics:
|
|
|
3729
3962
|
maintenance — Agent instructions for maintaining and updating client code
|
|
3730
3963
|
|
|
3731
3964
|
.TP
|
|
3732
|
-
.B
|
|
3965
|
+
.B describe collection
|
|
3733
3966
|
Collection commands
|
|
3734
3967
|
.TP
|
|
3735
|
-
.B
|
|
3968
|
+
.B describe request
|
|
3736
3969
|
Request commands
|
|
3737
3970
|
.TP
|
|
3738
|
-
.B
|
|
3971
|
+
.B describe folder
|
|
3739
3972
|
Folder commands
|
|
3740
3973
|
.TP
|
|
3741
|
-
.B
|
|
3974
|
+
.B describe response
|
|
3742
3975
|
Response commands
|
|
3743
3976
|
.TP
|
|
3744
|
-
.B
|
|
3977
|
+
.B describe workspace
|
|
3745
3978
|
Workspace commands
|
|
3746
3979
|
.TP
|
|
3747
|
-
.B
|
|
3980
|
+
.B describe environment
|
|
3748
3981
|
Environment commands
|
|
3749
3982
|
|
|
3750
|
-
.SS "
|
|
3983
|
+
.SS "describe instructions"
|
|
3751
3984
|
Get agent instructions for using Postman Context with AI coding agents.
|
|
3752
3985
|
|
|
3753
3986
|
Topics:
|
|
@@ -3760,7 +3993,7 @@ Topics:
|
|
|
3760
3993
|
.B Usage:
|
|
3761
3994
|
[options] [topic]
|
|
3762
3995
|
|
|
3763
|
-
.SS "
|
|
3996
|
+
.SS "describe collection"
|
|
3764
3997
|
Collection commands
|
|
3765
3998
|
|
|
3766
3999
|
.B Usage:
|
|
@@ -3768,13 +4001,13 @@ Collection commands
|
|
|
3768
4001
|
|
|
3769
4002
|
.B Subcommands:
|
|
3770
4003
|
.TP
|
|
3771
|
-
.B
|
|
4004
|
+
.B describe collection get
|
|
3772
4005
|
Get a collection's metadata and a map of its folders and requests.
|
|
3773
4006
|
|
|
3774
4007
|
Returns collection info (name, description, variables, auth) plus a
|
|
3775
4008
|
recursive tree of folders and requests.
|
|
3776
4009
|
|
|
3777
|
-
.SS "
|
|
4010
|
+
.SS "describe collection get"
|
|
3778
4011
|
Get a collection's metadata and a map of its folders and requests.
|
|
3779
4012
|
|
|
3780
4013
|
Returns collection info (name, description, variables, auth) plus a
|
|
@@ -3788,7 +4021,7 @@ recursive tree of folders and requests.
|
|
|
3788
4021
|
.B \-c, \-\-collection\-id <id>
|
|
3789
4022
|
Collection ID
|
|
3790
4023
|
|
|
3791
|
-
.SS "
|
|
4024
|
+
.SS "describe request"
|
|
3792
4025
|
Request commands
|
|
3793
4026
|
|
|
3794
4027
|
.B Usage:
|
|
@@ -3796,10 +4029,10 @@ Request commands
|
|
|
3796
4029
|
|
|
3797
4030
|
.B Subcommands:
|
|
3798
4031
|
.TP
|
|
3799
|
-
.B
|
|
4032
|
+
.B describe request get
|
|
3800
4033
|
Get a request from a collection
|
|
3801
4034
|
.TP
|
|
3802
|
-
.B
|
|
4035
|
+
.B describe request context
|
|
3803
4036
|
Fetch all context about a request and return it as a Markdown document.
|
|
3804
4037
|
|
|
3805
4038
|
Returns: collection metadata, request details (method, URL, headers, body,
|
|
@@ -3807,9 +4040,9 @@ auth, docs), parent folder documentation, response examples, and
|
|
|
3807
4040
|
environment variables.
|
|
3808
4041
|
|
|
3809
4042
|
Examples:
|
|
3810
|
-
postman
|
|
4043
|
+
postman describe request context \-c <collection\-id> \-r <request\-id>
|
|
3811
4044
|
|
|
3812
|
-
.SS "
|
|
4045
|
+
.SS "describe request get"
|
|
3813
4046
|
Get a request from a collection
|
|
3814
4047
|
|
|
3815
4048
|
.B Usage:
|
|
@@ -3823,7 +4056,7 @@ Request ID
|
|
|
3823
4056
|
.B \-c, \-\-collection\-id <id>
|
|
3824
4057
|
Collection ID
|
|
3825
4058
|
|
|
3826
|
-
.SS "
|
|
4059
|
+
.SS "describe request context"
|
|
3827
4060
|
Fetch all context about a request and return it as a Markdown document.
|
|
3828
4061
|
|
|
3829
4062
|
Returns: collection metadata, request details (method, URL, headers, body,
|
|
@@ -3831,7 +4064,7 @@ auth, docs), parent folder documentation, response examples, and
|
|
|
3831
4064
|
environment variables.
|
|
3832
4065
|
|
|
3833
4066
|
Examples:
|
|
3834
|
-
postman
|
|
4067
|
+
postman describe request context \-c <collection\-id> \-r <request\-id>
|
|
3835
4068
|
|
|
3836
4069
|
.B Usage:
|
|
3837
4070
|
[options]
|
|
@@ -3844,7 +4077,7 @@ Collection ID
|
|
|
3844
4077
|
.B \-r, \-\-request\-id <id>
|
|
3845
4078
|
Request ID
|
|
3846
4079
|
|
|
3847
|
-
.SS "
|
|
4080
|
+
.SS "describe folder"
|
|
3848
4081
|
Folder commands
|
|
3849
4082
|
|
|
3850
4083
|
.B Usage:
|
|
@@ -3852,10 +4085,10 @@ Folder commands
|
|
|
3852
4085
|
|
|
3853
4086
|
.B Subcommands:
|
|
3854
4087
|
.TP
|
|
3855
|
-
.B
|
|
4088
|
+
.B describe folder get
|
|
3856
4089
|
Get a folder from a collection
|
|
3857
4090
|
|
|
3858
|
-
.SS "
|
|
4091
|
+
.SS "describe folder get"
|
|
3859
4092
|
Get a folder from a collection
|
|
3860
4093
|
|
|
3861
4094
|
.B Usage:
|
|
@@ -3869,7 +4102,7 @@ Folder ID
|
|
|
3869
4102
|
.B \-c, \-\-collection\-id <id>
|
|
3870
4103
|
Collection ID
|
|
3871
4104
|
|
|
3872
|
-
.SS "
|
|
4105
|
+
.SS "describe response"
|
|
3873
4106
|
Response commands
|
|
3874
4107
|
|
|
3875
4108
|
.B Usage:
|
|
@@ -3877,10 +4110,10 @@ Response commands
|
|
|
3877
4110
|
|
|
3878
4111
|
.B Subcommands:
|
|
3879
4112
|
.TP
|
|
3880
|
-
.B
|
|
4113
|
+
.B describe response get
|
|
3881
4114
|
Get a saved response example from a collection
|
|
3882
4115
|
|
|
3883
|
-
.SS "
|
|
4116
|
+
.SS "describe response get"
|
|
3884
4117
|
Get a saved response example from a collection
|
|
3885
4118
|
|
|
3886
4119
|
.B Usage:
|
|
@@ -3897,7 +4130,7 @@ Collection ID
|
|
|
3897
4130
|
.B \-r, \-\-request\-id <id>
|
|
3898
4131
|
Request ID
|
|
3899
4132
|
|
|
3900
|
-
.SS "
|
|
4133
|
+
.SS "describe workspace"
|
|
3901
4134
|
Workspace commands
|
|
3902
4135
|
|
|
3903
4136
|
.B Usage:
|
|
@@ -3905,10 +4138,10 @@ Workspace commands
|
|
|
3905
4138
|
|
|
3906
4139
|
.B Subcommands:
|
|
3907
4140
|
.TP
|
|
3908
|
-
.B
|
|
4141
|
+
.B describe workspace get
|
|
3909
4142
|
Get a workspace by ID
|
|
3910
4143
|
|
|
3911
|
-
.SS "
|
|
4144
|
+
.SS "describe workspace get"
|
|
3912
4145
|
Get a workspace by ID
|
|
3913
4146
|
|
|
3914
4147
|
.B Usage:
|
|
@@ -3919,7 +4152,7 @@ Get a workspace by ID
|
|
|
3919
4152
|
.B \-w, \-\-workspace\-id <id>
|
|
3920
4153
|
Workspace ID
|
|
3921
4154
|
|
|
3922
|
-
.SS "
|
|
4155
|
+
.SS "describe environment"
|
|
3923
4156
|
Environment commands
|
|
3924
4157
|
|
|
3925
4158
|
.B Usage:
|
|
@@ -3927,10 +4160,10 @@ Environment commands
|
|
|
3927
4160
|
|
|
3928
4161
|
.B Subcommands:
|
|
3929
4162
|
.TP
|
|
3930
|
-
.B
|
|
4163
|
+
.B describe environment get
|
|
3931
4164
|
Get a single environment by ID
|
|
3932
4165
|
|
|
3933
|
-
.SS "
|
|
4166
|
+
.SS "describe environment get"
|
|
3934
4167
|
Get a single environment by ID
|
|
3935
4168
|
|
|
3936
4169
|
.B Usage:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.62.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.62.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.62.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.62.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.62.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.62.0"
|
|
66
66
|
}
|
|
67
67
|
}
|