postman-cli 1.50.0 → 1.51.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 +111 -37
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-08-27" "v1.
|
|
1
|
+
.TH POSTMAN 1 "2026-08-27" "v1.51.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -3175,11 +3175,20 @@ Examples:
|
|
|
3175
3175
|
|
|
3176
3176
|
|
|
3177
3177
|
.SS "dataset"
|
|
3178
|
-
[BETA] Work with Postman datasets
|
|
3178
|
+
[BETA] Work with Postman datasets in local YAML files or the cloud.
|
|
3179
3179
|
|
|
3180
3180
|
.B Usage:
|
|
3181
3181
|
[options] [command]
|
|
3182
3182
|
|
|
3183
|
+
.TP Examples:
|
|
3184
|
+
|
|
3185
|
+
Targeting:
|
|
3186
|
+
Local datasets: pass a .dataset.yaml path.
|
|
3187
|
+
Cloud datasets: pass a dataset id; list/create use \-w <workspace\-id>.
|
|
3188
|
+
Cloud operations require a paid Postman plan and `postman login` or \-\-api\-key.
|
|
3189
|
+
|
|
3190
|
+
|
|
3191
|
+
|
|
3183
3192
|
.B Subcommands:
|
|
3184
3193
|
.TP
|
|
3185
3194
|
.B dataset list
|
|
@@ -3195,7 +3204,7 @@ Examples:
|
|
|
3195
3204
|
[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
3196
3205
|
.TP
|
|
3197
3206
|
.B dataset delete
|
|
3198
|
-
[BETA] Permanently remove a dataset: a local .dataset.yaml
|
|
3207
|
+
[BETA] Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
|
|
3199
3208
|
.TP
|
|
3200
3209
|
.B dataset source
|
|
3201
3210
|
[BETA] Inspect and manage a dataset's datasources.
|
|
@@ -3266,19 +3275,23 @@ Examples:
|
|
|
3266
3275
|
SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
|
|
3267
3276
|
.TP
|
|
3268
3277
|
.B \-p, \-\-param <value...>
|
|
3269
|
-
|
|
3278
|
+
Bind values to $1, $2, ... in order; pass multiple values after \-p or repeat \-p
|
|
3270
3279
|
.TP
|
|
3271
3280
|
.B \-\-api\-key <key>
|
|
3272
3281
|
Postman API key (defaults to the `postman login` session)
|
|
3273
3282
|
.TP
|
|
3274
3283
|
.B \-\-json
|
|
3275
3284
|
Output rows as JSON instead of a table
|
|
3285
|
+
.TP
|
|
3286
|
+
.B \-\-debug
|
|
3287
|
+
Include safe classified dataset diagnostics
|
|
3276
3288
|
|
|
3277
3289
|
.TP Examples:
|
|
3278
3290
|
|
|
3279
3291
|
Examples:
|
|
3280
3292
|
postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
|
|
3281
|
-
postman dataset query ./users.dataset.yaml
|
|
3293
|
+
postman dataset query ./users.dataset.yaml \e
|
|
3294
|
+
\-q 'SELECT * FROM source_users WHERE id = $1 AND active = $2' \-p 42 true
|
|
3282
3295
|
postman dataset query 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users LIMIT 5"
|
|
3283
3296
|
|
|
3284
3297
|
|
|
@@ -3318,7 +3331,7 @@ Examples:
|
|
|
3318
3331
|
|
|
3319
3332
|
|
|
3320
3333
|
.SS "dataset delete"
|
|
3321
|
-
[BETA] Permanently remove a dataset: a local .dataset.yaml
|
|
3334
|
+
[BETA] Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.
|
|
3322
3335
|
|
|
3323
3336
|
.B Usage:
|
|
3324
3337
|
[options] <datasetPathOrId>
|
|
@@ -3329,7 +3342,7 @@ Examples:
|
|
|
3329
3342
|
Skip the confirmation prompt
|
|
3330
3343
|
.TP
|
|
3331
3344
|
.B \-\-keep\-resources
|
|
3332
|
-
|
|
3345
|
+
Preserve the local resource directory even when it is empty (local only)
|
|
3333
3346
|
.TP
|
|
3334
3347
|
.B \-\-api\-key <key>
|
|
3335
3348
|
Postman API key (defaults to the `postman login` session)
|
|
@@ -3341,6 +3354,10 @@ Examples:
|
|
|
3341
3354
|
postman dataset delete ./postman/datasets/users/users.dataset.yaml \-\-yes
|
|
3342
3355
|
postman dataset delete 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-\-yes
|
|
3343
3356
|
|
|
3357
|
+
Local resource cleanup:
|
|
3358
|
+
Local source files are preserved because references can cross directory boundaries.
|
|
3359
|
+
An empty resource directory is removed unless \-\-keep\-resources is passed.
|
|
3360
|
+
|
|
3344
3361
|
|
|
3345
3362
|
|
|
3346
3363
|
.SS "dataset source"
|
|
@@ -3392,24 +3409,24 @@ Examples:
|
|
|
3392
3409
|
[BETA] Add a datasource to a dataset.
|
|
3393
3410
|
|
|
3394
3411
|
.B Usage:
|
|
3395
|
-
[options]
|
|
3412
|
+
[options] [datasetPathOrId]
|
|
3396
3413
|
|
|
3397
3414
|
.B Options:
|
|
3398
3415
|
.TP
|
|
3399
3416
|
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3400
|
-
Dataset to add the source to
|
|
3417
|
+
Dataset to add the source to; positional target is also accepted for v1.45 compatibility
|
|
3401
3418
|
.TP
|
|
3402
3419
|
.B \-n, \-\-name <name>
|
|
3403
3420
|
Logical name for the source (becomes the SQL table name)
|
|
3404
3421
|
.TP
|
|
3405
3422
|
.B \-\-source\-id <uuid>
|
|
3406
|
-
Override the generated source id
|
|
3423
|
+
Override the generated source id (local dataset only)
|
|
3407
3424
|
.TP
|
|
3408
|
-
.B \-\-format <csv|json|mysql|postgres>
|
|
3409
|
-
|
|
3425
|
+
.B \-\-format <csv|json|mysql|postgres|sqlserver>
|
|
3426
|
+
Use this format instead of extension/type inference; file contents are not sniffed
|
|
3410
3427
|
.TP
|
|
3411
|
-
.B \-\-type <local|
|
|
3412
|
-
Source kind; inferred
|
|
3428
|
+
.B \-\-type <local|mysql|postgresql|sqlserver>
|
|
3429
|
+
Source kind; local is inferred when \-\-file is provided
|
|
3413
3430
|
.TP
|
|
3414
3431
|
.B \-\-file <path>
|
|
3415
3432
|
Path to a local CSV/JSON file (absolute or cwd\-relative)
|
|
@@ -3423,14 +3440,11 @@ When copying, overwrite an existing file at the destination (local dataset)
|
|
|
3423
3440
|
.B \-\-upload
|
|
3424
3441
|
Cloud dataset only: upload \-\-file as a postmancloudfile source (runs via /exec). Without \-\-upload, \-\-file is registered as a local_filesystem csv/json source read by the local engine.
|
|
3425
3442
|
.TP
|
|
3426
|
-
.B \-\-url <url>
|
|
3427
|
-
HTTP(S) URL to a remote CSV/JSON file
|
|
3428
|
-
.TP
|
|
3429
3443
|
.B \-\-host <host>
|
|
3430
|
-
DB host (mysql/postgresql)
|
|
3444
|
+
DB host (mysql/postgresql/sqlserver)
|
|
3431
3445
|
.TP
|
|
3432
3446
|
.B \-\-port <port>
|
|
3433
|
-
DB port
|
|
3447
|
+
DB port (defaults to 1433 for sqlserver)
|
|
3434
3448
|
.TP
|
|
3435
3449
|
.B \-\-user <user>
|
|
3436
3450
|
DB user (warning: stored as plaintext in the YAML).
|
|
@@ -3442,7 +3456,7 @@ DB password. WARNING: passing it here exposes it in `ps` output and shell histor
|
|
|
3442
3456
|
DB database name
|
|
3443
3457
|
.TP
|
|
3444
3458
|
.B \-\-table <table>
|
|
3445
|
-
DB table name (
|
|
3459
|
+
DB table name (required for sqlserver)
|
|
3446
3460
|
.TP
|
|
3447
3461
|
.B \-\-ssh\-host <host>
|
|
3448
3462
|
SSH bastion host
|
|
@@ -3468,12 +3482,43 @@ Shared Vault secret ID containing the SSH public host key
|
|
|
3468
3482
|
.B \-\-ssh\-insecure\-skip\-host\-key\-verification
|
|
3469
3483
|
WARNING: disable SSH host\-key verification; use only for trusted local testing
|
|
3470
3484
|
.TP
|
|
3471
|
-
.B \-\-
|
|
3472
|
-
|
|
3485
|
+
.B \-\-schema <schema>
|
|
3486
|
+
DB schema (postgresql/sqlserver; defaults to dbo for sqlserver)
|
|
3487
|
+
.TP
|
|
3488
|
+
.B \-\-encrypt <true|false>
|
|
3489
|
+
SQL Server TLS encryption (default: true)
|
|
3490
|
+
.TP
|
|
3491
|
+
.B \-\-trust\-server\-certificate <true|false>
|
|
3492
|
+
SQL Server: skip certificate verification (default: false; insecure)
|
|
3493
|
+
.TP
|
|
3494
|
+
.B \-\-tls\-certificate <path>
|
|
3495
|
+
SQL Server CA/server certificate file path
|
|
3496
|
+
.TP
|
|
3497
|
+
.B \-\-host\-name\-in\-certificate <hostname>
|
|
3498
|
+
SQL Server certificate hostname override
|
|
3499
|
+
.TP
|
|
3500
|
+
.B \-\-tls\-min\-version <1.2|1.3>
|
|
3501
|
+
SQL Server minimum TLS version (default: 1.2)
|
|
3473
3502
|
.TP
|
|
3474
3503
|
.B \-\-api\-key <key>
|
|
3475
3504
|
Postman API key (defaults to the `postman login` session)
|
|
3476
3505
|
|
|
3506
|
+
.TP Examples:
|
|
3507
|
+
|
|
3508
|
+
Examples:
|
|
3509
|
+
postman dataset source add \-d ./users.dataset.yaml \-n users \-\-file ./users.csv
|
|
3510
|
+
postman dataset source add \-d ./users.dataset.yaml \-n users \-\-file ./users.txt \-\-format json
|
|
3511
|
+
postman dataset source add \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \e
|
|
3512
|
+
\-n users \-\-file ./users.csv \-\-upload
|
|
3513
|
+
|
|
3514
|
+
Format selection:
|
|
3515
|
+
File extensions are used only when \-\-format is omitted. An explicit \-\-format is authoritative.
|
|
3516
|
+
|
|
3517
|
+
Execution:
|
|
3518
|
+
\-\-upload runs file\-backed queries in the cloud service. Without \-\-upload, the local engine reads the file.
|
|
3519
|
+
|
|
3520
|
+
|
|
3521
|
+
|
|
3477
3522
|
.SS "dataset source remove"
|
|
3478
3523
|
[BETA] Remove a datasource from a dataset (local YAML path or cloud id).
|
|
3479
3524
|
|
|
@@ -3511,23 +3556,20 @@ Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset
|
|
|
3511
3556
|
.B \-n, \-\-name <name>
|
|
3512
3557
|
Rename the source
|
|
3513
3558
|
.TP
|
|
3514
|
-
.B \-\-format <csv|json|mysql|postgres>
|
|
3515
|
-
Change the format
|
|
3559
|
+
.B \-\-format <csv|json|mysql|postgres|sqlserver>
|
|
3560
|
+
Change the format (local dataset only; cloud source formats are immutable)
|
|
3516
3561
|
.TP
|
|
3517
3562
|
.B \-\-file <path>
|
|
3518
|
-
Replace the source
|
|
3563
|
+
Replace the source file (local dataset only; cloud file replacement is unsupported)
|
|
3519
3564
|
.TP
|
|
3520
3565
|
.B \-\-ref\-only
|
|
3521
|
-
|
|
3566
|
+
With \-\-file, reference in place instead of copying (local dataset only)
|
|
3522
3567
|
.TP
|
|
3523
3568
|
.B \-\-force
|
|
3524
|
-
|
|
3525
|
-
.TP
|
|
3526
|
-
.B \-\-url <url>
|
|
3527
|
-
Replace the remote URL (remote\-url only)
|
|
3569
|
+
With \-\-file, overwrite the copied destination (local dataset only)
|
|
3528
3570
|
.TP
|
|
3529
3571
|
.B \-\-host <host>
|
|
3530
|
-
Update DB host (mysql/postgresql)
|
|
3572
|
+
Update DB host (mysql/postgresql/sqlserver)
|
|
3531
3573
|
.TP
|
|
3532
3574
|
.B \-\-port <port>
|
|
3533
3575
|
Update DB port
|
|
@@ -3568,12 +3610,37 @@ Update the Shared Vault secret ID containing the SSH public host key
|
|
|
3568
3610
|
.B \-\-ssh\-insecure\-skip\-host\-key\-verification
|
|
3569
3611
|
WARNING: disable SSH host\-key verification; use only for trusted local testing
|
|
3570
3612
|
.TP
|
|
3571
|
-
.B \-\-
|
|
3572
|
-
Update
|
|
3613
|
+
.B \-\-schema <schema>
|
|
3614
|
+
Update DB schema (postgresql/sqlserver)
|
|
3615
|
+
.TP
|
|
3616
|
+
.B \-\-encrypt <true|false>
|
|
3617
|
+
Update SQL Server TLS encryption
|
|
3618
|
+
.TP
|
|
3619
|
+
.B \-\-trust\-server\-certificate <true|false>
|
|
3620
|
+
Update SQL Server certificate verification (true is insecure)
|
|
3621
|
+
.TP
|
|
3622
|
+
.B \-\-tls\-certificate <path>
|
|
3623
|
+
Update SQL Server CA/server certificate file path
|
|
3624
|
+
.TP
|
|
3625
|
+
.B \-\-host\-name\-in\-certificate <hostname>
|
|
3626
|
+
Update SQL Server certificate hostname override
|
|
3627
|
+
.TP
|
|
3628
|
+
.B \-\-tls\-min\-version <1.2|1.3>
|
|
3629
|
+
Update SQL Server minimum TLS version
|
|
3573
3630
|
.TP
|
|
3574
3631
|
.B \-\-api\-key <key>
|
|
3575
3632
|
Postman API key (defaults to the `postman login` session)
|
|
3576
3633
|
|
|
3634
|
+
.TP Examples:
|
|
3635
|
+
|
|
3636
|
+
Examples:
|
|
3637
|
+
postman dataset source update users \-d ./users.dataset.yaml \-\-name customers
|
|
3638
|
+
postman dataset source update users \-d ./users.dataset.yaml \-\-file ./users\-v2.csv
|
|
3639
|
+
postman dataset source update orders\-db \e
|
|
3640
|
+
\-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-\-host db.internal.example
|
|
3641
|
+
|
|
3642
|
+
|
|
3643
|
+
|
|
3577
3644
|
.SS "dataset view"
|
|
3578
3645
|
[BETA] Inspect and manage saved views on a dataset.
|
|
3579
3646
|
|
|
@@ -3634,20 +3701,25 @@ Examples:
|
|
|
3634
3701
|
Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3635
3702
|
.TP
|
|
3636
3703
|
.B \-p, \-\-param <value...>
|
|
3637
|
-
|
|
3704
|
+
Bind values to $1, $2, ... in order; pass multiple values after \-p or repeat \-p
|
|
3638
3705
|
.TP
|
|
3639
3706
|
.B \-\-api\-key <key>
|
|
3640
3707
|
Postman API key (defaults to the `postman login` session)
|
|
3641
3708
|
.TP
|
|
3642
3709
|
.B \-\-json
|
|
3643
3710
|
Output rows as JSON instead of a table
|
|
3711
|
+
.TP
|
|
3712
|
+
.B \-\-debug
|
|
3713
|
+
Include safe classified dataset diagnostics
|
|
3644
3714
|
|
|
3645
3715
|
.TP Examples:
|
|
3646
3716
|
|
|
3647
3717
|
Examples:
|
|
3648
3718
|
postman dataset view run "Active Users" \-d ./users.dataset.yaml
|
|
3719
|
+
postman dataset view run "Users By Status" \-d ./users.dataset.yaml \-p active 20
|
|
3649
3720
|
postman dataset view run ea748a6a\-ed3c\-496d\-b91e\-6ccc8e4d0e9d \-d ./users.dataset.yaml
|
|
3650
|
-
postman dataset view run "Active Users"
|
|
3721
|
+
postman dataset view run "Active Users" \e
|
|
3722
|
+
\-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-p true
|
|
3651
3723
|
|
|
3652
3724
|
|
|
3653
3725
|
|
|
@@ -3729,8 +3801,10 @@ Postman API key (defaults to the `postman login` session)
|
|
|
3729
3801
|
.TP Examples:
|
|
3730
3802
|
|
|
3731
3803
|
Examples:
|
|
3732
|
-
postman dataset view update "Active Users"
|
|
3733
|
-
|
|
3804
|
+
postman dataset view update "Active Users" \e
|
|
3805
|
+
\-d ./users.dataset.yaml \-q "SELECT * FROM source_users"
|
|
3806
|
+
postman dataset view update "Active Users" \e
|
|
3807
|
+
\-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users"
|
|
3734
3808
|
|
|
3735
3809
|
|
|
3736
3810
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.51.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.51.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.51.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.51.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.51.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.51.0"
|
|
66
66
|
}
|
|
67
67
|
}
|