postman-cli 1.43.0 → 1.45.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 +206 -76
- 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-30" "v1.45.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -172,14 +172,14 @@ Define the number of iterations to run
|
|
|
172
172
|
.B \-d, \-\-iteration\-data <path>
|
|
173
173
|
Specify a data file to use for iterations (either JSON or CSV)
|
|
174
174
|
.TP
|
|
175
|
-
.B \-\-iteration\-data\-dataset <
|
|
176
|
-
[BETA] Path to a .dataset.yaml whose view drives the iteration data. Mutually exclusive with \-\-iteration\-data. Requires \-\-iteration\-data\-view.
|
|
175
|
+
.B \-\-iteration\-data\-dataset <pathOrId>
|
|
176
|
+
[BETA] Path to a .dataset.yaml (local collection) or a cloud dataset id (cloud collection) whose view drives the iteration data. Mutually exclusive with \-\-iteration\-data. Requires \-\-iteration\-data\-view.
|
|
177
177
|
.TP
|
|
178
178
|
.B \-\-iteration\-data\-view <nameOrId>
|
|
179
179
|
[BETA] Name or id of the view to execute (within \-\-iteration\-data\-dataset). The view's result set drives one iteration per row.
|
|
180
180
|
.TP
|
|
181
181
|
.B \-\-dataset <pathOrDir>
|
|
182
|
-
[BETA] Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to scripts as pm.datasets(<id>). When provided, auto\-discovery of .dataset.yaml files from the collection's parent repo is disabled. (default: )
|
|
182
|
+
[BETA] Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to scripts as pm.datasets(<id>). When provided, auto\-discovery of .dataset.yaml files from the collection's parent repo is disabled. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged\-in cloud session. (default: )
|
|
183
183
|
.TP
|
|
184
184
|
.B \-i <id>
|
|
185
185
|
Specify the request/folder id, name, or path to run from the collection. Use a path (e.g. "FolderName/RequestName") to disambiguate items with the same name. Can be specified multiple times to run multiple items (default: )
|
|
@@ -491,49 +491,76 @@ Manage workspace resources.
|
|
|
491
491
|
|
|
492
492
|
.B Subcommands:
|
|
493
493
|
.TP
|
|
494
|
+
.B workspace list
|
|
495
|
+
List all available Postman Workspaces
|
|
496
|
+
.TP
|
|
494
497
|
.B workspace prepare
|
|
495
498
|
Prepare local collections and environments for push by validating and regenerating IDs if needed.
|
|
496
499
|
.TP
|
|
497
500
|
.B workspace push
|
|
498
|
-
Push local
|
|
501
|
+
Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.
|
|
499
502
|
|
|
500
|
-
.SS "workspace
|
|
501
|
-
|
|
503
|
+
.SS "workspace list"
|
|
504
|
+
List all available Postman Workspaces
|
|
502
505
|
|
|
503
506
|
.B Usage:
|
|
504
507
|
[options]
|
|
505
508
|
|
|
506
509
|
.B Options:
|
|
507
510
|
.TP
|
|
508
|
-
.B
|
|
509
|
-
|
|
511
|
+
.B \-f, \-\-filter <name>
|
|
512
|
+
Filter workspaces by name.
|
|
510
513
|
.TP
|
|
511
|
-
.B
|
|
512
|
-
|
|
514
|
+
.B \-t, \-\-type <type>
|
|
515
|
+
Filter workspaces by visibility type: team, public, private, personal.
|
|
516
|
+
.TP
|
|
517
|
+
.B \-\-verbose
|
|
518
|
+
Verbose output
|
|
519
|
+
.TP
|
|
520
|
+
.B \-\-debug
|
|
521
|
+
Debug output
|
|
522
|
+
.TP
|
|
523
|
+
.B \-\-json
|
|
524
|
+
JSON output
|
|
525
|
+
|
|
526
|
+
.TP Examples:
|
|
527
|
+
|
|
528
|
+
Examples:
|
|
529
|
+
postman workspace list
|
|
530
|
+
postman workspace list \-\-filter "my\-workspace"
|
|
531
|
+
postman workspace list \-\-type team
|
|
532
|
+
postman workspace list \-\-type team \-\-filter "project"
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
.SS "workspace prepare"
|
|
537
|
+
Prepare local collections and environments for push by validating and regenerating IDs if needed.
|
|
538
|
+
|
|
539
|
+
.B Usage:
|
|
540
|
+
[options]
|
|
541
|
+
|
|
542
|
+
.B Options:
|
|
513
543
|
.TP
|
|
514
544
|
.B \-\-verbose
|
|
515
545
|
Show detailed logging
|
|
516
546
|
|
|
517
547
|
.SS "workspace push"
|
|
518
|
-
Push local
|
|
548
|
+
Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.
|
|
519
549
|
|
|
520
550
|
.B Usage:
|
|
521
551
|
[options]
|
|
522
552
|
|
|
523
553
|
.B Options:
|
|
524
554
|
.TP
|
|
525
|
-
.B \-\-collections\-dir <path>
|
|
526
|
-
Path to the collections directory (default: postman/collections)
|
|
527
|
-
.TP
|
|
528
|
-
.B \-\-environments\-dir <path>
|
|
529
|
-
Path to the environments directory (default: postman/environments)
|
|
530
|
-
.TP
|
|
531
555
|
.B \-\-no\-prepare
|
|
532
556
|
Skip ID validation and auto\-fix before pushing
|
|
533
557
|
.TP
|
|
534
558
|
.B \-y, \-\-yes
|
|
535
559
|
Skip all confirmation prompts
|
|
536
560
|
.TP
|
|
561
|
+
.B \-\-push\-strategy <strategy>
|
|
562
|
+
Push strategy. "force\-sync": mirror the whole workspace — also DELETE cloud entities that have no local counterpart (destructive). Defaults to "default" (create/update only).
|
|
563
|
+
.TP
|
|
537
564
|
.B \-\-verbose
|
|
538
565
|
Show detailed logging
|
|
539
566
|
.TP
|
|
@@ -1228,7 +1255,7 @@ Generate and manage your SDKs directly from the command line.
|
|
|
1228
1255
|
Create or update .postman/config.json with an SDK configuration stub.
|
|
1229
1256
|
.TP
|
|
1230
1257
|
.B sdk generate
|
|
1231
|
-
Generate a new SDK from a Postman collection or specification.
|
|
1258
|
+
Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).
|
|
1232
1259
|
.TP
|
|
1233
1260
|
.B sdk track
|
|
1234
1261
|
Enable change tracking for a generated SDK. Adds file hashes to .manifest.json so that the next `sdk generate` can detect your edits and preserve them via 3\-way merge.
|
|
@@ -1257,7 +1284,7 @@ Create or update .postman/config.json with an SDK configuration stub.
|
|
|
1257
1284
|
Skip prompts and overwrite existing sdk config
|
|
1258
1285
|
|
|
1259
1286
|
.SS "sdk generate"
|
|
1260
|
-
Generate a new SDK from a Postman collection or specification.
|
|
1287
|
+
Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).
|
|
1261
1288
|
|
|
1262
1289
|
.B Usage:
|
|
1263
1290
|
<idOrPath> [options]
|
|
@@ -1317,6 +1344,8 @@ Input:
|
|
|
1317
1344
|
\- A file path to a collection (.json) or specification (.json, .yaml, .yml) file
|
|
1318
1345
|
\- A URL to a publicly accessible collection or specification file
|
|
1319
1346
|
|
|
1347
|
+
Supported specification formats: OpenAPI (2.0/3.x) and AsyncAPI (2.x/3.x).
|
|
1348
|
+
|
|
1320
1349
|
When using an ID, the SDK generation updates the version in Postman Cloud.
|
|
1321
1350
|
When using a file path or URL, a one\-off build is created that does not update the Postman Cloud.
|
|
1322
1351
|
|
|
@@ -1336,6 +1365,9 @@ Examples:
|
|
|
1336
1365
|
Generate SDK from OpenAPI specification file (one\-off build):
|
|
1337
1366
|
postman sdk generate ./openapi.yaml \-l typescript \-o ./my\-sdk
|
|
1338
1367
|
|
|
1368
|
+
Generate SDK from AsyncAPI specification file (one\-off build):
|
|
1369
|
+
postman sdk generate ./asyncapi.yaml \-l typescript \-o ./my\-sdk
|
|
1370
|
+
|
|
1339
1371
|
Generate SDK from publicly accessible URL (one\-off build):
|
|
1340
1372
|
postman sdk generate https://petstore.swagger.io/v2/swagger.json \-l typescript \-o ./my\-sdk
|
|
1341
1373
|
|
|
@@ -2727,19 +2759,19 @@ Examples:
|
|
|
2727
2759
|
.B Subcommands:
|
|
2728
2760
|
.TP
|
|
2729
2761
|
.B dataset list
|
|
2730
|
-
[BETA] List dataset YAMLs under
|
|
2762
|
+
[BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
2731
2763
|
.TP
|
|
2732
2764
|
.B dataset get
|
|
2733
|
-
[BETA] Print a dataset's metadata and structure summary.
|
|
2765
|
+
[BETA] Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
2734
2766
|
.TP
|
|
2735
2767
|
.B dataset query
|
|
2736
|
-
[BETA] Run an ad\-hoc SQL query against a dataset.
|
|
2768
|
+
[BETA] Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
2737
2769
|
.TP
|
|
2738
2770
|
.B dataset create
|
|
2739
|
-
[BETA] Scaffold a new
|
|
2771
|
+
[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
2740
2772
|
.TP
|
|
2741
2773
|
.B dataset delete
|
|
2742
|
-
[BETA] Permanently remove a dataset
|
|
2774
|
+
[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
|
|
2743
2775
|
.TP
|
|
2744
2776
|
.B dataset source
|
|
2745
2777
|
[BETA] Inspect and manage a dataset's datasources.
|
|
@@ -2748,13 +2780,19 @@ Examples:
|
|
|
2748
2780
|
[BETA] Inspect and manage saved views on a dataset.
|
|
2749
2781
|
|
|
2750
2782
|
.SS "dataset list"
|
|
2751
|
-
[BETA] List dataset YAMLs under
|
|
2783
|
+
[BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
2752
2784
|
|
|
2753
2785
|
.B Usage:
|
|
2754
|
-
[options]
|
|
2786
|
+
[options] [pathOrDir]
|
|
2755
2787
|
|
|
2756
2788
|
.B Options:
|
|
2757
2789
|
.TP
|
|
2790
|
+
.B \-w, \-\-workspace <id>
|
|
2791
|
+
Postman workspace ID (cloud list)
|
|
2792
|
+
.TP
|
|
2793
|
+
.B \-\-api\-key <key>
|
|
2794
|
+
Postman API key (defaults to the `postman login` session)
|
|
2795
|
+
.TP
|
|
2758
2796
|
.B \-\-json
|
|
2759
2797
|
Output as JSON instead of a table
|
|
2760
2798
|
|
|
@@ -2763,32 +2801,40 @@ Output as JSON instead of a table
|
|
|
2763
2801
|
Examples:
|
|
2764
2802
|
postman dataset list ./postman/datasets
|
|
2765
2803
|
postman dataset list ./postman/datasets/users/users.dataset.yaml
|
|
2804
|
+
postman dataset list \-w 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
2766
2805
|
|
|
2767
2806
|
|
|
2768
2807
|
|
|
2769
2808
|
.SS "dataset get"
|
|
2770
|
-
[BETA] Print a dataset's metadata and structure summary.
|
|
2809
|
+
[BETA] Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
2771
2810
|
|
|
2772
2811
|
.B Usage:
|
|
2773
|
-
[options] <
|
|
2812
|
+
[options] <datasetPathOrId>
|
|
2774
2813
|
|
|
2775
2814
|
.B Options:
|
|
2776
2815
|
.TP
|
|
2816
|
+
.B \-\-api\-key <key>
|
|
2817
|
+
Postman API key (defaults to the `postman login` session)
|
|
2818
|
+
.TP
|
|
2819
|
+
.B \-\-no\-populate
|
|
2820
|
+
Skip fetching datasources/views for a cloud dataset
|
|
2821
|
+
.TP
|
|
2777
2822
|
.B \-\-json
|
|
2778
|
-
Output the full
|
|
2823
|
+
Output the full dataset as JSON
|
|
2779
2824
|
|
|
2780
2825
|
.TP Examples:
|
|
2781
2826
|
|
|
2782
2827
|
Examples:
|
|
2783
2828
|
postman dataset get ./postman/datasets/users/users.dataset.yaml
|
|
2829
|
+
postman dataset get 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
2784
2830
|
|
|
2785
2831
|
|
|
2786
2832
|
|
|
2787
2833
|
.SS "dataset query"
|
|
2788
|
-
[BETA] Run an ad\-hoc SQL query against a dataset.
|
|
2834
|
+
[BETA] Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
2789
2835
|
|
|
2790
2836
|
.B Usage:
|
|
2791
|
-
[options] <
|
|
2837
|
+
[options] <datasetPathOrId>
|
|
2792
2838
|
|
|
2793
2839
|
.B Options:
|
|
2794
2840
|
.TP
|
|
@@ -2798,6 +2844,9 @@ SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
|
|
|
2798
2844
|
.B \-p, \-\-param <value...>
|
|
2799
2845
|
Positional parameter values for $1, $2, ... bindings; repeatable
|
|
2800
2846
|
.TP
|
|
2847
|
+
.B \-\-api\-key <key>
|
|
2848
|
+
Postman API key (defaults to the `postman login` session)
|
|
2849
|
+
.TP
|
|
2801
2850
|
.B \-\-json
|
|
2802
2851
|
Output rows as JSON instead of a table
|
|
2803
2852
|
|
|
@@ -2806,14 +2855,15 @@ Output rows as JSON instead of a table
|
|
|
2806
2855
|
Examples:
|
|
2807
2856
|
postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
|
|
2808
2857
|
postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users WHERE id = $1" \-p 42
|
|
2858
|
+
postman dataset query 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users LIMIT 5"
|
|
2809
2859
|
|
|
2810
2860
|
|
|
2811
2861
|
|
|
2812
2862
|
.SS "dataset create"
|
|
2813
|
-
[BETA] Scaffold a new
|
|
2863
|
+
[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
2814
2864
|
|
|
2815
2865
|
.B Usage:
|
|
2816
|
-
[options]
|
|
2866
|
+
[options] [path]
|
|
2817
2867
|
|
|
2818
2868
|
.B Options:
|
|
2819
2869
|
.TP
|
|
@@ -2823,24 +2873,31 @@ Human\-readable name for the dataset
|
|
|
2823
2873
|
.B \-d, \-\-description <desc>
|
|
2824
2874
|
Optional description
|
|
2825
2875
|
.TP
|
|
2826
|
-
.B \-\-id <uuid>
|
|
2827
|
-
Override the generated dataset id (defaults to a random v4 UUID)
|
|
2876
|
+
.B \-\-dataset\-id <uuid>
|
|
2877
|
+
Override the generated dataset id (local only; defaults to a random v4 UUID)
|
|
2828
2878
|
.TP
|
|
2829
2879
|
.B \-\-force
|
|
2830
2880
|
Overwrite an existing file at <path>
|
|
2881
|
+
.TP
|
|
2882
|
+
.B \-w, \-\-workspace <id>
|
|
2883
|
+
Postman workspace ID (create a cloud dataset)
|
|
2884
|
+
.TP
|
|
2885
|
+
.B \-\-api\-key <key>
|
|
2886
|
+
Postman API key (defaults to the `postman login` session)
|
|
2831
2887
|
|
|
2832
2888
|
.TP Examples:
|
|
2833
2889
|
|
|
2834
2890
|
Examples:
|
|
2835
2891
|
postman dataset create ./postman/datasets/users/users.dataset.yaml \-\-name "Users"
|
|
2892
|
+
postman dataset create \-\-name "Users" \-w 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
2836
2893
|
|
|
2837
2894
|
|
|
2838
2895
|
|
|
2839
2896
|
.SS "dataset delete"
|
|
2840
|
-
[BETA] Permanently remove a dataset
|
|
2897
|
+
[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
|
|
2841
2898
|
|
|
2842
2899
|
.B Usage:
|
|
2843
|
-
[options] <
|
|
2900
|
+
[options] <datasetPathOrId>
|
|
2844
2901
|
|
|
2845
2902
|
.B Options:
|
|
2846
2903
|
.TP
|
|
@@ -2848,13 +2905,17 @@ Examples:
|
|
|
2848
2905
|
Skip the confirmation prompt
|
|
2849
2906
|
.TP
|
|
2850
2907
|
.B \-\-keep\-resources
|
|
2851
|
-
Delete only the YAML file; leave the .resources/ directory intact
|
|
2908
|
+
Delete only the YAML file; leave the .resources/ directory intact (local only)
|
|
2909
|
+
.TP
|
|
2910
|
+
.B \-\-api\-key <key>
|
|
2911
|
+
Postman API key (defaults to the `postman login` session)
|
|
2852
2912
|
|
|
2853
2913
|
.TP Examples:
|
|
2854
2914
|
|
|
2855
2915
|
Examples:
|
|
2856
2916
|
postman dataset delete ./postman/datasets/users/users.dataset.yaml
|
|
2857
2917
|
postman dataset delete ./postman/datasets/users/users.dataset.yaml \-\-yes
|
|
2918
|
+
postman dataset delete 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-\-yes
|
|
2858
2919
|
|
|
2859
2920
|
|
|
2860
2921
|
|
|
@@ -2867,32 +2928,39 @@ Examples:
|
|
|
2867
2928
|
.B Subcommands:
|
|
2868
2929
|
.TP
|
|
2869
2930
|
.B dataset source list
|
|
2870
|
-
[BETA] List the datasources defined on a dataset.
|
|
2931
|
+
[BETA] List the datasources defined on a dataset (local YAML path or cloud id).
|
|
2871
2932
|
.TP
|
|
2872
2933
|
.B dataset source add
|
|
2873
2934
|
[BETA] Add a datasource to a dataset.
|
|
2874
2935
|
.TP
|
|
2875
2936
|
.B dataset source remove
|
|
2876
|
-
[BETA] Remove a datasource from a dataset.
|
|
2937
|
+
[BETA] Remove a datasource from a dataset (local YAML path or cloud id).
|
|
2877
2938
|
.TP
|
|
2878
2939
|
.B dataset source update
|
|
2879
2940
|
[BETA] Update fields on an existing datasource. Only the flags you provide are changed.
|
|
2880
2941
|
|
|
2881
2942
|
.SS "dataset source list"
|
|
2882
|
-
[BETA] List the datasources defined on a dataset.
|
|
2943
|
+
[BETA] List the datasources defined on a dataset (local YAML path or cloud id).
|
|
2883
2944
|
|
|
2884
2945
|
.B Usage:
|
|
2885
|
-
[options]
|
|
2946
|
+
[options]
|
|
2886
2947
|
|
|
2887
2948
|
.B Options:
|
|
2888
2949
|
.TP
|
|
2950
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
2951
|
+
Dataset whose sources to list — a local .dataset.yaml path or a cloud dataset id
|
|
2952
|
+
.TP
|
|
2953
|
+
.B \-\-api\-key <key>
|
|
2954
|
+
Postman API key (defaults to the `postman login` session)
|
|
2955
|
+
.TP
|
|
2889
2956
|
.B \-\-json
|
|
2890
2957
|
Output sources as JSON instead of a table
|
|
2891
2958
|
|
|
2892
2959
|
.TP Examples:
|
|
2893
2960
|
|
|
2894
2961
|
Examples:
|
|
2895
|
-
postman dataset source list ./postman/datasets/users/users.dataset.yaml
|
|
2962
|
+
postman dataset source list \-d ./postman/datasets/users/users.dataset.yaml
|
|
2963
|
+
postman dataset source list \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
2896
2964
|
|
|
2897
2965
|
|
|
2898
2966
|
|
|
@@ -2900,14 +2968,17 @@ Examples:
|
|
|
2900
2968
|
[BETA] Add a datasource to a dataset.
|
|
2901
2969
|
|
|
2902
2970
|
.B Usage:
|
|
2903
|
-
[options]
|
|
2971
|
+
[options]
|
|
2904
2972
|
|
|
2905
2973
|
.B Options:
|
|
2906
2974
|
.TP
|
|
2975
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
2976
|
+
Dataset to add the source to — a local .dataset.yaml path or a cloud dataset id
|
|
2977
|
+
.TP
|
|
2907
2978
|
.B \-n, \-\-name <name>
|
|
2908
2979
|
Logical name for the source (becomes the SQL table name)
|
|
2909
2980
|
.TP
|
|
2910
|
-
.B \-\-id <uuid>
|
|
2981
|
+
.B \-\-source\-id <uuid>
|
|
2911
2982
|
Override the generated source id
|
|
2912
2983
|
.TP
|
|
2913
2984
|
.B \-\-format <csv|json|mysql|postgres>
|
|
@@ -2920,10 +2991,13 @@ Source kind; inferred from \-\-file/\-\-url when omitted
|
|
|
2920
2991
|
Path to a local CSV/JSON file (absolute or cwd\-relative)
|
|
2921
2992
|
.TP
|
|
2922
2993
|
.B \-\-ref\-only
|
|
2923
|
-
Reference the file in place; do NOT copy into data_dir
|
|
2994
|
+
Reference the file in place; do NOT copy into data_dir (local dataset)
|
|
2924
2995
|
.TP
|
|
2925
2996
|
.B \-\-force
|
|
2926
|
-
When copying, overwrite an existing file at the destination
|
|
2997
|
+
When copying, overwrite an existing file at the destination (local dataset)
|
|
2998
|
+
.TP
|
|
2999
|
+
.B \-\-upload
|
|
3000
|
+
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.
|
|
2927
3001
|
.TP
|
|
2928
3002
|
.B \-\-url <url>
|
|
2929
3003
|
HTTP(S) URL to a remote CSV/JSON file
|
|
@@ -2938,7 +3012,7 @@ DB port
|
|
|
2938
3012
|
DB user (warning: stored as plaintext in the YAML).
|
|
2939
3013
|
.TP
|
|
2940
3014
|
.B \-\-password <password>
|
|
2941
|
-
DB password
|
|
3015
|
+
DB password. WARNING: passing it here exposes it in `ps` output and shell history, and it is stored as plaintext in the dataset YAML (local) or sent in the request body (cloud). Prefer a restricted DB user; secure input (prompt / stdin / env) is planned.
|
|
2942
3016
|
.TP
|
|
2943
3017
|
.B \-\-database <db>
|
|
2944
3018
|
DB database name
|
|
@@ -2948,18 +3022,30 @@ DB table name (optional)
|
|
|
2948
3022
|
.TP
|
|
2949
3023
|
.B \-\-slug <slug>
|
|
2950
3024
|
Optional slug for the source
|
|
3025
|
+
.TP
|
|
3026
|
+
.B \-\-api\-key <key>
|
|
3027
|
+
Postman API key (defaults to the `postman login` session)
|
|
2951
3028
|
|
|
2952
3029
|
.SS "dataset source remove"
|
|
2953
|
-
[BETA] Remove a datasource from a dataset.
|
|
3030
|
+
[BETA] Remove a datasource from a dataset (local YAML path or cloud id).
|
|
2954
3031
|
|
|
2955
3032
|
.B Usage:
|
|
2956
|
-
[options] <
|
|
3033
|
+
[options] <sourceNameOrId>
|
|
3034
|
+
|
|
3035
|
+
.B Options:
|
|
3036
|
+
.TP
|
|
3037
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3038
|
+
Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3039
|
+
.TP
|
|
3040
|
+
.B \-\-api\-key <key>
|
|
3041
|
+
Postman API key (defaults to the `postman login` session)
|
|
2957
3042
|
|
|
2958
3043
|
.TP Examples:
|
|
2959
3044
|
|
|
2960
3045
|
Examples:
|
|
2961
|
-
postman dataset source remove ./users.dataset.yaml source_people_1
|
|
2962
|
-
postman dataset source remove ./users.dataset.yaml d3e67bc9\-f9a3\-43b5\-b894\-d00f1791258c
|
|
3046
|
+
postman dataset source remove \-d ./users.dataset.yaml source_people_1
|
|
3047
|
+
postman dataset source remove \-d ./users.dataset.yaml d3e67bc9\-f9a3\-43b5\-b894\-d00f1791258c
|
|
3048
|
+
postman dataset source remove \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de source_people_1
|
|
2963
3049
|
|
|
2964
3050
|
|
|
2965
3051
|
|
|
@@ -2967,10 +3053,13 @@ Examples:
|
|
|
2967
3053
|
[BETA] Update fields on an existing datasource. Only the flags you provide are changed.
|
|
2968
3054
|
|
|
2969
3055
|
.B Usage:
|
|
2970
|
-
[options] <
|
|
3056
|
+
[options] <sourceNameOrId>
|
|
2971
3057
|
|
|
2972
3058
|
.B Options:
|
|
2973
3059
|
.TP
|
|
3060
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3061
|
+
Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3062
|
+
.TP
|
|
2974
3063
|
.B \-n, \-\-name <name>
|
|
2975
3064
|
Rename the source
|
|
2976
3065
|
.TP
|
|
@@ -2999,7 +3088,7 @@ Update DB port
|
|
|
2999
3088
|
Update DB user (warning: stored as plaintext in the YAML).
|
|
3000
3089
|
.TP
|
|
3001
3090
|
.B \-\-password <password>
|
|
3002
|
-
Update DB password
|
|
3091
|
+
Update DB password. WARNING: passing it here exposes it in `ps` output and shell history, and it is stored as plaintext in the dataset YAML (local) or sent in the request body (cloud). Prefer a restricted DB user; secure input (prompt / stdin / env) is planned.
|
|
3003
3092
|
.TP
|
|
3004
3093
|
.B \-\-database <db>
|
|
3005
3094
|
Update DB database name
|
|
@@ -3009,6 +3098,9 @@ Update DB table name
|
|
|
3009
3098
|
.TP
|
|
3010
3099
|
.B \-\-slug <slug>
|
|
3011
3100
|
Update slug
|
|
3101
|
+
.TP
|
|
3102
|
+
.B \-\-api\-key <key>
|
|
3103
|
+
Postman API key (defaults to the `postman login` session)
|
|
3012
3104
|
|
|
3013
3105
|
.SS "dataset view"
|
|
3014
3106
|
[BETA] Inspect and manage saved views on a dataset.
|
|
@@ -3019,35 +3111,42 @@ Update slug
|
|
|
3019
3111
|
.B Subcommands:
|
|
3020
3112
|
.TP
|
|
3021
3113
|
.B dataset view list
|
|
3022
|
-
[BETA] List the saved views defined on a dataset.
|
|
3114
|
+
[BETA] List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3023
3115
|
.TP
|
|
3024
3116
|
.B dataset view run
|
|
3025
3117
|
[BETA] Execute a saved view against a dataset and print the rows.
|
|
3026
3118
|
.TP
|
|
3027
3119
|
.B dataset view create
|
|
3028
|
-
[BETA] Add a saved view to a dataset.
|
|
3120
|
+
[BETA] Add a saved view to a dataset (local YAML path or cloud id).
|
|
3029
3121
|
.TP
|
|
3030
3122
|
.B dataset view delete
|
|
3031
|
-
[BETA] Remove a saved view from a dataset.
|
|
3123
|
+
[BETA] Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3032
3124
|
.TP
|
|
3033
3125
|
.B dataset view update
|
|
3034
|
-
[BETA] Update name and/or query on an existing view.
|
|
3126
|
+
[BETA] Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3035
3127
|
|
|
3036
3128
|
.SS "dataset view list"
|
|
3037
|
-
[BETA] List the saved views defined on a dataset.
|
|
3129
|
+
[BETA] List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3038
3130
|
|
|
3039
3131
|
.B Usage:
|
|
3040
|
-
[options]
|
|
3132
|
+
[options]
|
|
3041
3133
|
|
|
3042
3134
|
.B Options:
|
|
3043
3135
|
.TP
|
|
3136
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3137
|
+
Dataset whose views to list — a local .dataset.yaml path or a cloud dataset id
|
|
3138
|
+
.TP
|
|
3139
|
+
.B \-\-api\-key <key>
|
|
3140
|
+
Postman API key (defaults to the `postman login` session)
|
|
3141
|
+
.TP
|
|
3044
3142
|
.B \-\-json
|
|
3045
3143
|
Output views as JSON instead of a table
|
|
3046
3144
|
|
|
3047
3145
|
.TP Examples:
|
|
3048
3146
|
|
|
3049
3147
|
Examples:
|
|
3050
|
-
postman dataset view list ./postman/datasets/users/users.dataset.yaml
|
|
3148
|
+
postman dataset view list \-d ./postman/datasets/users/users.dataset.yaml
|
|
3149
|
+
postman dataset view list \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
3051
3150
|
|
|
3052
3151
|
|
|
3053
3152
|
|
|
@@ -3055,80 +3154,111 @@ Examples:
|
|
|
3055
3154
|
[BETA] Execute a saved view against a dataset and print the rows.
|
|
3056
3155
|
|
|
3057
3156
|
.B Usage:
|
|
3058
|
-
[options] <
|
|
3157
|
+
[options] <viewNameOrId>
|
|
3059
3158
|
|
|
3060
3159
|
.B Options:
|
|
3061
3160
|
.TP
|
|
3161
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3162
|
+
Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3163
|
+
.TP
|
|
3062
3164
|
.B \-p, \-\-param <value...>
|
|
3063
3165
|
Positional parameter values for $1, $2, ... bindings; repeatable
|
|
3064
3166
|
.TP
|
|
3167
|
+
.B \-\-api\-key <key>
|
|
3168
|
+
Postman API key (defaults to the `postman login` session)
|
|
3169
|
+
.TP
|
|
3065
3170
|
.B \-\-json
|
|
3066
3171
|
Output rows as JSON instead of a table
|
|
3067
3172
|
|
|
3068
3173
|
.TP Examples:
|
|
3069
3174
|
|
|
3070
3175
|
Examples:
|
|
3071
|
-
postman dataset view run ./users.dataset.yaml
|
|
3072
|
-
postman dataset view run
|
|
3176
|
+
postman dataset view run "Active Users" \-d ./users.dataset.yaml
|
|
3177
|
+
postman dataset view run ea748a6a\-ed3c\-496d\-b91e\-6ccc8e4d0e9d \-d ./users.dataset.yaml
|
|
3178
|
+
postman dataset view run "Active Users" \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
3073
3179
|
|
|
3074
3180
|
|
|
3075
3181
|
|
|
3076
3182
|
.SS "dataset view create"
|
|
3077
|
-
[BETA] Add a saved view to a dataset.
|
|
3183
|
+
[BETA] Add a saved view to a dataset (local YAML path or cloud id).
|
|
3078
3184
|
|
|
3079
3185
|
.B Usage:
|
|
3080
|
-
[options]
|
|
3186
|
+
[options]
|
|
3081
3187
|
|
|
3082
3188
|
.B Options:
|
|
3083
3189
|
.TP
|
|
3190
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3191
|
+
Dataset to add the view to — a local .dataset.yaml path or a cloud dataset id
|
|
3192
|
+
.TP
|
|
3084
3193
|
.B \-n, \-\-name <name>
|
|
3085
3194
|
View name
|
|
3086
3195
|
.TP
|
|
3087
3196
|
.B \-q, \-\-query <sql>
|
|
3088
3197
|
SQL query the view executes
|
|
3089
3198
|
.TP
|
|
3090
|
-
.B \-\-id <uuid>
|
|
3091
|
-
Override the generated view id
|
|
3199
|
+
.B \-\-view\-id <uuid>
|
|
3200
|
+
Override the generated view id (local only; cloud assigns its own)
|
|
3201
|
+
.TP
|
|
3202
|
+
.B \-\-api\-key <key>
|
|
3203
|
+
Postman API key (defaults to the `postman login` session)
|
|
3092
3204
|
|
|
3093
3205
|
.TP Examples:
|
|
3094
3206
|
|
|
3095
3207
|
Examples:
|
|
3096
|
-
postman dataset view create ./users.dataset.yaml \e
|
|
3208
|
+
postman dataset view create \-d ./users.dataset.yaml \e
|
|
3097
3209
|
\-n "Active Users" \-q "SELECT * FROM source_users WHERE active = true"
|
|
3210
|
+
postman dataset view create \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \e
|
|
3211
|
+
\-n "Active Users" \-q "SELECT * FROM users WHERE active = true"
|
|
3098
3212
|
|
|
3099
3213
|
|
|
3100
3214
|
|
|
3101
3215
|
.SS "dataset view delete"
|
|
3102
|
-
[BETA] Remove a saved view from a dataset.
|
|
3216
|
+
[BETA] Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3103
3217
|
|
|
3104
3218
|
.B Usage:
|
|
3105
|
-
[options] <
|
|
3219
|
+
[options] <viewNameOrId>
|
|
3220
|
+
|
|
3221
|
+
.B Options:
|
|
3222
|
+
.TP
|
|
3223
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3224
|
+
Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3225
|
+
.TP
|
|
3226
|
+
.B \-\-api\-key <key>
|
|
3227
|
+
Postman API key (defaults to the `postman login` session)
|
|
3106
3228
|
|
|
3107
3229
|
.TP Examples:
|
|
3108
3230
|
|
|
3109
3231
|
Examples:
|
|
3110
|
-
postman dataset view delete ./users.dataset.yaml "Active Users"
|
|
3232
|
+
postman dataset view delete \-d ./users.dataset.yaml "Active Users"
|
|
3233
|
+
postman dataset view delete \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de "Active Users"
|
|
3111
3234
|
|
|
3112
3235
|
|
|
3113
3236
|
|
|
3114
3237
|
.SS "dataset view update"
|
|
3115
|
-
[BETA] Update name and/or query on an existing view.
|
|
3238
|
+
[BETA] Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3116
3239
|
|
|
3117
3240
|
.B Usage:
|
|
3118
|
-
[options] <
|
|
3241
|
+
[options] <viewNameOrId>
|
|
3119
3242
|
|
|
3120
3243
|
.B Options:
|
|
3121
3244
|
.TP
|
|
3245
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3246
|
+
Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3247
|
+
.TP
|
|
3122
3248
|
.B \-n, \-\-name <name>
|
|
3123
3249
|
New view name
|
|
3124
3250
|
.TP
|
|
3125
3251
|
.B \-q, \-\-query <sql>
|
|
3126
3252
|
New SQL query
|
|
3253
|
+
.TP
|
|
3254
|
+
.B \-\-api\-key <key>
|
|
3255
|
+
Postman API key (defaults to the `postman login` session)
|
|
3127
3256
|
|
|
3128
3257
|
.TP Examples:
|
|
3129
3258
|
|
|
3130
3259
|
Examples:
|
|
3131
|
-
postman dataset view update ./users.dataset.yaml
|
|
3260
|
+
postman dataset view update "Active Users" \-d ./users.dataset.yaml \-q "SELECT ..."
|
|
3261
|
+
postman dataset view update "Active Users" \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT ..."
|
|
3132
3262
|
|
|
3133
3263
|
|
|
3134
3264
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.45.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.45.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.45.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.45.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.45.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.45.0"
|
|
66
66
|
}
|
|
67
67
|
}
|