postman-cli 1.44.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.
Files changed (2) hide show
  1. package/man/postman.1 +201 -62
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-07-22" "v1.44.0" "Postman CLI Manual"
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 <path>
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,12 +491,48 @@ 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
501
  Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.
499
502
 
503
+ .SS "workspace list"
504
+ List all available Postman Workspaces
505
+
506
+ .B Usage:
507
+ [options]
508
+
509
+ .B Options:
510
+ .TP
511
+ .B \-f, \-\-filter <name>
512
+ Filter workspaces by name.
513
+ .TP
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
+
500
536
  .SS "workspace prepare"
501
537
  Prepare local collections and environments for push by validating and regenerating IDs if needed.
502
538
 
@@ -1219,7 +1255,7 @@ Generate and manage your SDKs directly from the command line.
1219
1255
  Create or update .postman/config.json with an SDK configuration stub.
1220
1256
  .TP
1221
1257
  .B sdk generate
1222
- Generate a new SDK from a Postman collection or specification.
1258
+ Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).
1223
1259
  .TP
1224
1260
  .B sdk track
1225
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.
@@ -1248,7 +1284,7 @@ Create or update .postman/config.json with an SDK configuration stub.
1248
1284
  Skip prompts and overwrite existing sdk config
1249
1285
 
1250
1286
  .SS "sdk generate"
1251
- Generate a new SDK from a Postman collection or specification.
1287
+ Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).
1252
1288
 
1253
1289
  .B Usage:
1254
1290
  <idOrPath> [options]
@@ -1308,6 +1344,8 @@ Input:
1308
1344
  \- A file path to a collection (.json) or specification (.json, .yaml, .yml) file
1309
1345
  \- A URL to a publicly accessible collection or specification file
1310
1346
 
1347
+ Supported specification formats: OpenAPI (2.0/3.x) and AsyncAPI (2.x/3.x).
1348
+
1311
1349
  When using an ID, the SDK generation updates the version in Postman Cloud.
1312
1350
  When using a file path or URL, a one\-off build is created that does not update the Postman Cloud.
1313
1351
 
@@ -1327,6 +1365,9 @@ Examples:
1327
1365
  Generate SDK from OpenAPI specification file (one\-off build):
1328
1366
  postman sdk generate ./openapi.yaml \-l typescript \-o ./my\-sdk
1329
1367
 
1368
+ Generate SDK from AsyncAPI specification file (one\-off build):
1369
+ postman sdk generate ./asyncapi.yaml \-l typescript \-o ./my\-sdk
1370
+
1330
1371
  Generate SDK from publicly accessible URL (one\-off build):
1331
1372
  postman sdk generate https://petstore.swagger.io/v2/swagger.json \-l typescript \-o ./my\-sdk
1332
1373
 
@@ -2718,19 +2759,19 @@ Examples:
2718
2759
  .B Subcommands:
2719
2760
  .TP
2720
2761
  .B dataset list
2721
- [BETA] List dataset YAMLs under the given directory, or print summary for a single YAML file.
2762
+ [BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
2722
2763
  .TP
2723
2764
  .B dataset get
2724
- [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).
2725
2766
  .TP
2726
2767
  .B dataset query
2727
- [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).
2728
2769
  .TP
2729
2770
  .B dataset create
2730
- [BETA] Scaffold a new empty .dataset.yaml file at <path>.
2771
+ [BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
2731
2772
  .TP
2732
2773
  .B dataset delete
2733
- [BETA] Permanently remove a dataset's .dataset.yaml file and its .resources/ directory.
2774
+ [BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
2734
2775
  .TP
2735
2776
  .B dataset source
2736
2777
  [BETA] Inspect and manage a dataset's datasources.
@@ -2739,13 +2780,19 @@ Examples:
2739
2780
  [BETA] Inspect and manage saved views on a dataset.
2740
2781
 
2741
2782
  .SS "dataset list"
2742
- [BETA] List dataset YAMLs under the given directory, or print summary for a single YAML file.
2783
+ [BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
2743
2784
 
2744
2785
  .B Usage:
2745
- [options] <pathOrDir>
2786
+ [options] [pathOrDir]
2746
2787
 
2747
2788
  .B Options:
2748
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
2749
2796
  .B \-\-json
2750
2797
  Output as JSON instead of a table
2751
2798
 
@@ -2754,32 +2801,40 @@ Output as JSON instead of a table
2754
2801
  Examples:
2755
2802
  postman dataset list ./postman/datasets
2756
2803
  postman dataset list ./postman/datasets/users/users.dataset.yaml
2804
+ postman dataset list \-w 12345678\-90ab\-cdef\-1234\-567890abcdef
2757
2805
 
2758
2806
 
2759
2807
 
2760
2808
  .SS "dataset get"
2761
- [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).
2762
2810
 
2763
2811
  .B Usage:
2764
- [options] <path>
2812
+ [options] <datasetPathOrId>
2765
2813
 
2766
2814
  .B Options:
2767
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
2768
2822
  .B \-\-json
2769
- Output the full parsed YAML as JSON
2823
+ Output the full dataset as JSON
2770
2824
 
2771
2825
  .TP Examples:
2772
2826
 
2773
2827
  Examples:
2774
2828
  postman dataset get ./postman/datasets/users/users.dataset.yaml
2829
+ postman dataset get 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
2775
2830
 
2776
2831
 
2777
2832
 
2778
2833
  .SS "dataset query"
2779
- [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).
2780
2835
 
2781
2836
  .B Usage:
2782
- [options] <path>
2837
+ [options] <datasetPathOrId>
2783
2838
 
2784
2839
  .B Options:
2785
2840
  .TP
@@ -2789,6 +2844,9 @@ SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
2789
2844
  .B \-p, \-\-param <value...>
2790
2845
  Positional parameter values for $1, $2, ... bindings; repeatable
2791
2846
  .TP
2847
+ .B \-\-api\-key <key>
2848
+ Postman API key (defaults to the `postman login` session)
2849
+ .TP
2792
2850
  .B \-\-json
2793
2851
  Output rows as JSON instead of a table
2794
2852
 
@@ -2797,14 +2855,15 @@ Output rows as JSON instead of a table
2797
2855
  Examples:
2798
2856
  postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
2799
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"
2800
2859
 
2801
2860
 
2802
2861
 
2803
2862
  .SS "dataset create"
2804
- [BETA] Scaffold a new empty .dataset.yaml file at <path>.
2863
+ [BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
2805
2864
 
2806
2865
  .B Usage:
2807
- [options] <path>
2866
+ [options] [path]
2808
2867
 
2809
2868
  .B Options:
2810
2869
  .TP
@@ -2814,24 +2873,31 @@ Human\-readable name for the dataset
2814
2873
  .B \-d, \-\-description <desc>
2815
2874
  Optional description
2816
2875
  .TP
2817
- .B \-\-id <uuid>
2818
- 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)
2819
2878
  .TP
2820
2879
  .B \-\-force
2821
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)
2822
2887
 
2823
2888
  .TP Examples:
2824
2889
 
2825
2890
  Examples:
2826
2891
  postman dataset create ./postman/datasets/users/users.dataset.yaml \-\-name "Users"
2892
+ postman dataset create \-\-name "Users" \-w 12345678\-90ab\-cdef\-1234\-567890abcdef
2827
2893
 
2828
2894
 
2829
2895
 
2830
2896
  .SS "dataset delete"
2831
- [BETA] Permanently remove a dataset's .dataset.yaml file and its .resources/ directory.
2897
+ [BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
2832
2898
 
2833
2899
  .B Usage:
2834
- [options] <path>
2900
+ [options] <datasetPathOrId>
2835
2901
 
2836
2902
  .B Options:
2837
2903
  .TP
@@ -2839,13 +2905,17 @@ Examples:
2839
2905
  Skip the confirmation prompt
2840
2906
  .TP
2841
2907
  .B \-\-keep\-resources
2842
- 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)
2843
2912
 
2844
2913
  .TP Examples:
2845
2914
 
2846
2915
  Examples:
2847
2916
  postman dataset delete ./postman/datasets/users/users.dataset.yaml
2848
2917
  postman dataset delete ./postman/datasets/users/users.dataset.yaml \-\-yes
2918
+ postman dataset delete 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-\-yes
2849
2919
 
2850
2920
 
2851
2921
 
@@ -2858,32 +2928,39 @@ Examples:
2858
2928
  .B Subcommands:
2859
2929
  .TP
2860
2930
  .B dataset source list
2861
- [BETA] List the datasources defined on a dataset.
2931
+ [BETA] List the datasources defined on a dataset (local YAML path or cloud id).
2862
2932
  .TP
2863
2933
  .B dataset source add
2864
2934
  [BETA] Add a datasource to a dataset.
2865
2935
  .TP
2866
2936
  .B dataset source remove
2867
- [BETA] Remove a datasource from a dataset.
2937
+ [BETA] Remove a datasource from a dataset (local YAML path or cloud id).
2868
2938
  .TP
2869
2939
  .B dataset source update
2870
2940
  [BETA] Update fields on an existing datasource. Only the flags you provide are changed.
2871
2941
 
2872
2942
  .SS "dataset source list"
2873
- [BETA] List the datasources defined on a dataset.
2943
+ [BETA] List the datasources defined on a dataset (local YAML path or cloud id).
2874
2944
 
2875
2945
  .B Usage:
2876
- [options] <path>
2946
+ [options]
2877
2947
 
2878
2948
  .B Options:
2879
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
2880
2956
  .B \-\-json
2881
2957
  Output sources as JSON instead of a table
2882
2958
 
2883
2959
  .TP Examples:
2884
2960
 
2885
2961
  Examples:
2886
- 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
2887
2964
 
2888
2965
 
2889
2966
 
@@ -2891,14 +2968,17 @@ Examples:
2891
2968
  [BETA] Add a datasource to a dataset.
2892
2969
 
2893
2970
  .B Usage:
2894
- [options] <pathOrId>
2971
+ [options]
2895
2972
 
2896
2973
  .B Options:
2897
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
2898
2978
  .B \-n, \-\-name <name>
2899
2979
  Logical name for the source (becomes the SQL table name)
2900
2980
  .TP
2901
- .B \-\-id <uuid>
2981
+ .B \-\-source\-id <uuid>
2902
2982
  Override the generated source id
2903
2983
  .TP
2904
2984
  .B \-\-format <csv|json|mysql|postgres>
@@ -2911,10 +2991,13 @@ Source kind; inferred from \-\-file/\-\-url when omitted
2911
2991
  Path to a local CSV/JSON file (absolute or cwd\-relative)
2912
2992
  .TP
2913
2993
  .B \-\-ref\-only
2914
- 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)
2915
2995
  .TP
2916
2996
  .B \-\-force
2917
- 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.
2918
3001
  .TP
2919
3002
  .B \-\-url <url>
2920
3003
  HTTP(S) URL to a remote CSV/JSON file
@@ -2929,7 +3012,7 @@ DB port
2929
3012
  DB user (warning: stored as plaintext in the YAML).
2930
3013
  .TP
2931
3014
  .B \-\-password <password>
2932
- DB password (warning: stored as plaintext in the YAML).
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.
2933
3016
  .TP
2934
3017
  .B \-\-database <db>
2935
3018
  DB database name
@@ -2939,18 +3022,30 @@ DB table name (optional)
2939
3022
  .TP
2940
3023
  .B \-\-slug <slug>
2941
3024
  Optional slug for the source
3025
+ .TP
3026
+ .B \-\-api\-key <key>
3027
+ Postman API key (defaults to the `postman login` session)
2942
3028
 
2943
3029
  .SS "dataset source remove"
2944
- [BETA] Remove a datasource from a dataset.
3030
+ [BETA] Remove a datasource from a dataset (local YAML path or cloud id).
2945
3031
 
2946
3032
  .B Usage:
2947
- [options] <path> <sourceNameOrId>
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)
2948
3042
 
2949
3043
  .TP Examples:
2950
3044
 
2951
3045
  Examples:
2952
- postman dataset source remove ./users.dataset.yaml source_people_1
2953
- 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
2954
3049
 
2955
3050
 
2956
3051
 
@@ -2958,10 +3053,13 @@ Examples:
2958
3053
  [BETA] Update fields on an existing datasource. Only the flags you provide are changed.
2959
3054
 
2960
3055
  .B Usage:
2961
- [options] <pathOrId> <sourceNameOrId>
3056
+ [options] <sourceNameOrId>
2962
3057
 
2963
3058
  .B Options:
2964
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
2965
3063
  .B \-n, \-\-name <name>
2966
3064
  Rename the source
2967
3065
  .TP
@@ -2990,7 +3088,7 @@ Update DB port
2990
3088
  Update DB user (warning: stored as plaintext in the YAML).
2991
3089
  .TP
2992
3090
  .B \-\-password <password>
2993
- Update DB password (warning: stored as plaintext in the YAML).
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.
2994
3092
  .TP
2995
3093
  .B \-\-database <db>
2996
3094
  Update DB database name
@@ -3000,6 +3098,9 @@ Update DB table name
3000
3098
  .TP
3001
3099
  .B \-\-slug <slug>
3002
3100
  Update slug
3101
+ .TP
3102
+ .B \-\-api\-key <key>
3103
+ Postman API key (defaults to the `postman login` session)
3003
3104
 
3004
3105
  .SS "dataset view"
3005
3106
  [BETA] Inspect and manage saved views on a dataset.
@@ -3010,35 +3111,42 @@ Update slug
3010
3111
  .B Subcommands:
3011
3112
  .TP
3012
3113
  .B dataset view list
3013
- [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).
3014
3115
  .TP
3015
3116
  .B dataset view run
3016
3117
  [BETA] Execute a saved view against a dataset and print the rows.
3017
3118
  .TP
3018
3119
  .B dataset view create
3019
- [BETA] Add a saved view to a dataset.
3120
+ [BETA] Add a saved view to a dataset (local YAML path or cloud id).
3020
3121
  .TP
3021
3122
  .B dataset view delete
3022
- [BETA] Remove a saved view from a dataset.
3123
+ [BETA] Remove a saved view from a dataset (local YAML path or cloud id).
3023
3124
  .TP
3024
3125
  .B dataset view update
3025
- [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).
3026
3127
 
3027
3128
  .SS "dataset view list"
3028
- [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).
3029
3130
 
3030
3131
  .B Usage:
3031
- [options] <path>
3132
+ [options]
3032
3133
 
3033
3134
  .B Options:
3034
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
3035
3142
  .B \-\-json
3036
3143
  Output views as JSON instead of a table
3037
3144
 
3038
3145
  .TP Examples:
3039
3146
 
3040
3147
  Examples:
3041
- 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
3042
3150
 
3043
3151
 
3044
3152
 
@@ -3046,80 +3154,111 @@ Examples:
3046
3154
  [BETA] Execute a saved view against a dataset and print the rows.
3047
3155
 
3048
3156
  .B Usage:
3049
- [options] <path> <viewNameOrId>
3157
+ [options] <viewNameOrId>
3050
3158
 
3051
3159
  .B Options:
3052
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
3053
3164
  .B \-p, \-\-param <value...>
3054
3165
  Positional parameter values for $1, $2, ... bindings; repeatable
3055
3166
  .TP
3167
+ .B \-\-api\-key <key>
3168
+ Postman API key (defaults to the `postman login` session)
3169
+ .TP
3056
3170
  .B \-\-json
3057
3171
  Output rows as JSON instead of a table
3058
3172
 
3059
3173
  .TP Examples:
3060
3174
 
3061
3175
  Examples:
3062
- postman dataset view run ./users.dataset.yaml "Active Users"
3063
- postman dataset view run ./users.dataset.yaml ea748a6a\-ed3c\-496d\-b91e\-6ccc8e4d0e9d
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
3064
3179
 
3065
3180
 
3066
3181
 
3067
3182
  .SS "dataset view create"
3068
- [BETA] Add a saved view to a dataset.
3183
+ [BETA] Add a saved view to a dataset (local YAML path or cloud id).
3069
3184
 
3070
3185
  .B Usage:
3071
- [options] <path>
3186
+ [options]
3072
3187
 
3073
3188
  .B Options:
3074
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
3075
3193
  .B \-n, \-\-name <name>
3076
3194
  View name
3077
3195
  .TP
3078
3196
  .B \-q, \-\-query <sql>
3079
3197
  SQL query the view executes
3080
3198
  .TP
3081
- .B \-\-id <uuid>
3082
- 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)
3083
3204
 
3084
3205
  .TP Examples:
3085
3206
 
3086
3207
  Examples:
3087
- postman dataset view create ./users.dataset.yaml \e
3208
+ postman dataset view create \-d ./users.dataset.yaml \e
3088
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"
3089
3212
 
3090
3213
 
3091
3214
 
3092
3215
  .SS "dataset view delete"
3093
- [BETA] Remove a saved view from a dataset.
3216
+ [BETA] Remove a saved view from a dataset (local YAML path or cloud id).
3094
3217
 
3095
3218
  .B Usage:
3096
- [options] <path> <viewNameOrId>
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)
3097
3228
 
3098
3229
  .TP Examples:
3099
3230
 
3100
3231
  Examples:
3101
- 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"
3102
3234
 
3103
3235
 
3104
3236
 
3105
3237
  .SS "dataset view update"
3106
- [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).
3107
3239
 
3108
3240
  .B Usage:
3109
- [options] <path> <viewNameOrId>
3241
+ [options] <viewNameOrId>
3110
3242
 
3111
3243
  .B Options:
3112
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
3113
3248
  .B \-n, \-\-name <name>
3114
3249
  New view name
3115
3250
  .TP
3116
3251
  .B \-q, \-\-query <sql>
3117
3252
  New SQL query
3253
+ .TP
3254
+ .B \-\-api\-key <key>
3255
+ Postman API key (defaults to the `postman login` session)
3118
3256
 
3119
3257
  .TP Examples:
3120
3258
 
3121
3259
  Examples:
3122
- postman dataset view update ./users.dataset.yaml "Active Users" \-q "SELECT ..."
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 ..."
3123
3262
 
3124
3263
 
3125
3264
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.44.0",
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.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"
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
  }