postman-cli 1.51.0 → 1.52.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 +74 -41
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-08-
|
|
1
|
+
.TH POSTMAN 1 "2026-08-28" "v1.52.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -269,14 +269,22 @@ Start a mock server from manifest (.json, .yaml or .yml) file
|
|
|
269
269
|
.B \-\-port <port>
|
|
270
270
|
Port for the \-\-mock server; pass "auto" for an OS\-assigned ephemeral port (default: configured port, falls back to an ephemeral one if busy). Only valid with \-\-mock.
|
|
271
271
|
.TP
|
|
272
|
+
.B \-\-use\-mock <mapping>
|
|
273
|
+
Redirect requests for a URL or {{variable}} to a mock during the run. Format: "<url> mock|mock\-server:<path|id> [scenario]". Repeat the flag to redirect multiple URLs (one \-\-use\-mock per mock). Use "mock:<path>" for a local mock manifest (.json/.yaml/.yml), "mock:<id>" for a local mock by id (fetched from the cloud then run locally), or "mock\-server:<id>" to redirect to a deployed mock server's URL. Id\-based references require `postman login` (or \-\-postman\-api\-key). The optional third field selects a scenario (defaults to "default"). (default: )
|
|
274
|
+
.TP
|
|
272
275
|
.B \-\-simulate <path>
|
|
273
276
|
Start mock servers with fault\-injection scenarios from a .sim.yaml file
|
|
274
277
|
.TP
|
|
275
278
|
.B \-\-report\-events
|
|
276
|
-
|
|
279
|
+
Upload results for git\-native v3 collection runs. Analytics are sent by default
|
|
280
|
+
.TP
|
|
281
|
+
.B \-\-no\-report\-events
|
|
282
|
+
Do not send analytics to Postman
|
|
277
283
|
|
|
278
284
|
.TP Examples:
|
|
279
285
|
Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
|
|
286
|
+
postman collection run <id> \-\-use\-mock "{{baseurl}} mock:./mock/config.yaml delay"
|
|
287
|
+
postman collection run <id> \-\-use\-mock "{{baseurl}} mock:./a.yaml" \-\-use\-mock "api.com mock\-server:9d8e7f6a"
|
|
280
288
|
|
|
281
289
|
|
|
282
290
|
.SS "environment"
|
|
@@ -469,7 +477,10 @@ Enable the metrics server for health checks
|
|
|
469
477
|
Port for the metrics server (default: 9090)
|
|
470
478
|
.TP
|
|
471
479
|
.B \-\-report\-events
|
|
472
|
-
|
|
480
|
+
Accepted for compatibility; analytics are sent by default
|
|
481
|
+
.TP
|
|
482
|
+
.B \-\-no\-report\-events
|
|
483
|
+
Do not send analytics to Postman
|
|
473
484
|
|
|
474
485
|
.SS "spec"
|
|
475
486
|
Lint and validate Specifications from the command line
|
|
@@ -506,7 +517,10 @@ Output format for the results. [choices: "json", "csv"]
|
|
|
506
517
|
The workspace ID to use for fetching governance rulesets.
|
|
507
518
|
.TP
|
|
508
519
|
.B \-\-report\-events
|
|
509
|
-
|
|
520
|
+
Accepted for compatibility; analytics are sent by default
|
|
521
|
+
.TP
|
|
522
|
+
.B \-\-no\-report\-events
|
|
523
|
+
Do not send analytics to Postman
|
|
510
524
|
|
|
511
525
|
.SS "spec ai\-readiness"
|
|
512
526
|
Score an OpenAPI specification for AI readiness by ID or local file path.
|
|
@@ -647,7 +661,10 @@ Push strategy. "force\-sync": mirror the whole workspace — also DELETE cloud e
|
|
|
647
661
|
Show detailed logging
|
|
648
662
|
.TP
|
|
649
663
|
.B \-\-report\-events
|
|
650
|
-
|
|
664
|
+
Accepted for compatibility; analytics are sent by default
|
|
665
|
+
.TP
|
|
666
|
+
.B \-\-no\-report\-events
|
|
667
|
+
Do not send analytics to Postman
|
|
651
668
|
|
|
652
669
|
.SS "workspace lint"
|
|
653
670
|
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
@@ -1005,6 +1022,12 @@ Specify whether or not to override the default exit code for the current run
|
|
|
1005
1022
|
.B \-\-workspace <workspaceId>
|
|
1006
1023
|
Workspace ID required for flows that contain connector blocks. Find it in the Postman app URL: https://postman.com/workspace/<workspaceId>
|
|
1007
1024
|
.TP
|
|
1025
|
+
.B \-\-report\-events
|
|
1026
|
+
Accepted for compatibility; analytics are sent by default
|
|
1027
|
+
.TP
|
|
1028
|
+
.B \-\-no\-report\-events
|
|
1029
|
+
Do not send analytics to Postman
|
|
1030
|
+
.TP
|
|
1008
1031
|
.B \-\-verbose
|
|
1009
1032
|
Verbose output
|
|
1010
1033
|
.TP
|
|
@@ -1209,6 +1232,12 @@ suppress all output except response body. Useful for piping to other commands.
|
|
|
1209
1232
|
.TP
|
|
1210
1233
|
.B \-\-debug
|
|
1211
1234
|
Debug mode: show detailed execution information including retry attempts, redirects, and timing breakdowns.
|
|
1235
|
+
.TP
|
|
1236
|
+
.B \-\-report\-events
|
|
1237
|
+
Accepted for compatibility; analytics are sent by default
|
|
1238
|
+
.TP
|
|
1239
|
+
.B \-\-no\-report\-events
|
|
1240
|
+
Do not send analytics to Postman
|
|
1212
1241
|
|
|
1213
1242
|
.TP Examples:
|
|
1214
1243
|
|
|
@@ -2056,8 +2085,11 @@ Overwrite the output directory if it exists and is not empty (used with \-\-capt
|
|
|
2056
2085
|
.B \-\-save\-events\-local
|
|
2057
2086
|
Write analytics events to pm\-results/test\-events\-debug.ndjson instead of sending to Postman
|
|
2058
2087
|
.TP
|
|
2059
|
-
.B \-\-report\-events
|
|
2060
|
-
Send application test run results
|
|
2088
|
+
.B \-\-report\-events [boolean]
|
|
2089
|
+
Send application test run results to Postman (default: true)
|
|
2090
|
+
.TP
|
|
2091
|
+
.B \-\-no\-report\-events
|
|
2092
|
+
Do not send run results or analytics to Postman
|
|
2061
2093
|
.TP
|
|
2062
2094
|
.B \-\-verbose
|
|
2063
2095
|
Show detailed per\-request matching, sandbox errors, and debug information
|
|
@@ -2073,7 +2105,8 @@ or via \-\-target\-collection/\-\-target\-environment flags. CLI flags override
|
|
|
2073
2105
|
Use \-\-capture\-only to skip tests and export captured traffic
|
|
2074
2106
|
as a V3 Postman collection organised by host.
|
|
2075
2107
|
|
|
2076
|
-
|
|
2108
|
+
Run results are sent to Postman automatically after analysis.
|
|
2109
|
+
Use \-\-report\-events=false (or \-\-report\-events false) to skip uploading run results.
|
|
2077
2110
|
|
|
2078
2111
|
Examples:
|
|
2079
2112
|
postman application test \-\-command "npx playwright test"
|
|
@@ -3175,7 +3208,7 @@ Examples:
|
|
|
3175
3208
|
|
|
3176
3209
|
|
|
3177
3210
|
.SS "dataset"
|
|
3178
|
-
|
|
3211
|
+
Work with Postman datasets in local YAML files or the cloud.
|
|
3179
3212
|
|
|
3180
3213
|
.B Usage:
|
|
3181
3214
|
[options] [command]
|
|
@@ -3192,28 +3225,28 @@ Targeting:
|
|
|
3192
3225
|
.B Subcommands:
|
|
3193
3226
|
.TP
|
|
3194
3227
|
.B dataset list
|
|
3195
|
-
|
|
3228
|
+
List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
3196
3229
|
.TP
|
|
3197
3230
|
.B dataset get
|
|
3198
|
-
|
|
3231
|
+
Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
3199
3232
|
.TP
|
|
3200
3233
|
.B dataset query
|
|
3201
|
-
|
|
3234
|
+
Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
3202
3235
|
.TP
|
|
3203
3236
|
.B dataset create
|
|
3204
|
-
|
|
3237
|
+
Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
3205
3238
|
.TP
|
|
3206
3239
|
.B dataset delete
|
|
3207
|
-
|
|
3240
|
+
Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
|
|
3208
3241
|
.TP
|
|
3209
3242
|
.B dataset source
|
|
3210
|
-
|
|
3243
|
+
Inspect and manage a dataset's datasources.
|
|
3211
3244
|
.TP
|
|
3212
3245
|
.B dataset view
|
|
3213
|
-
|
|
3246
|
+
Inspect and manage saved views on a dataset.
|
|
3214
3247
|
|
|
3215
3248
|
.SS "dataset list"
|
|
3216
|
-
|
|
3249
|
+
List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
3217
3250
|
|
|
3218
3251
|
.B Usage:
|
|
3219
3252
|
[options] [pathOrDir]
|
|
@@ -3239,7 +3272,7 @@ Examples:
|
|
|
3239
3272
|
|
|
3240
3273
|
|
|
3241
3274
|
.SS "dataset get"
|
|
3242
|
-
|
|
3275
|
+
Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
3243
3276
|
|
|
3244
3277
|
.B Usage:
|
|
3245
3278
|
[options] <datasetPathOrId>
|
|
@@ -3264,7 +3297,7 @@ Examples:
|
|
|
3264
3297
|
|
|
3265
3298
|
|
|
3266
3299
|
.SS "dataset query"
|
|
3267
|
-
|
|
3300
|
+
Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
3268
3301
|
|
|
3269
3302
|
.B Usage:
|
|
3270
3303
|
[options] <datasetPathOrId>
|
|
@@ -3297,7 +3330,7 @@ Examples:
|
|
|
3297
3330
|
|
|
3298
3331
|
|
|
3299
3332
|
.SS "dataset create"
|
|
3300
|
-
|
|
3333
|
+
Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
3301
3334
|
|
|
3302
3335
|
.B Usage:
|
|
3303
3336
|
[options] [path]
|
|
@@ -3331,7 +3364,7 @@ Examples:
|
|
|
3331
3364
|
|
|
3332
3365
|
|
|
3333
3366
|
.SS "dataset delete"
|
|
3334
|
-
|
|
3367
|
+
Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
|
|
3335
3368
|
|
|
3336
3369
|
.B Usage:
|
|
3337
3370
|
[options] <datasetPathOrId>
|
|
@@ -3361,7 +3394,7 @@ Local resource cleanup:
|
|
|
3361
3394
|
|
|
3362
3395
|
|
|
3363
3396
|
.SS "dataset source"
|
|
3364
|
-
|
|
3397
|
+
Inspect and manage a dataset's datasources.
|
|
3365
3398
|
|
|
3366
3399
|
.B Usage:
|
|
3367
3400
|
[options] [command]
|
|
@@ -3369,19 +3402,19 @@ Local resource cleanup:
|
|
|
3369
3402
|
.B Subcommands:
|
|
3370
3403
|
.TP
|
|
3371
3404
|
.B dataset source list
|
|
3372
|
-
|
|
3405
|
+
List the datasources defined on a dataset (local YAML path or cloud id).
|
|
3373
3406
|
.TP
|
|
3374
3407
|
.B dataset source add
|
|
3375
|
-
|
|
3408
|
+
Add a datasource to a dataset.
|
|
3376
3409
|
.TP
|
|
3377
3410
|
.B dataset source remove
|
|
3378
|
-
|
|
3411
|
+
Remove a datasource from a dataset (local YAML path or cloud id).
|
|
3379
3412
|
.TP
|
|
3380
3413
|
.B dataset source update
|
|
3381
|
-
|
|
3414
|
+
Update fields on an existing datasource. Only the flags you provide are changed.
|
|
3382
3415
|
|
|
3383
3416
|
.SS "dataset source list"
|
|
3384
|
-
|
|
3417
|
+
List the datasources defined on a dataset (local YAML path or cloud id).
|
|
3385
3418
|
|
|
3386
3419
|
.B Usage:
|
|
3387
3420
|
[options]
|
|
@@ -3406,7 +3439,7 @@ Examples:
|
|
|
3406
3439
|
|
|
3407
3440
|
|
|
3408
3441
|
.SS "dataset source add"
|
|
3409
|
-
|
|
3442
|
+
Add a datasource to a dataset.
|
|
3410
3443
|
|
|
3411
3444
|
.B Usage:
|
|
3412
3445
|
[options] [datasetPathOrId]
|
|
@@ -3520,7 +3553,7 @@ Execution:
|
|
|
3520
3553
|
|
|
3521
3554
|
|
|
3522
3555
|
.SS "dataset source remove"
|
|
3523
|
-
|
|
3556
|
+
Remove a datasource from a dataset (local YAML path or cloud id).
|
|
3524
3557
|
|
|
3525
3558
|
.B Usage:
|
|
3526
3559
|
[options] <sourceNameOrId>
|
|
@@ -3543,7 +3576,7 @@ Examples:
|
|
|
3543
3576
|
|
|
3544
3577
|
|
|
3545
3578
|
.SS "dataset source update"
|
|
3546
|
-
|
|
3579
|
+
Update fields on an existing datasource. Only the flags you provide are changed.
|
|
3547
3580
|
|
|
3548
3581
|
.B Usage:
|
|
3549
3582
|
[options] <sourceNameOrId>
|
|
@@ -3642,7 +3675,7 @@ Examples:
|
|
|
3642
3675
|
|
|
3643
3676
|
|
|
3644
3677
|
.SS "dataset view"
|
|
3645
|
-
|
|
3678
|
+
Inspect and manage saved views on a dataset.
|
|
3646
3679
|
|
|
3647
3680
|
.B Usage:
|
|
3648
3681
|
[options] [command]
|
|
@@ -3650,22 +3683,22 @@ Examples:
|
|
|
3650
3683
|
.B Subcommands:
|
|
3651
3684
|
.TP
|
|
3652
3685
|
.B dataset view list
|
|
3653
|
-
|
|
3686
|
+
List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3654
3687
|
.TP
|
|
3655
3688
|
.B dataset view run
|
|
3656
|
-
|
|
3689
|
+
Execute a saved view against a dataset and print the rows.
|
|
3657
3690
|
.TP
|
|
3658
3691
|
.B dataset view create
|
|
3659
|
-
|
|
3692
|
+
Add a saved view to a dataset (local YAML path or cloud id).
|
|
3660
3693
|
.TP
|
|
3661
3694
|
.B dataset view delete
|
|
3662
|
-
|
|
3695
|
+
Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3663
3696
|
.TP
|
|
3664
3697
|
.B dataset view update
|
|
3665
|
-
|
|
3698
|
+
Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3666
3699
|
|
|
3667
3700
|
.SS "dataset view list"
|
|
3668
|
-
|
|
3701
|
+
List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3669
3702
|
|
|
3670
3703
|
.B Usage:
|
|
3671
3704
|
[options]
|
|
@@ -3690,7 +3723,7 @@ Examples:
|
|
|
3690
3723
|
|
|
3691
3724
|
|
|
3692
3725
|
.SS "dataset view run"
|
|
3693
|
-
|
|
3726
|
+
Execute a saved view against a dataset and print the rows.
|
|
3694
3727
|
|
|
3695
3728
|
.B Usage:
|
|
3696
3729
|
[options] <viewNameOrId>
|
|
@@ -3724,7 +3757,7 @@ Examples:
|
|
|
3724
3757
|
|
|
3725
3758
|
|
|
3726
3759
|
.SS "dataset view create"
|
|
3727
|
-
|
|
3760
|
+
Add a saved view to a dataset (local YAML path or cloud id).
|
|
3728
3761
|
|
|
3729
3762
|
.B Usage:
|
|
3730
3763
|
[options]
|
|
@@ -3757,7 +3790,7 @@ Examples:
|
|
|
3757
3790
|
|
|
3758
3791
|
|
|
3759
3792
|
.SS "dataset view delete"
|
|
3760
|
-
|
|
3793
|
+
Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3761
3794
|
|
|
3762
3795
|
.B Usage:
|
|
3763
3796
|
[options] <viewNameOrId>
|
|
@@ -3779,7 +3812,7 @@ Examples:
|
|
|
3779
3812
|
|
|
3780
3813
|
|
|
3781
3814
|
.SS "dataset view update"
|
|
3782
|
-
|
|
3815
|
+
Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3783
3816
|
|
|
3784
3817
|
.B Usage:
|
|
3785
3818
|
[options] <viewNameOrId>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.52.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.52.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.52.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.52.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.52.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.52.0"
|
|
66
66
|
}
|
|
67
67
|
}
|