postman-cli 1.41.2 → 1.44.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 +100 -19
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-07-
|
|
1
|
+
.TH POSTMAN 1 "2026-07-22" "v1.44.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -139,6 +139,9 @@ Specify an Id or path to a file containing Postman Globals
|
|
|
139
139
|
.B \-r, \-\-reporters [reporter]
|
|
140
140
|
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)
|
|
141
141
|
.TP
|
|
142
|
+
.B \-\-output <folder>
|
|
143
|
+
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.
|
|
144
|
+
.TP
|
|
142
145
|
.B \-\-reporter\-[reporter]\-export <path>
|
|
143
146
|
[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.
|
|
144
147
|
Type: string, Default value: null
|
|
@@ -267,7 +270,7 @@ Start a mock server from manifest (.json) file
|
|
|
267
270
|
Start mock servers with fault\-injection scenarios from a .sim.yaml file
|
|
268
271
|
.TP
|
|
269
272
|
.B \-\-report\-events
|
|
270
|
-
|
|
273
|
+
Send run results and analytics to Postman
|
|
271
274
|
|
|
272
275
|
.TP Examples:
|
|
273
276
|
Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
|
|
@@ -393,7 +396,7 @@ Enable the metrics server for health checks
|
|
|
393
396
|
Port for the metrics server (default: 9090)
|
|
394
397
|
.TP
|
|
395
398
|
.B \-\-report\-events
|
|
396
|
-
|
|
399
|
+
Send run events and analytics to Postman
|
|
397
400
|
|
|
398
401
|
.SS "spec"
|
|
399
402
|
Lint and validate Specifications from the command line
|
|
@@ -430,7 +433,7 @@ Output format for the results. [choices: "json", "csv"]
|
|
|
430
433
|
The workspace ID to use for fetching governance rulesets.
|
|
431
434
|
.TP
|
|
432
435
|
.B \-\-report\-events
|
|
433
|
-
|
|
436
|
+
Send lint results and analytics to Postman
|
|
434
437
|
|
|
435
438
|
.SS "spec ai\-readiness"
|
|
436
439
|
Score an OpenAPI specification for AI readiness by ID or local file path.
|
|
@@ -492,7 +495,7 @@ Manage workspace resources.
|
|
|
492
495
|
Prepare local collections and environments for push by validating and regenerating IDs if needed.
|
|
493
496
|
.TP
|
|
494
497
|
.B workspace push
|
|
495
|
-
Push local
|
|
498
|
+
Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.
|
|
496
499
|
|
|
497
500
|
.SS "workspace prepare"
|
|
498
501
|
Prepare local collections and environments for push by validating and regenerating IDs if needed.
|
|
@@ -502,40 +505,31 @@ Prepare local collections and environments for push by validating and regenerati
|
|
|
502
505
|
|
|
503
506
|
.B Options:
|
|
504
507
|
.TP
|
|
505
|
-
.B \-\-collections\-dir <path>
|
|
506
|
-
Path to the collections directory (default: postman/collections)
|
|
507
|
-
.TP
|
|
508
|
-
.B \-\-environments\-dir <path>
|
|
509
|
-
Path to the environments directory (default: postman/environments)
|
|
510
|
-
.TP
|
|
511
508
|
.B \-\-verbose
|
|
512
509
|
Show detailed logging
|
|
513
510
|
|
|
514
511
|
.SS "workspace push"
|
|
515
|
-
Push local
|
|
512
|
+
Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.
|
|
516
513
|
|
|
517
514
|
.B Usage:
|
|
518
515
|
[options]
|
|
519
516
|
|
|
520
517
|
.B Options:
|
|
521
518
|
.TP
|
|
522
|
-
.B \-\-collections\-dir <path>
|
|
523
|
-
Path to the collections directory (default: postman/collections)
|
|
524
|
-
.TP
|
|
525
|
-
.B \-\-environments\-dir <path>
|
|
526
|
-
Path to the environments directory (default: postman/environments)
|
|
527
|
-
.TP
|
|
528
519
|
.B \-\-no\-prepare
|
|
529
520
|
Skip ID validation and auto\-fix before pushing
|
|
530
521
|
.TP
|
|
531
522
|
.B \-y, \-\-yes
|
|
532
523
|
Skip all confirmation prompts
|
|
533
524
|
.TP
|
|
525
|
+
.B \-\-push\-strategy <strategy>
|
|
526
|
+
Push strategy. "force\-sync": mirror the whole workspace — also DELETE cloud entities that have no local counterpart (destructive). Defaults to "default" (create/update only).
|
|
527
|
+
.TP
|
|
534
528
|
.B \-\-verbose
|
|
535
529
|
Show detailed logging
|
|
536
530
|
.TP
|
|
537
531
|
.B \-\-report\-events
|
|
538
|
-
|
|
532
|
+
Send workspace push events to Postman
|
|
539
533
|
|
|
540
534
|
.SS "performance"
|
|
541
535
|
Manage performance tests on your collections.
|
|
@@ -2469,6 +2463,9 @@ Permanently delete a webhook.
|
|
|
2469
2463
|
.B webhook status
|
|
2470
2464
|
Show details for a webhook.
|
|
2471
2465
|
.TP
|
|
2466
|
+
.B webhook requests
|
|
2467
|
+
List, inspect, and replay requests received by a webhook.
|
|
2468
|
+
.TP
|
|
2472
2469
|
.B webhook forward
|
|
2473
2470
|
Forward incoming webhook requests to a local port.
|
|
2474
2471
|
|
|
@@ -2606,6 +2603,90 @@ Examples:
|
|
|
2606
2603
|
|
|
2607
2604
|
|
|
2608
2605
|
|
|
2606
|
+
.SS "webhook requests"
|
|
2607
|
+
List, inspect, and replay requests received by a webhook.
|
|
2608
|
+
|
|
2609
|
+
.B Usage:
|
|
2610
|
+
[options] [command]
|
|
2611
|
+
|
|
2612
|
+
.B Subcommands:
|
|
2613
|
+
.TP
|
|
2614
|
+
.B webhook requests list
|
|
2615
|
+
List recent requests received by a webhook.
|
|
2616
|
+
.TP
|
|
2617
|
+
.B webhook requests describe
|
|
2618
|
+
Show details for a request received by a webhook.
|
|
2619
|
+
.TP
|
|
2620
|
+
.B webhook requests replay
|
|
2621
|
+
Replay a request received by a webhook.
|
|
2622
|
+
|
|
2623
|
+
.SS "webhook requests list"
|
|
2624
|
+
List recent requests received by a webhook.
|
|
2625
|
+
|
|
2626
|
+
.B Usage:
|
|
2627
|
+
[options] <webhookId>
|
|
2628
|
+
|
|
2629
|
+
.B Options:
|
|
2630
|
+
.TP
|
|
2631
|
+
.B \-w, \-\-workspace <workspaceId>
|
|
2632
|
+
Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
|
|
2633
|
+
.TP
|
|
2634
|
+
.B \-\-cursor <cursor>
|
|
2635
|
+
Pagination cursor returned by a previous request list response
|
|
2636
|
+
.TP
|
|
2637
|
+
.B \-\-api\-key <key>
|
|
2638
|
+
Postman API key
|
|
2639
|
+
|
|
2640
|
+
.TP Examples:
|
|
2641
|
+
|
|
2642
|
+
Examples:
|
|
2643
|
+
postman webhook requests list 0123456789abcdefghijklmno
|
|
2644
|
+
postman webhook requests list 0123456789abcdefghijklmno \-\-workspace 00000000\-0000\-0000\-0000\-000000000000
|
|
2645
|
+
|
|
2646
|
+
|
|
2647
|
+
|
|
2648
|
+
.SS "webhook requests describe"
|
|
2649
|
+
Show details for a request received by a webhook.
|
|
2650
|
+
|
|
2651
|
+
.B Usage:
|
|
2652
|
+
[options] <webhookId> <requestId>
|
|
2653
|
+
|
|
2654
|
+
.B Options:
|
|
2655
|
+
.TP
|
|
2656
|
+
.B \-w, \-\-workspace <workspaceId>
|
|
2657
|
+
Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
|
|
2658
|
+
.TP
|
|
2659
|
+
.B \-\-api\-key <key>
|
|
2660
|
+
Postman API key
|
|
2661
|
+
|
|
2662
|
+
.TP Examples:
|
|
2663
|
+
|
|
2664
|
+
Examples:
|
|
2665
|
+
postman webhook requests describe 0123456789abcdefghijklmno 11111111\-1111\-4111\-8111\-111111111111
|
|
2666
|
+
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
.SS "webhook requests replay"
|
|
2670
|
+
Replay a request received by a webhook.
|
|
2671
|
+
|
|
2672
|
+
.B Usage:
|
|
2673
|
+
[options] <webhookId> <requestId>
|
|
2674
|
+
|
|
2675
|
+
.B Options:
|
|
2676
|
+
.TP
|
|
2677
|
+
.B \-w, \-\-workspace <workspaceId>
|
|
2678
|
+
Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
|
|
2679
|
+
.TP
|
|
2680
|
+
.B \-\-api\-key <key>
|
|
2681
|
+
Postman API key
|
|
2682
|
+
|
|
2683
|
+
.TP Examples:
|
|
2684
|
+
|
|
2685
|
+
Examples:
|
|
2686
|
+
postman webhook requests replay 0123456789abcdefghijklmno 11111111\-1111\-4111\-8111\-111111111111
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
|
|
2609
2690
|
.SS "webhook forward"
|
|
2610
2691
|
Forward incoming webhook requests to a local port.
|
|
2611
2692
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.44.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.44.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.44.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.44.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.44.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.44.0"
|
|
66
66
|
}
|
|
67
67
|
}
|