postman-cli 1.60.0 → 1.63.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/bin/postman.js +19 -0
- package/man/postman.1 +426 -53
- package/package.json +6 -6
package/bin/postman.js
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
|
+
const { constants } = require('os');
|
|
4
|
+
|
|
3
5
|
// Keep this wrapper alive while the native binary handles shutdown gracefully.
|
|
4
6
|
process.on('SIGINT', function () {});
|
|
5
7
|
process.on('SIGTERM', function () {});
|
|
@@ -10,5 +12,22 @@ try {
|
|
|
10
12
|
run(...process.argv.slice(2));
|
|
11
13
|
}
|
|
12
14
|
catch (error) {
|
|
15
|
+
// The CLI's exit codes are a documented contract (`postman init` returns 2 for
|
|
16
|
+
// ambiguous specs and 4 for a refusal, for instance), so the binary's own code has
|
|
17
|
+
// to survive this wrapper. execFileSync throws on any non-zero exit and carries
|
|
18
|
+
// the code as `status`; collapsing that to 1 made a recoverable refusal
|
|
19
|
+
// indistinguishable from a crash.
|
|
20
|
+
if (typeof error.status === 'number') {
|
|
21
|
+
process.exit(error.status);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
// A signalled child has no status. Report it the way a shell does.
|
|
25
|
+
if (error.signal) {
|
|
26
|
+
process.exit(128 + (constants.signals[error.signal] || 0));
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
// Spawning the binary failed outright (missing platform package, not executable).
|
|
30
|
+
// The message never reached the user before, leaving a silent exit 1.
|
|
31
|
+
process.stderr.write(`${error.message || error}\n`);
|
|
13
32
|
process.exit(1);
|
|
14
33
|
}
|
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-09-
|
|
1
|
+
.TH POSTMAN 1 "2026-09-23" "v1.63.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -94,7 +94,7 @@ Use the skills bundled with this CLI instead of fetching the latest
|
|
|
94
94
|
Which spec is authoritative, when more than one could be
|
|
95
95
|
.TP
|
|
96
96
|
.B \-\-visibility <status>
|
|
97
|
-
Create and bind a workspace non\-interactively (personal
|
|
97
|
+
Create and bind a workspace non\-interactively (personal, team)
|
|
98
98
|
.TP
|
|
99
99
|
.B \-\-no\-cloud
|
|
100
100
|
Skip the workspace step entirely
|
|
@@ -120,11 +120,21 @@ Exit codes:
|
|
|
120
120
|
|
|
121
121
|
Code 5 needs \-\-visibility: without it no workspace was requested, so nothing
|
|
122
122
|
can fail for not getting one. It does not mean re\-run init \- the local files
|
|
123
|
-
are already written.
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
123
|
+
are already written. A \-\-visibility that is not personal, team is code 5 on
|
|
124
|
+
every path, including \-\-json, CI and \-\-no\-cloud: none of them makes the value
|
|
125
|
+
usable, so none of them should report success for it.
|
|
126
|
+
|
|
127
|
+
Under \-\-json, read `exitCode`, `refusal`, `usageError` and `cloud` from the
|
|
128
|
+
payload rather than matching the messages on stderr. `refusal.kind` is one of
|
|
129
|
+
foreign\-postman\-dir, bound\-spec\-missing, spec\-hint\-unmatched. `usageError`
|
|
130
|
+
names the flag whose value init could not use. `cloud` says what happened to
|
|
131
|
+
the workspace step, including why it was skipped.
|
|
132
|
+
|
|
133
|
+
\-\-json with \-\-visibility creates the workspace, same as without it: stdout
|
|
134
|
+
carries the payload and everything meant for a person goes to stderr. It used
|
|
135
|
+
to skip the step and exit 0, so a missing `origin` remote or a failed bind
|
|
136
|
+
went unreported. Without \-\-visibility, \-\-json still skips \- there is nothing
|
|
137
|
+
to create and init may not prompt.
|
|
128
138
|
|
|
129
139
|
Examples:
|
|
130
140
|
$ postman init
|
|
@@ -145,6 +155,23 @@ Show the Postman account or guest session this CLI session is using.
|
|
|
145
155
|
.B \-\-json
|
|
146
156
|
Print current identity as machine\-readable JSON.
|
|
147
157
|
|
|
158
|
+
.SS "feedback"
|
|
159
|
+
Submit feedback about CLI usability, gaps, and improvement suggestions.
|
|
160
|
+
|
|
161
|
+
.B Usage:
|
|
162
|
+
[options] <text>
|
|
163
|
+
|
|
164
|
+
.B Options:
|
|
165
|
+
.TP
|
|
166
|
+
.B \-\-type <type>
|
|
167
|
+
Feedback type: cli_gap, improvement_suggestion, bug_report, feature_request, general (default: general)
|
|
168
|
+
.TP
|
|
169
|
+
.B \-\-context <context>
|
|
170
|
+
Command or feature context this feedback is about
|
|
171
|
+
.TP
|
|
172
|
+
.B \-\-json
|
|
173
|
+
Print result as machine\-readable JSON
|
|
174
|
+
|
|
148
175
|
.SS "update"
|
|
149
176
|
Update Postman CLI using the original installation method.
|
|
150
177
|
|
|
@@ -266,6 +293,12 @@ Score a Postman collection for AI readiness by ID, local file path, or local\-mo
|
|
|
266
293
|
.B collection get
|
|
267
294
|
Fetch a Postman collection in the V3 format and print it.
|
|
268
295
|
.TP
|
|
296
|
+
.B collection request
|
|
297
|
+
Add, update, or remove requests in a local v3 collection.
|
|
298
|
+
.TP
|
|
299
|
+
.B collection folder
|
|
300
|
+
Add, update, or remove folders in a local v3 collection.
|
|
301
|
+
.TP
|
|
269
302
|
.B collection list
|
|
270
303
|
List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
|
|
271
304
|
.TP
|
|
@@ -302,8 +335,8 @@ Examples:
|
|
|
302
335
|
Without \-\-workspace this writes postman/collections/<name>/.resources/definition.yaml
|
|
303
336
|
in the current directory, which must be a local Postman workspace (a directory holding
|
|
304
337
|
\&.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
|
-
|
|
338
|
+
publish with `postman workspace push`. Creating a collection in a workspace works with a
|
|
339
|
+
signed\-in credential or with the guest session `postman init` mints.
|
|
307
340
|
|
|
308
341
|
|
|
309
342
|
|
|
@@ -377,6 +410,282 @@ Eg. postman collection get 12345\-33823532ab9e41c9b6fd12d0fd459b8b
|
|
|
377
410
|
postman collection get 0123456789abcdef01234567 \-\-json
|
|
378
411
|
|
|
379
412
|
|
|
413
|
+
.SS "collection request"
|
|
414
|
+
Add, update, or remove requests in a local v3 collection.
|
|
415
|
+
|
|
416
|
+
.B Usage:
|
|
417
|
+
[options] [command]
|
|
418
|
+
|
|
419
|
+
.B Subcommands:
|
|
420
|
+
.TP
|
|
421
|
+
.B collection request add
|
|
422
|
+
Add an empty request to a local v3 collection (set its details later with `update`).
|
|
423
|
+
.TP
|
|
424
|
+
.B collection request update
|
|
425
|
+
Update a request in a v3 collection (only the fields you pass).
|
|
426
|
+
.TP
|
|
427
|
+
.B collection request rm
|
|
428
|
+
Remove a request (any type) from a v3 collection.
|
|
429
|
+
|
|
430
|
+
.SS "collection request add"
|
|
431
|
+
Add an empty request to a local v3 collection (set its details later with `update`).
|
|
432
|
+
|
|
433
|
+
.B Usage:
|
|
434
|
+
[options] [request\-name]
|
|
435
|
+
|
|
436
|
+
.B Options:
|
|
437
|
+
.TP
|
|
438
|
+
.B \-\-collection <id|name>
|
|
439
|
+
Target collection: name, directory, id, cloud id, or path. Required.
|
|
440
|
+
.TP
|
|
441
|
+
.B \-\-folder <id|name|path>
|
|
442
|
+
Folder within the collection, e.g. "Users/Admin". Defaults to the root.
|
|
443
|
+
.TP
|
|
444
|
+
.B \-\-type <type>
|
|
445
|
+
Request type: http, graphql, grpc, websocket, socketio. (default: http)
|
|
446
|
+
.TP
|
|
447
|
+
.B \-w, \-\-workspace <id>
|
|
448
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
449
|
+
.TP
|
|
450
|
+
.B \-\-json
|
|
451
|
+
JSON output.
|
|
452
|
+
|
|
453
|
+
.TP Examples:
|
|
454
|
+
|
|
455
|
+
Creates an empty request (name + type only). Configure it with `collection request update`.
|
|
456
|
+
|
|
457
|
+
Examples:
|
|
458
|
+
postman collection request add "Get user" \-\-collection "My API"
|
|
459
|
+
postman collection request add \-\-collection "My API" # named "New request"
|
|
460
|
+
postman collection request add "List" \-\-collection "My API" \-\-folder Users \-\-type http
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
.SS "collection request update"
|
|
465
|
+
Update a request in a v3 collection (only the fields you pass).
|
|
466
|
+
|
|
467
|
+
.B Usage:
|
|
468
|
+
[options] <request>
|
|
469
|
+
|
|
470
|
+
.B Options:
|
|
471
|
+
.TP
|
|
472
|
+
.B \-\-collection <id|name>
|
|
473
|
+
Target collection: name, directory, id, cloud id, or path (cloud: id only). Required.
|
|
474
|
+
.TP
|
|
475
|
+
.B \-\-folder <id|name|path>
|
|
476
|
+
Folder to scope the request selector, e.g. "Users/Admin" (local: name/path; cloud: id).
|
|
477
|
+
.TP
|
|
478
|
+
.B \-\-rename <name>
|
|
479
|
+
Rename the request (moves its file). Any request type.
|
|
480
|
+
.TP
|
|
481
|
+
.B \-\-url <url>
|
|
482
|
+
Request URL. Any request type.
|
|
483
|
+
.TP
|
|
484
|
+
.B \-\-method <method>
|
|
485
|
+
HTTP method (http requests only).
|
|
486
|
+
.TP
|
|
487
|
+
.B \-\-param <key:value>
|
|
488
|
+
Replace query parameters. Repeatable (http requests only). (default: )
|
|
489
|
+
.TP
|
|
490
|
+
.B \-d, \-\-body <body>
|
|
491
|
+
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.
|
|
492
|
+
.TP
|
|
493
|
+
.B \-\-variables <json>
|
|
494
|
+
GraphQL variables JSON (graphql requests only).
|
|
495
|
+
.TP
|
|
496
|
+
.B \-\-description <text>
|
|
497
|
+
Request description.
|
|
498
|
+
.TP
|
|
499
|
+
.B \-\-headers <key:value>
|
|
500
|
+
Replace request headers. Repeatable; any request type with headers. (default: )
|
|
501
|
+
.TP
|
|
502
|
+
.B \-\-auth <spec>
|
|
503
|
+
Request auth: none, inherit, bearer:TOKEN, basic:USER:PASS, apikey:KEY:VALUE[:header|query], oauth2:TOKEN. Any request type.
|
|
504
|
+
.TP
|
|
505
|
+
.B \-\-scripts <event:script>
|
|
506
|
+
Replace scripts. event is prerequest or test; script is @file, \- for stdin, or inline. Repeatable; any request type. (default: )
|
|
507
|
+
.TP
|
|
508
|
+
.B \-w, \-\-workspace <id>
|
|
509
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
510
|
+
.TP
|
|
511
|
+
.B \-\-type <type>
|
|
512
|
+
Request type for cloud mode: http, graphql, grpc, websocket, socketio. (default: http)
|
|
513
|
+
.TP
|
|
514
|
+
.B \-\-json
|
|
515
|
+
JSON output.
|
|
516
|
+
|
|
517
|
+
.TP Examples:
|
|
518
|
+
|
|
519
|
+
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.
|
|
520
|
+
|
|
521
|
+
Examples:
|
|
522
|
+
postman collection request update "Get user" \-\-collection "My API" \-\-url "{{baseUrl}}/users/:id"
|
|
523
|
+
postman collection request update "Get user" \-\-collection "My API" \-\-folder Users \-\-rename "Fetch user"
|
|
524
|
+
postman collection request update "Get user" \-\-collection "My API" \-\-headers "Authorization:Bearer x" \-\-auth bearer:TOKEN \-\-scripts "test:@check.js"
|
|
525
|
+
postman collection request update <requestId> \-\-collection <collectionId> \-\-url "..." \-w <workspaceId>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
.SS "collection request rm"
|
|
530
|
+
Remove a request (any type) from a v3 collection.
|
|
531
|
+
|
|
532
|
+
.B Usage:
|
|
533
|
+
[options] <request>
|
|
534
|
+
|
|
535
|
+
.B Options:
|
|
536
|
+
.TP
|
|
537
|
+
.B \-\-collection <id|name>
|
|
538
|
+
Target collection: name, directory, id, cloud id, or path (cloud: id only). Required.
|
|
539
|
+
.TP
|
|
540
|
+
.B \-\-folder <id|name|path>
|
|
541
|
+
Folder to scope the request selector, e.g. "Users/Admin" (local: name/path; cloud: id).
|
|
542
|
+
.TP
|
|
543
|
+
.B \-w, \-\-workspace <id>
|
|
544
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
545
|
+
.TP
|
|
546
|
+
.B \-\-type <type>
|
|
547
|
+
Request type for cloud mode: http, graphql, grpc, websocket, socketio. (default: http)
|
|
548
|
+
.TP
|
|
549
|
+
.B \-\-json
|
|
550
|
+
JSON output.
|
|
551
|
+
|
|
552
|
+
.TP Examples:
|
|
553
|
+
|
|
554
|
+
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.
|
|
555
|
+
|
|
556
|
+
Examples:
|
|
557
|
+
postman collection request rm "Get user" \-\-collection "My API"
|
|
558
|
+
postman collection request rm "Get user" \-\-collection "My API" \-\-folder Users
|
|
559
|
+
postman collection request rm <requestId> \-\-collection <collectionId> \-w <workspaceId>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
.SS "collection folder"
|
|
564
|
+
Add, update, or remove folders in a local v3 collection.
|
|
565
|
+
|
|
566
|
+
.B Usage:
|
|
567
|
+
[options] [command]
|
|
568
|
+
|
|
569
|
+
.B Subcommands:
|
|
570
|
+
.TP
|
|
571
|
+
.B collection folder add
|
|
572
|
+
Add an empty folder to a local v3 collection (set its details later with `update`).
|
|
573
|
+
.TP
|
|
574
|
+
.B collection folder update
|
|
575
|
+
Update a folder in a v3 collection (only the fields you pass).
|
|
576
|
+
.TP
|
|
577
|
+
.B collection folder rm
|
|
578
|
+
Remove a folder from a v3 collection (recursive: removes everything inside it).
|
|
579
|
+
|
|
580
|
+
.SS "collection folder add"
|
|
581
|
+
Add an empty folder to a local v3 collection (set its details later with `update`).
|
|
582
|
+
|
|
583
|
+
.B Usage:
|
|
584
|
+
[options] [folder\-name]
|
|
585
|
+
|
|
586
|
+
.B Options:
|
|
587
|
+
.TP
|
|
588
|
+
.B \-\-collection <id|name>
|
|
589
|
+
Target collection: name, directory, id, cloud id, or path. Required.
|
|
590
|
+
.TP
|
|
591
|
+
.B \-\-folder <id|name|path>
|
|
592
|
+
Parent folder within the collection, e.g. "Users/Admin". Defaults to the root.
|
|
593
|
+
.TP
|
|
594
|
+
.B \-w, \-\-workspace <id>
|
|
595
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
596
|
+
.TP
|
|
597
|
+
.B \-\-json
|
|
598
|
+
JSON output.
|
|
599
|
+
|
|
600
|
+
.TP Examples:
|
|
601
|
+
|
|
602
|
+
Creates an empty folder (name only); set its description with `collection folder update`. Nest it with \-\-folder.
|
|
603
|
+
|
|
604
|
+
Examples:
|
|
605
|
+
postman collection folder add Users \-\-collection "My API"
|
|
606
|
+
postman collection folder add \-\-collection "My API" # named "New folder"
|
|
607
|
+
postman collection folder add Admin \-\-collection "My API" \-\-folder Users
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
.SS "collection folder update"
|
|
612
|
+
Update a folder in a v3 collection (only the fields you pass).
|
|
613
|
+
|
|
614
|
+
.B Usage:
|
|
615
|
+
[options] <folder>
|
|
616
|
+
|
|
617
|
+
.B Options:
|
|
618
|
+
.TP
|
|
619
|
+
.B \-\-collection <id|name>
|
|
620
|
+
Target collection: name, directory, id, cloud id, or path (cloud: id only). Required.
|
|
621
|
+
.TP
|
|
622
|
+
.B \-\-folder <id|name|path>
|
|
623
|
+
Parent folder to scope the selector, e.g. "Users" (local: name/path; cloud: id).
|
|
624
|
+
.TP
|
|
625
|
+
.B \-\-name <name>
|
|
626
|
+
Rename the folder (moves its directory).
|
|
627
|
+
.TP
|
|
628
|
+
.B \-\-description <text>
|
|
629
|
+
Folder description.
|
|
630
|
+
.TP
|
|
631
|
+
.B \-\-auth <spec>
|
|
632
|
+
Folder auth: none, inherit, bearer:TOKEN, basic:USER:PASS, apikey:KEY:VALUE[:header|query], oauth2:TOKEN.
|
|
633
|
+
.TP
|
|
634
|
+
.B \-\-scripts <event:script>
|
|
635
|
+
Replace folder scripts. event is prerequest or test; script is @file, \- for stdin, or inline. Repeatable. (default: )
|
|
636
|
+
.TP
|
|
637
|
+
.B \-w, \-\-workspace <id>
|
|
638
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
639
|
+
.TP
|
|
640
|
+
.B \-\-json
|
|
641
|
+
JSON output.
|
|
642
|
+
|
|
643
|
+
.TP Examples:
|
|
644
|
+
|
|
645
|
+
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 too.
|
|
646
|
+
|
|
647
|
+
Examples:
|
|
648
|
+
postman collection folder update Users \-\-collection "My API" \-\-name Accounts
|
|
649
|
+
postman collection folder update "Users/Admin" \-\-collection "My API" \-\-description "Admin endpoints"
|
|
650
|
+
postman collection folder update Admin \-\-collection "My API" \-\-folder Users \-\-auth bearer:TOKEN
|
|
651
|
+
postman collection folder update <folderId> \-\-collection <collectionId> \-\-name Accounts \-w <workspaceId>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
.SS "collection folder rm"
|
|
656
|
+
Remove a folder from a v3 collection (recursive: removes everything inside it).
|
|
657
|
+
|
|
658
|
+
.B Usage:
|
|
659
|
+
[options] <folder>
|
|
660
|
+
|
|
661
|
+
.B Options:
|
|
662
|
+
.TP
|
|
663
|
+
.B \-\-collection <id|name>
|
|
664
|
+
Target collection: name, directory, id, cloud id, or path (cloud: id only). Required.
|
|
665
|
+
.TP
|
|
666
|
+
.B \-\-folder <id|name|path>
|
|
667
|
+
Parent folder to scope the selector, e.g. "Users" (local: name/path; cloud: id).
|
|
668
|
+
.TP
|
|
669
|
+
.B \-y, \-\-yes
|
|
670
|
+
Skip the confirmation prompt (required when stdout is not a TTY).
|
|
671
|
+
.TP
|
|
672
|
+
.B \-w, \-\-workspace <id>
|
|
673
|
+
Target a Postman cloud workspace by id (cloud mode).
|
|
674
|
+
.TP
|
|
675
|
+
.B \-\-json
|
|
676
|
+
JSON output.
|
|
677
|
+
|
|
678
|
+
.TP Examples:
|
|
679
|
+
|
|
680
|
+
Removal is recursive. 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 too.
|
|
681
|
+
|
|
682
|
+
Examples:
|
|
683
|
+
postman collection folder rm Users \-\-collection "My API" \-\-yes
|
|
684
|
+
postman collection folder rm "Users/Admin" \-\-collection "My API" \-y
|
|
685
|
+
postman collection folder rm <folderId> \-\-collection <collectionId> \-y \-w <workspaceId>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
380
689
|
.SS "collection list"
|
|
381
690
|
List collections: your local project's collections by default, or a Postman cloud workspace's collections with \-\-workspace.
|
|
382
691
|
|
|
@@ -1358,7 +1667,7 @@ Invoke a monitor run and display results.
|
|
|
1358
1667
|
.B Options:
|
|
1359
1668
|
.TP
|
|
1360
1669
|
.B \-\-api\-key <key>
|
|
1361
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1670
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1362
1671
|
.TP
|
|
1363
1672
|
.B \-x, \-\-suppress\-exit\-code
|
|
1364
1673
|
Specify whether or not to override the default exit code for the current run
|
|
@@ -1444,7 +1753,7 @@ How iteration data is consumed, for example round_robin, repeat_last or stop_at_
|
|
|
1444
1753
|
Do not trigger an immediate run after creating the monitor
|
|
1445
1754
|
.TP
|
|
1446
1755
|
.B \-\-api\-key <key>
|
|
1447
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1756
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1448
1757
|
.TP
|
|
1449
1758
|
.B \-\-json
|
|
1450
1759
|
Output as JSON instead of a table
|
|
@@ -1528,7 +1837,7 @@ Number of iterations to run
|
|
|
1528
1837
|
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
1838
|
.TP
|
|
1530
1839
|
.B \-\-api\-key <key>
|
|
1531
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1840
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1532
1841
|
.TP
|
|
1533
1842
|
.B \-\-json
|
|
1534
1843
|
Output as JSON instead of a table
|
|
@@ -1557,7 +1866,7 @@ Permanently delete a monitor. Prompts for confirmation unless \-\-yes is passed.
|
|
|
1557
1866
|
Skip the confirmation prompt
|
|
1558
1867
|
.TP
|
|
1559
1868
|
.B \-\-api\-key <key>
|
|
1560
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1869
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1561
1870
|
.TP
|
|
1562
1871
|
.B \-\-json
|
|
1563
1872
|
Output the outcome, including any failure, as JSON instead of a plain message
|
|
@@ -1668,7 +1977,7 @@ List the monitors visible to you.
|
|
|
1668
1977
|
.B Options:
|
|
1669
1978
|
.TP
|
|
1670
1979
|
.B \-\-api\-key <key>
|
|
1671
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
1980
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1672
1981
|
.TP
|
|
1673
1982
|
.B \-w, \-\-workspace <id>
|
|
1674
1983
|
Filter to monitors in this workspace
|
|
@@ -1731,7 +2040,7 @@ Show a monitor's configuration.
|
|
|
1731
2040
|
.B Options:
|
|
1732
2041
|
.TP
|
|
1733
2042
|
.B \-\-api\-key <key>
|
|
1734
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
2043
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1735
2044
|
.TP
|
|
1736
2045
|
.B \-\-json
|
|
1737
2046
|
Output as JSON instead of a table
|
|
@@ -1751,7 +2060,7 @@ Show per\-request latency and outcome history for a monitor.
|
|
|
1751
2060
|
.B Options:
|
|
1752
2061
|
.TP
|
|
1753
2062
|
.B \-\-api\-key <key>
|
|
1754
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
2063
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1755
2064
|
.TP
|
|
1756
2065
|
.B \-\-since <dateTime>
|
|
1757
2066
|
Only executions at or after this ISO 8601 date\-time (defaults to 7 days ago)
|
|
@@ -1785,7 +2094,7 @@ Pause a monitor, so it stops firing on schedule.
|
|
|
1785
2094
|
.B Options:
|
|
1786
2095
|
.TP
|
|
1787
2096
|
.B \-\-api\-key <key>
|
|
1788
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
2097
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1789
2098
|
.TP
|
|
1790
2099
|
.B \-\-json
|
|
1791
2100
|
Output as JSON instead of a table
|
|
@@ -1799,7 +2108,7 @@ Resume a paused monitor, so it fires on schedule again.
|
|
|
1799
2108
|
.B Options:
|
|
1800
2109
|
.TP
|
|
1801
2110
|
.B \-\-api\-key <key>
|
|
1802
|
-
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)
|
|
2111
|
+
Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)
|
|
1803
2112
|
.TP
|
|
1804
2113
|
.B \-\-json
|
|
1805
2114
|
Output as JSON instead of a table
|
|
@@ -1969,7 +2278,7 @@ Create a Postman workspace and bind it to this git repository.
|
|
|
1969
2278
|
.B Options:
|
|
1970
2279
|
.TP
|
|
1971
2280
|
.B \-\-visibility <status>
|
|
1972
|
-
Required.
|
|
2281
|
+
Required. One of: personal, private, team, public, partner.
|
|
1973
2282
|
.TP
|
|
1974
2283
|
.B \-\-name <name>
|
|
1975
2284
|
Workspace name (defaults to owner/repo from the git remote)
|
|
@@ -1977,6 +2286,12 @@ Workspace name (defaults to owner/repo from the git remote)
|
|
|
1977
2286
|
.B \-\-summary <text>
|
|
1978
2287
|
Optional workspace summary
|
|
1979
2288
|
.TP
|
|
2289
|
+
.B \-\-team\-id <id>
|
|
2290
|
+
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`.
|
|
2291
|
+
.TP
|
|
2292
|
+
.B \-\-team\-role <level>
|
|
2293
|
+
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.
|
|
2294
|
+
.TP
|
|
1980
2295
|
.B \-\-path <dir>
|
|
1981
2296
|
Directory to bind (defaults to the current directory)
|
|
1982
2297
|
.TP
|
|
@@ -1988,12 +2303,15 @@ Create even when a workspace is already recorded for this repo
|
|
|
1988
2303
|
|
|
1989
2304
|
.TP Examples:
|
|
1990
2305
|
|
|
1991
|
-
Requires a login (`postman login`) or POSTMAN_API_KEY.
|
|
2306
|
+
Requires a login (`postman login`) or POSTMAN_API_KEY. A guest session
|
|
2307
|
+
has no account to own a workspace: run `postman signup` first.
|
|
1992
2308
|
Refuses to run on CI: create once locally and commit the binding.
|
|
1993
2309
|
|
|
1994
2310
|
Examples:
|
|
1995
2311
|
$ postman workspace create \-\-visibility personal
|
|
1996
2312
|
$ postman workspace create \-\-visibility team \-\-name "acme/orders"
|
|
2313
|
+
$ postman workspace create \-\-visibility team \-\-team\-id 451
|
|
2314
|
+
$ postman workspace create \-\-visibility team \-\-team\-role view
|
|
1997
2315
|
$ postman workspace create \-\-visibility personal \-\-no\-connect
|
|
1998
2316
|
|
|
1999
2317
|
|
|
@@ -2090,6 +2408,58 @@ Examples:
|
|
|
2090
2408
|
|
|
2091
2409
|
|
|
2092
2410
|
|
|
2411
|
+
.SS "team"
|
|
2412
|
+
Work with the teams inside your organisation.
|
|
2413
|
+
|
|
2414
|
+
.B Usage:
|
|
2415
|
+
[options] [command]
|
|
2416
|
+
|
|
2417
|
+
.TP Examples:
|
|
2418
|
+
|
|
2419
|
+
These are the teams inside an organisation, which the Postman app shows
|
|
2420
|
+
under "Teams". The organisation itself is what `postman whoami` reports
|
|
2421
|
+
as your team. A Postman team that is not an organisation has none.
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
.B Subcommands:
|
|
2426
|
+
.TP
|
|
2427
|
+
.B team list
|
|
2428
|
+
List the teams inside your organisation.
|
|
2429
|
+
|
|
2430
|
+
.SS "team list"
|
|
2431
|
+
List the teams inside your organisation.
|
|
2432
|
+
|
|
2433
|
+
.B Usage:
|
|
2434
|
+
[options]
|
|
2435
|
+
|
|
2436
|
+
.B Options:
|
|
2437
|
+
.TP
|
|
2438
|
+
.B \-\-can\-create\-workspace
|
|
2439
|
+
Only list teams you could create a workspace in.
|
|
2440
|
+
.TP
|
|
2441
|
+
.B \-\-json
|
|
2442
|
+
Print the list as machine\-readable JSON.
|
|
2443
|
+
.TP
|
|
2444
|
+
.B \-\-timeout <ms>
|
|
2445
|
+
Abort the run after this many milliseconds. Defaults to 30000.
|
|
2446
|
+
|
|
2447
|
+
.TP Examples:
|
|
2448
|
+
|
|
2449
|
+
Requires a login (`postman login`) or POSTMAN_API_KEY.
|
|
2450
|
+
These are the teams inside your organisation. The organisation itself is
|
|
2451
|
+
what `postman whoami` reports as your team. `postman workspace create
|
|
2452
|
+
\-\-team\-id <id>` takes the id from this list.
|
|
2453
|
+
|
|
2454
|
+
A Postman team that is not an organisation has no teams inside it, so this
|
|
2455
|
+
lists nothing and exits 0.
|
|
2456
|
+
|
|
2457
|
+
Examples:
|
|
2458
|
+
$ postman team list
|
|
2459
|
+
$ postman team list \-\-can\-create\-workspace
|
|
2460
|
+
$ postman team list \-\-json
|
|
2461
|
+
|
|
2462
|
+
|
|
2093
2463
|
.SS "performance"
|
|
2094
2464
|
Manage performance tests on your collections.
|
|
2095
2465
|
|
|
@@ -2148,6 +2518,9 @@ How rows map to VUs: round\-robin (default), fixed, random
|
|
|
2148
2518
|
.B \-\-postman\-api\-key <apiKey>
|
|
2149
2519
|
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
2520
|
.TP
|
|
2521
|
+
.B \-\-output <format>
|
|
2522
|
+
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)
|
|
2523
|
+
.TP
|
|
2151
2524
|
.B \-\-runner <runner>
|
|
2152
2525
|
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
2526
|
.TP
|
|
@@ -3330,7 +3703,7 @@ Start a mock using its path if it lives in your repository, or its id if it live
|
|
|
3330
3703
|
.B Options:
|
|
3331
3704
|
.TP
|
|
3332
3705
|
.B \-e, \-\-environment <path>
|
|
3333
|
-
Path to a file of environment variables for the mock. Relative or absolute, e.g. ./postman/environments/dev.
|
|
3706
|
+
Path to a file of environment variables for the mock. Relative or absolute, e.g. ./postman/environments/dev.environment.yaml
|
|
3334
3707
|
.TP
|
|
3335
3708
|
.B \-g, \-\-globals <path>
|
|
3336
3709
|
Path to a file of global variables for the mock. Relative or absolute, e.g. ./globals.json
|
|
@@ -3345,7 +3718,7 @@ Postman API key, used with a Postman cloud id (defaults to your `postman login`
|
|
|
3345
3718
|
|
|
3346
3719
|
Eg. postman mock run 12345678\-90ab\-cdef\-1234\-567890abcdef # by id, from Postman cloud
|
|
3347
3720
|
postman mock run ./postman/mocks/orders # by path, from your repository
|
|
3348
|
-
postman mock run ./postman/mocks/orders \-\-environment ./postman/environments/dev.
|
|
3721
|
+
postman mock run ./postman/mocks/orders \-\-environment ./postman/environments/dev.environment.yaml
|
|
3349
3722
|
postman mock run ./postman/mocks/orders \-\-port auto # pick any free port
|
|
3350
3723
|
postman mock run ./postman/mocks/orders \-\-port 4600 # use port 4600 (fails if it is in use)
|
|
3351
3724
|
|
|
@@ -3710,7 +4083,7 @@ Start mocks with fault\-injection scenarios defined in a .sim.yaml file
|
|
|
3710
4083
|
.B Usage:
|
|
3711
4084
|
[options] <filepath>
|
|
3712
4085
|
|
|
3713
|
-
.SS "
|
|
4086
|
+
.SS "describe"
|
|
3714
4087
|
[Beta] Get API context for AI coding agents directly from the command line.
|
|
3715
4088
|
|
|
3716
4089
|
|
|
@@ -3719,7 +4092,7 @@ Start mocks with fault\-injection scenarios defined in a .sim.yaml file
|
|
|
3719
4092
|
|
|
3720
4093
|
.B Subcommands:
|
|
3721
4094
|
.TP
|
|
3722
|
-
.B
|
|
4095
|
+
.B describe instructions
|
|
3723
4096
|
Get agent instructions for using Postman Context with AI coding agents.
|
|
3724
4097
|
|
|
3725
4098
|
Topics:
|
|
@@ -3729,25 +4102,25 @@ Topics:
|
|
|
3729
4102
|
maintenance — Agent instructions for maintaining and updating client code
|
|
3730
4103
|
|
|
3731
4104
|
.TP
|
|
3732
|
-
.B
|
|
4105
|
+
.B describe collection
|
|
3733
4106
|
Collection commands
|
|
3734
4107
|
.TP
|
|
3735
|
-
.B
|
|
4108
|
+
.B describe request
|
|
3736
4109
|
Request commands
|
|
3737
4110
|
.TP
|
|
3738
|
-
.B
|
|
4111
|
+
.B describe folder
|
|
3739
4112
|
Folder commands
|
|
3740
4113
|
.TP
|
|
3741
|
-
.B
|
|
4114
|
+
.B describe response
|
|
3742
4115
|
Response commands
|
|
3743
4116
|
.TP
|
|
3744
|
-
.B
|
|
4117
|
+
.B describe workspace
|
|
3745
4118
|
Workspace commands
|
|
3746
4119
|
.TP
|
|
3747
|
-
.B
|
|
4120
|
+
.B describe environment
|
|
3748
4121
|
Environment commands
|
|
3749
4122
|
|
|
3750
|
-
.SS "
|
|
4123
|
+
.SS "describe instructions"
|
|
3751
4124
|
Get agent instructions for using Postman Context with AI coding agents.
|
|
3752
4125
|
|
|
3753
4126
|
Topics:
|
|
@@ -3760,7 +4133,7 @@ Topics:
|
|
|
3760
4133
|
.B Usage:
|
|
3761
4134
|
[options] [topic]
|
|
3762
4135
|
|
|
3763
|
-
.SS "
|
|
4136
|
+
.SS "describe collection"
|
|
3764
4137
|
Collection commands
|
|
3765
4138
|
|
|
3766
4139
|
.B Usage:
|
|
@@ -3768,13 +4141,13 @@ Collection commands
|
|
|
3768
4141
|
|
|
3769
4142
|
.B Subcommands:
|
|
3770
4143
|
.TP
|
|
3771
|
-
.B
|
|
4144
|
+
.B describe collection get
|
|
3772
4145
|
Get a collection's metadata and a map of its folders and requests.
|
|
3773
4146
|
|
|
3774
4147
|
Returns collection info (name, description, variables, auth) plus a
|
|
3775
4148
|
recursive tree of folders and requests.
|
|
3776
4149
|
|
|
3777
|
-
.SS "
|
|
4150
|
+
.SS "describe collection get"
|
|
3778
4151
|
Get a collection's metadata and a map of its folders and requests.
|
|
3779
4152
|
|
|
3780
4153
|
Returns collection info (name, description, variables, auth) plus a
|
|
@@ -3788,7 +4161,7 @@ recursive tree of folders and requests.
|
|
|
3788
4161
|
.B \-c, \-\-collection\-id <id>
|
|
3789
4162
|
Collection ID
|
|
3790
4163
|
|
|
3791
|
-
.SS "
|
|
4164
|
+
.SS "describe request"
|
|
3792
4165
|
Request commands
|
|
3793
4166
|
|
|
3794
4167
|
.B Usage:
|
|
@@ -3796,10 +4169,10 @@ Request commands
|
|
|
3796
4169
|
|
|
3797
4170
|
.B Subcommands:
|
|
3798
4171
|
.TP
|
|
3799
|
-
.B
|
|
4172
|
+
.B describe request get
|
|
3800
4173
|
Get a request from a collection
|
|
3801
4174
|
.TP
|
|
3802
|
-
.B
|
|
4175
|
+
.B describe request context
|
|
3803
4176
|
Fetch all context about a request and return it as a Markdown document.
|
|
3804
4177
|
|
|
3805
4178
|
Returns: collection metadata, request details (method, URL, headers, body,
|
|
@@ -3807,9 +4180,9 @@ auth, docs), parent folder documentation, response examples, and
|
|
|
3807
4180
|
environment variables.
|
|
3808
4181
|
|
|
3809
4182
|
Examples:
|
|
3810
|
-
postman
|
|
4183
|
+
postman describe request context \-c <collection\-id> \-r <request\-id>
|
|
3811
4184
|
|
|
3812
|
-
.SS "
|
|
4185
|
+
.SS "describe request get"
|
|
3813
4186
|
Get a request from a collection
|
|
3814
4187
|
|
|
3815
4188
|
.B Usage:
|
|
@@ -3823,7 +4196,7 @@ Request ID
|
|
|
3823
4196
|
.B \-c, \-\-collection\-id <id>
|
|
3824
4197
|
Collection ID
|
|
3825
4198
|
|
|
3826
|
-
.SS "
|
|
4199
|
+
.SS "describe request context"
|
|
3827
4200
|
Fetch all context about a request and return it as a Markdown document.
|
|
3828
4201
|
|
|
3829
4202
|
Returns: collection metadata, request details (method, URL, headers, body,
|
|
@@ -3831,7 +4204,7 @@ auth, docs), parent folder documentation, response examples, and
|
|
|
3831
4204
|
environment variables.
|
|
3832
4205
|
|
|
3833
4206
|
Examples:
|
|
3834
|
-
postman
|
|
4207
|
+
postman describe request context \-c <collection\-id> \-r <request\-id>
|
|
3835
4208
|
|
|
3836
4209
|
.B Usage:
|
|
3837
4210
|
[options]
|
|
@@ -3844,7 +4217,7 @@ Collection ID
|
|
|
3844
4217
|
.B \-r, \-\-request\-id <id>
|
|
3845
4218
|
Request ID
|
|
3846
4219
|
|
|
3847
|
-
.SS "
|
|
4220
|
+
.SS "describe folder"
|
|
3848
4221
|
Folder commands
|
|
3849
4222
|
|
|
3850
4223
|
.B Usage:
|
|
@@ -3852,10 +4225,10 @@ Folder commands
|
|
|
3852
4225
|
|
|
3853
4226
|
.B Subcommands:
|
|
3854
4227
|
.TP
|
|
3855
|
-
.B
|
|
4228
|
+
.B describe folder get
|
|
3856
4229
|
Get a folder from a collection
|
|
3857
4230
|
|
|
3858
|
-
.SS "
|
|
4231
|
+
.SS "describe folder get"
|
|
3859
4232
|
Get a folder from a collection
|
|
3860
4233
|
|
|
3861
4234
|
.B Usage:
|
|
@@ -3869,7 +4242,7 @@ Folder ID
|
|
|
3869
4242
|
.B \-c, \-\-collection\-id <id>
|
|
3870
4243
|
Collection ID
|
|
3871
4244
|
|
|
3872
|
-
.SS "
|
|
4245
|
+
.SS "describe response"
|
|
3873
4246
|
Response commands
|
|
3874
4247
|
|
|
3875
4248
|
.B Usage:
|
|
@@ -3877,10 +4250,10 @@ Response commands
|
|
|
3877
4250
|
|
|
3878
4251
|
.B Subcommands:
|
|
3879
4252
|
.TP
|
|
3880
|
-
.B
|
|
4253
|
+
.B describe response get
|
|
3881
4254
|
Get a saved response example from a collection
|
|
3882
4255
|
|
|
3883
|
-
.SS "
|
|
4256
|
+
.SS "describe response get"
|
|
3884
4257
|
Get a saved response example from a collection
|
|
3885
4258
|
|
|
3886
4259
|
.B Usage:
|
|
@@ -3897,7 +4270,7 @@ Collection ID
|
|
|
3897
4270
|
.B \-r, \-\-request\-id <id>
|
|
3898
4271
|
Request ID
|
|
3899
4272
|
|
|
3900
|
-
.SS "
|
|
4273
|
+
.SS "describe workspace"
|
|
3901
4274
|
Workspace commands
|
|
3902
4275
|
|
|
3903
4276
|
.B Usage:
|
|
@@ -3905,10 +4278,10 @@ Workspace commands
|
|
|
3905
4278
|
|
|
3906
4279
|
.B Subcommands:
|
|
3907
4280
|
.TP
|
|
3908
|
-
.B
|
|
4281
|
+
.B describe workspace get
|
|
3909
4282
|
Get a workspace by ID
|
|
3910
4283
|
|
|
3911
|
-
.SS "
|
|
4284
|
+
.SS "describe workspace get"
|
|
3912
4285
|
Get a workspace by ID
|
|
3913
4286
|
|
|
3914
4287
|
.B Usage:
|
|
@@ -3919,7 +4292,7 @@ Get a workspace by ID
|
|
|
3919
4292
|
.B \-w, \-\-workspace\-id <id>
|
|
3920
4293
|
Workspace ID
|
|
3921
4294
|
|
|
3922
|
-
.SS "
|
|
4295
|
+
.SS "describe environment"
|
|
3923
4296
|
Environment commands
|
|
3924
4297
|
|
|
3925
4298
|
.B Usage:
|
|
@@ -3927,10 +4300,10 @@ Environment commands
|
|
|
3927
4300
|
|
|
3928
4301
|
.B Subcommands:
|
|
3929
4302
|
.TP
|
|
3930
|
-
.B
|
|
4303
|
+
.B describe environment get
|
|
3931
4304
|
Get a single environment by ID
|
|
3932
4305
|
|
|
3933
|
-
.SS "
|
|
4306
|
+
.SS "describe environment get"
|
|
3934
4307
|
Get a single environment by ID
|
|
3935
4308
|
|
|
3936
4309
|
.B Usage:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.63.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.63.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.63.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.63.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.63.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.63.0"
|
|
66
66
|
}
|
|
67
67
|
}
|