postman-cli 1.39.2 → 1.41.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 +443 -5
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-06-18" "v1.39.2" "Postman CLI Manual"
1
+ .TH POSTMAN 1 "2026-06-30" "v1.41.0" "Postman CLI Manual"
2
2
  .SH NAME
3
3
  postman \- Command\-line companion utility for Postman
4
4
  .SH SYNOPSIS
@@ -169,6 +169,15 @@ Define the number of iterations to run
169
169
  .B \-d, \-\-iteration\-data <path>
170
170
  Specify a data file to use for iterations (either JSON or CSV)
171
171
  .TP
172
+ .B \-\-iteration\-data\-dataset <path>
173
+ [BETA] Path to a .dataset.yaml whose view drives the iteration data. Mutually exclusive with \-\-iteration\-data. Requires \-\-iteration\-data\-view.
174
+ .TP
175
+ .B \-\-iteration\-data\-view <nameOrId>
176
+ [BETA] Name or id of the view to execute (within \-\-iteration\-data\-dataset). The view's result set drives one iteration per row.
177
+ .TP
178
+ .B \-\-dataset <pathOrDir>
179
+ [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: )
180
+ .TP
172
181
  .B \-i <id>
173
182
  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: )
174
183
  .TP
@@ -483,7 +492,7 @@ Manage workspace resources.
483
492
  Prepare local collections and environments for push by validating and regenerating IDs if needed.
484
493
  .TP
485
494
  .B workspace push
486
- Push local collection, environment, and specification changes to Postman workspace.
495
+ Push local collection, environment, specification, mock, and simulation changes to Postman workspace.
487
496
 
488
497
  .SS "workspace prepare"
489
498
  Prepare local collections and environments for push by validating and regenerating IDs if needed.
@@ -498,9 +507,12 @@ Path to the collections directory (default: postman/collections)
498
507
  .TP
499
508
  .B \-\-environments\-dir <path>
500
509
  Path to the environments directory (default: postman/environments)
510
+ .TP
511
+ .B \-\-verbose
512
+ Show detailed logging
501
513
 
502
514
  .SS "workspace push"
503
- Push local collection, environment, and specification changes to Postman workspace.
515
+ Push local collection, environment, specification, mock, and simulation changes to Postman workspace.
504
516
 
505
517
  .B Usage:
506
518
  [options]
@@ -519,6 +531,9 @@ Skip ID validation and auto\-fix before pushing
519
531
  .B \-y, \-\-yes
520
532
  Skip all confirmation prompts
521
533
  .TP
534
+ .B \-\-verbose
535
+ Show detailed logging
536
+ .TP
522
537
  .B \-\-report\-events
523
538
  Report run events
524
539
 
@@ -562,6 +577,9 @@ Path to a JSON or CSV data file to use with the collection
562
577
  .B \-\-postman\-api\-key <apiKey>
563
578
  API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
564
579
  .TP
580
+ .B \-\-cloud
581
+ Execute the performance test on Postman Cloud (beta) (default: false)
582
+ .TP
565
583
  .B \-\-pass\-if <condition>
566
584
  Pass condition in format: function(metric, value).
567
585
  Functions: less_than, greater_than, less_than_eq, greater_than_eq.
@@ -962,6 +980,9 @@ Add JavaScript script to run before the request. Can be inline JS or @filepath t
962
980
  .B \-\-script\-post\-request <script>
963
981
  Add JavaScript script to run after the request. Can be inline JS or @filepath to load from file. Scripts have access to pm.* APIs. Example: \-\-script\-post\-request "console.log(pm.response.json());" or \-\-script\-post\-request @validate.js
964
982
  .TP
983
+ .B \-\-dataset <pathOrDir>
984
+ [BETA] Pass \-\-dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to pre/post\-request scripts as pm.datasets(<id>). (default: )
985
+ .TP
965
986
  .B \-o, \-\-output <path>
966
987
  Save complete response to JSON file.Useful for debugging or further processing.
967
988
  .TP
@@ -1474,8 +1495,8 @@ Target branch for SDK pull requests (default: main)
1474
1495
  .B \-\-push\-to\-base
1475
1496
  Push SDK updates directly to the base branch instead of opening a pull request (default: false)
1476
1497
  .TP
1477
- .B \-\-enable\-npm\-publishing
1478
- Inject a GitHub Actions workflow that publishes to npm on merge (TypeScript only) (default: false)
1498
+ .B \-\-auto\-update\-pull\-requests <bool>
1499
+ Open auto\-update pull requests when the SDK changes (true|false). Defaults to true server\-side when omitted
1479
1500
  .TP
1480
1501
  .B \-\-auth\-provider <provider>
1481
1502
  OAuth provider used by the server when pushing (choices: githubapp, github) (default: githubapp)
@@ -1506,6 +1527,9 @@ Examples:
1506
1527
  Push SDK updates straight to base instead of opening a pull request:
1507
1528
  postman sdk connect github 12345\-abcde\-67890 \-l java \-\-repo my\-org/java\-sdk \-\-push\-to\-base
1508
1529
 
1530
+ Connect without opening auto\-update pull requests on SDK changes:
1531
+ postman sdk connect github 12345\-abcde\-67890 \-l go \-\-repo my\-org/go\-sdk \-\-auto\-update\-pull\-requests false
1532
+
1509
1533
 
1510
1534
 
1511
1535
  .SS "sdk connections"
@@ -2604,6 +2628,420 @@ Examples:
2604
2628
 
2605
2629
 
2606
2630
 
2631
+ .SS "dataset"
2632
+ [BETA] Work with Postman datasets defined in local YAML files.
2633
+
2634
+ .B Usage:
2635
+ [options] [command]
2636
+
2637
+ .B Subcommands:
2638
+ .TP
2639
+ .B dataset list
2640
+ [BETA] List dataset YAMLs under the given directory, or print summary for a single YAML file.
2641
+ .TP
2642
+ .B dataset get
2643
+ [BETA] Print a dataset's metadata and structure summary.
2644
+ .TP
2645
+ .B dataset query
2646
+ [BETA] Run an ad\-hoc SQL query against a dataset.
2647
+ .TP
2648
+ .B dataset create
2649
+ [BETA] Scaffold a new empty .dataset.yaml file at <path>.
2650
+ .TP
2651
+ .B dataset delete
2652
+ [BETA] Permanently remove a dataset's .dataset.yaml file and its .resources/ directory.
2653
+ .TP
2654
+ .B dataset source
2655
+ [BETA] Inspect and manage a dataset's datasources.
2656
+ .TP
2657
+ .B dataset view
2658
+ [BETA] Inspect and manage saved views on a dataset.
2659
+
2660
+ .SS "dataset list"
2661
+ [BETA] List dataset YAMLs under the given directory, or print summary for a single YAML file.
2662
+
2663
+ .B Usage:
2664
+ [options] <pathOrDir>
2665
+
2666
+ .B Options:
2667
+ .TP
2668
+ .B \-\-json
2669
+ Output as JSON instead of a table
2670
+
2671
+ .TP Examples:
2672
+
2673
+ Examples:
2674
+ postman dataset list ./postman/datasets
2675
+ postman dataset list ./postman/datasets/users/users.dataset.yaml
2676
+
2677
+
2678
+
2679
+ .SS "dataset get"
2680
+ [BETA] Print a dataset's metadata and structure summary.
2681
+
2682
+ .B Usage:
2683
+ [options] <path>
2684
+
2685
+ .B Options:
2686
+ .TP
2687
+ .B \-\-json
2688
+ Output the full parsed YAML as JSON
2689
+
2690
+ .TP Examples:
2691
+
2692
+ Examples:
2693
+ postman dataset get ./postman/datasets/users/users.dataset.yaml
2694
+
2695
+
2696
+
2697
+ .SS "dataset query"
2698
+ [BETA] Run an ad\-hoc SQL query against a dataset.
2699
+
2700
+ .B Usage:
2701
+ [options] <path>
2702
+
2703
+ .B Options:
2704
+ .TP
2705
+ .B \-q, \-\-query <sql>
2706
+ SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
2707
+ .TP
2708
+ .B \-p, \-\-param <value...>
2709
+ Positional parameter values for $1, $2, ... bindings; repeatable
2710
+ .TP
2711
+ .B \-\-json
2712
+ Output rows as JSON instead of a table
2713
+
2714
+ .TP Examples:
2715
+
2716
+ Examples:
2717
+ postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
2718
+ postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users WHERE id = $1" \-p 42
2719
+
2720
+
2721
+
2722
+ .SS "dataset create"
2723
+ [BETA] Scaffold a new empty .dataset.yaml file at <path>.
2724
+
2725
+ .B Usage:
2726
+ [options] <path>
2727
+
2728
+ .B Options:
2729
+ .TP
2730
+ .B \-n, \-\-name <name>
2731
+ Human\-readable name for the dataset
2732
+ .TP
2733
+ .B \-d, \-\-description <desc>
2734
+ Optional description
2735
+ .TP
2736
+ .B \-\-id <uuid>
2737
+ Override the generated dataset id (defaults to a random v4 UUID)
2738
+ .TP
2739
+ .B \-\-force
2740
+ Overwrite an existing file at <path>
2741
+
2742
+ .TP Examples:
2743
+
2744
+ Examples:
2745
+ postman dataset create ./postman/datasets/users/users.dataset.yaml \-\-name "Users"
2746
+
2747
+
2748
+
2749
+ .SS "dataset delete"
2750
+ [BETA] Permanently remove a dataset's .dataset.yaml file and its .resources/ directory.
2751
+
2752
+ .B Usage:
2753
+ [options] <path>
2754
+
2755
+ .B Options:
2756
+ .TP
2757
+ .B \-y, \-\-yes
2758
+ Skip the confirmation prompt
2759
+ .TP
2760
+ .B \-\-keep\-resources
2761
+ Delete only the YAML file; leave the .resources/ directory intact
2762
+
2763
+ .TP Examples:
2764
+
2765
+ Examples:
2766
+ postman dataset delete ./postman/datasets/users/users.dataset.yaml
2767
+ postman dataset delete ./postman/datasets/users/users.dataset.yaml \-\-yes
2768
+
2769
+
2770
+
2771
+ .SS "dataset source"
2772
+ [BETA] Inspect and manage a dataset's datasources.
2773
+
2774
+ .B Usage:
2775
+ [options] [command]
2776
+
2777
+ .B Subcommands:
2778
+ .TP
2779
+ .B dataset source list
2780
+ [BETA] List the datasources defined on a dataset.
2781
+ .TP
2782
+ .B dataset source add
2783
+ [BETA] Add a datasource to a dataset.
2784
+ .TP
2785
+ .B dataset source remove
2786
+ [BETA] Remove a datasource from a dataset.
2787
+ .TP
2788
+ .B dataset source update
2789
+ [BETA] Update fields on an existing datasource. Only the flags you provide are changed.
2790
+
2791
+ .SS "dataset source list"
2792
+ [BETA] List the datasources defined on a dataset.
2793
+
2794
+ .B Usage:
2795
+ [options] <path>
2796
+
2797
+ .B Options:
2798
+ .TP
2799
+ .B \-\-json
2800
+ Output sources as JSON instead of a table
2801
+
2802
+ .TP Examples:
2803
+
2804
+ Examples:
2805
+ postman dataset source list ./postman/datasets/users/users.dataset.yaml
2806
+
2807
+
2808
+
2809
+ .SS "dataset source add"
2810
+ [BETA] Add a datasource to a dataset.
2811
+
2812
+ .B Usage:
2813
+ [options] <pathOrId>
2814
+
2815
+ .B Options:
2816
+ .TP
2817
+ .B \-n, \-\-name <name>
2818
+ Logical name for the source (becomes the SQL table name)
2819
+ .TP
2820
+ .B \-\-id <uuid>
2821
+ Override the generated source id
2822
+ .TP
2823
+ .B \-\-format <csv|json|mysql|postgres>
2824
+ Override the inferred format
2825
+ .TP
2826
+ .B \-\-type <local|remote\-url|mysql|postgresql>
2827
+ Source kind; inferred from \-\-file/\-\-url when omitted
2828
+ .TP
2829
+ .B \-\-file <path>
2830
+ Path to a local CSV/JSON file (absolute or cwd\-relative)
2831
+ .TP
2832
+ .B \-\-ref\-only
2833
+ Reference the file in place; do NOT copy into data_dir
2834
+ .TP
2835
+ .B \-\-force
2836
+ When copying, overwrite an existing file at the destination
2837
+ .TP
2838
+ .B \-\-url <url>
2839
+ HTTP(S) URL to a remote CSV/JSON file
2840
+ .TP
2841
+ .B \-\-host <host>
2842
+ DB host (mysql/postgresql)
2843
+ .TP
2844
+ .B \-\-port <port>
2845
+ DB port
2846
+ .TP
2847
+ .B \-\-user <user>
2848
+ DB user (warning: stored as plaintext in the YAML).
2849
+ .TP
2850
+ .B \-\-password <password>
2851
+ DB password (warning: stored as plaintext in the YAML).
2852
+ .TP
2853
+ .B \-\-database <db>
2854
+ DB database name
2855
+ .TP
2856
+ .B \-\-table <table>
2857
+ DB table name (optional)
2858
+ .TP
2859
+ .B \-\-slug <slug>
2860
+ Optional slug for the source
2861
+
2862
+ .SS "dataset source remove"
2863
+ [BETA] Remove a datasource from a dataset.
2864
+
2865
+ .B Usage:
2866
+ [options] <path> <sourceNameOrId>
2867
+
2868
+ .TP Examples:
2869
+
2870
+ Examples:
2871
+ postman dataset source remove ./users.dataset.yaml source_people_1
2872
+ postman dataset source remove ./users.dataset.yaml d3e67bc9\-f9a3\-43b5\-b894\-d00f1791258c
2873
+
2874
+
2875
+
2876
+ .SS "dataset source update"
2877
+ [BETA] Update fields on an existing datasource. Only the flags you provide are changed.
2878
+
2879
+ .B Usage:
2880
+ [options] <pathOrId> <sourceNameOrId>
2881
+
2882
+ .B Options:
2883
+ .TP
2884
+ .B \-n, \-\-name <name>
2885
+ Rename the source
2886
+ .TP
2887
+ .B \-\-format <csv|json|mysql|postgres>
2888
+ Change the format
2889
+ .TP
2890
+ .B \-\-file <path>
2891
+ Replace the source's file (local\-filesystem only)
2892
+ .TP
2893
+ .B \-\-ref\-only
2894
+ When using \-\-file, reference in place instead of copying
2895
+ .TP
2896
+ .B \-\-force
2897
+ When copying with \-\-file, overwrite existing destination
2898
+ .TP
2899
+ .B \-\-url <url>
2900
+ Replace the remote URL (remote\-url only)
2901
+ .TP
2902
+ .B \-\-host <host>
2903
+ Update DB host (mysql/postgresql)
2904
+ .TP
2905
+ .B \-\-port <port>
2906
+ Update DB port
2907
+ .TP
2908
+ .B \-\-user <user>
2909
+ Update DB user (warning: stored as plaintext in the YAML).
2910
+ .TP
2911
+ .B \-\-password <password>
2912
+ Update DB password (warning: stored as plaintext in the YAML).
2913
+ .TP
2914
+ .B \-\-database <db>
2915
+ Update DB database name
2916
+ .TP
2917
+ .B \-\-table <table>
2918
+ Update DB table name
2919
+ .TP
2920
+ .B \-\-slug <slug>
2921
+ Update slug
2922
+
2923
+ .SS "dataset view"
2924
+ [BETA] Inspect and manage saved views on a dataset.
2925
+
2926
+ .B Usage:
2927
+ [options] [command]
2928
+
2929
+ .B Subcommands:
2930
+ .TP
2931
+ .B dataset view list
2932
+ [BETA] List the saved views defined on a dataset.
2933
+ .TP
2934
+ .B dataset view run
2935
+ [BETA] Execute a saved view against a dataset and print the rows.
2936
+ .TP
2937
+ .B dataset view create
2938
+ [BETA] Add a saved view to a dataset.
2939
+ .TP
2940
+ .B dataset view delete
2941
+ [BETA] Remove a saved view from a dataset.
2942
+ .TP
2943
+ .B dataset view update
2944
+ [BETA] Update name and/or query on an existing view.
2945
+
2946
+ .SS "dataset view list"
2947
+ [BETA] List the saved views defined on a dataset.
2948
+
2949
+ .B Usage:
2950
+ [options] <path>
2951
+
2952
+ .B Options:
2953
+ .TP
2954
+ .B \-\-json
2955
+ Output views as JSON instead of a table
2956
+
2957
+ .TP Examples:
2958
+
2959
+ Examples:
2960
+ postman dataset view list ./postman/datasets/users/users.dataset.yaml
2961
+
2962
+
2963
+
2964
+ .SS "dataset view run"
2965
+ [BETA] Execute a saved view against a dataset and print the rows.
2966
+
2967
+ .B Usage:
2968
+ [options] <path> <viewNameOrId>
2969
+
2970
+ .B Options:
2971
+ .TP
2972
+ .B \-p, \-\-param <value...>
2973
+ Positional parameter values for $1, $2, ... bindings; repeatable
2974
+ .TP
2975
+ .B \-\-json
2976
+ Output rows as JSON instead of a table
2977
+
2978
+ .TP Examples:
2979
+
2980
+ Examples:
2981
+ postman dataset view run ./users.dataset.yaml "Active Users"
2982
+ postman dataset view run ./users.dataset.yaml ea748a6a\-ed3c\-496d\-b91e\-6ccc8e4d0e9d
2983
+
2984
+
2985
+
2986
+ .SS "dataset view create"
2987
+ [BETA] Add a saved view to a dataset.
2988
+
2989
+ .B Usage:
2990
+ [options] <path>
2991
+
2992
+ .B Options:
2993
+ .TP
2994
+ .B \-n, \-\-name <name>
2995
+ View name
2996
+ .TP
2997
+ .B \-q, \-\-query <sql>
2998
+ SQL query the view executes
2999
+ .TP
3000
+ .B \-\-id <uuid>
3001
+ Override the generated view id
3002
+
3003
+ .TP Examples:
3004
+
3005
+ Examples:
3006
+ postman dataset view create ./users.dataset.yaml \e
3007
+ \-n "Active Users" \-q "SELECT * FROM source_users WHERE active = true"
3008
+
3009
+
3010
+
3011
+ .SS "dataset view delete"
3012
+ [BETA] Remove a saved view from a dataset.
3013
+
3014
+ .B Usage:
3015
+ [options] <path> <viewNameOrId>
3016
+
3017
+ .TP Examples:
3018
+
3019
+ Examples:
3020
+ postman dataset view delete ./users.dataset.yaml "Active Users"
3021
+
3022
+
3023
+
3024
+ .SS "dataset view update"
3025
+ [BETA] Update name and/or query on an existing view.
3026
+
3027
+ .B Usage:
3028
+ [options] <path> <viewNameOrId>
3029
+
3030
+ .B Options:
3031
+ .TP
3032
+ .B \-n, \-\-name <name>
3033
+ New view name
3034
+ .TP
3035
+ .B \-q, \-\-query <sql>
3036
+ New SQL query
3037
+
3038
+ .TP Examples:
3039
+
3040
+ Examples:
3041
+ postman dataset view update ./users.dataset.yaml "Active Users" \-q "SELECT ..."
3042
+
3043
+
3044
+
2607
3045
  .SH SEE ALSO
2608
3046
  Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
2609
3047
  .SH AUTHOR
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.39.2",
3
+ "version": "1.41.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.39.2",
62
- "@postman/pm-bin-macos-x64": "1.39.2",
63
- "@postman/pm-bin-linux-x64": "1.39.2",
64
- "@postman/pm-bin-linux-arm64": "1.39.2",
65
- "@postman/pm-bin-windows-x64": "1.39.2"
61
+ "@postman/pm-bin-macos-arm64": "1.41.0",
62
+ "@postman/pm-bin-macos-x64": "1.41.0",
63
+ "@postman/pm-bin-linux-x64": "1.41.0",
64
+ "@postman/pm-bin-linux-arm64": "1.41.0",
65
+ "@postman/pm-bin-windows-x64": "1.41.0"
66
66
  }
67
67
  }