postman-cli 1.39.0 → 1.40.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 +432 -3
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-06-11" "v1.39.0" "Postman CLI Manual"
1
+ .TH POSTMAN 1 "2026-06-24" "v1.40.0" "Postman CLI Manual"
2
2
  .SH NAME
3
3
  postman \- Command\-line companion utility for Postman
4
4
  .SH SYNOPSIS
@@ -106,7 +106,7 @@ Score a Postman collection for AI readiness by ID, local file path, or local\-mo
106
106
  .B Options:
107
107
  .TP
108
108
  .B \-o, \-\-output <value>
109
- Output format for the results. [choices: "cli", "json"]
109
+ Output format for the results. [choices: "cli", "json", "html"]
110
110
  .TP
111
111
  .B \-\-min\-score <n>
112
112
  Exit with a non\-zero code if the overall score is below this threshold (0\-100).
@@ -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
@@ -433,7 +442,7 @@ Score an OpenAPI specification for AI readiness by ID or local file path.
433
442
  .B Options:
434
443
  .TP
435
444
  .B \-o, \-\-output <value>
436
- Output format for the results. [choices: "cli", "json"]
445
+ Output format for the results. [choices: "cli", "json", "html"]
437
446
  .TP
438
447
  .B \-\-min\-score <n>
439
448
  Exit with a non\-zero code if the overall score is below this threshold (0\-100).
@@ -562,6 +571,9 @@ Path to a JSON or CSV data file to use with the collection
562
571
  .B \-\-postman\-api\-key <apiKey>
563
572
  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
573
  .TP
574
+ .B \-\-cloud
575
+ Execute the performance test on Postman Cloud (beta) (default: false)
576
+ .TP
565
577
  .B \-\-pass\-if <condition>
566
578
  Pass condition in format: function(metric, value).
567
579
  Functions: less_than, greater_than, less_than_eq, greater_than_eq.
@@ -962,6 +974,9 @@ Add JavaScript script to run before the request. Can be inline JS or @filepath t
962
974
  .B \-\-script\-post\-request <script>
963
975
  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
976
  .TP
977
+ .B \-\-dataset <pathOrDir>
978
+ [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: )
979
+ .TP
965
980
  .B \-o, \-\-output <path>
966
981
  Save complete response to JSON file.Useful for debugging or further processing.
967
982
  .TP
@@ -2604,6 +2619,420 @@ Examples:
2604
2619
 
2605
2620
 
2606
2621
 
2622
+ .SS "dataset"
2623
+ [BETA] Work with Postman datasets defined in local YAML files.
2624
+
2625
+ .B Usage:
2626
+ [options] [command]
2627
+
2628
+ .B Subcommands:
2629
+ .TP
2630
+ .B dataset list
2631
+ [BETA] List dataset YAMLs under the given directory, or print summary for a single YAML file.
2632
+ .TP
2633
+ .B dataset get
2634
+ [BETA] Print a dataset's metadata and structure summary.
2635
+ .TP
2636
+ .B dataset query
2637
+ [BETA] Run an ad\-hoc SQL query against a dataset.
2638
+ .TP
2639
+ .B dataset create
2640
+ [BETA] Scaffold a new empty .dataset.yaml file at <path>.
2641
+ .TP
2642
+ .B dataset delete
2643
+ [BETA] Permanently remove a dataset's .dataset.yaml file and its .resources/ directory.
2644
+ .TP
2645
+ .B dataset source
2646
+ [BETA] Inspect and manage a dataset's datasources.
2647
+ .TP
2648
+ .B dataset view
2649
+ [BETA] Inspect and manage saved views on a dataset.
2650
+
2651
+ .SS "dataset list"
2652
+ [BETA] List dataset YAMLs under the given directory, or print summary for a single YAML file.
2653
+
2654
+ .B Usage:
2655
+ [options] <pathOrDir>
2656
+
2657
+ .B Options:
2658
+ .TP
2659
+ .B \-\-json
2660
+ Output as JSON instead of a table
2661
+
2662
+ .TP Examples:
2663
+
2664
+ Examples:
2665
+ postman dataset list ./postman/datasets
2666
+ postman dataset list ./postman/datasets/users/users.dataset.yaml
2667
+
2668
+
2669
+
2670
+ .SS "dataset get"
2671
+ [BETA] Print a dataset's metadata and structure summary.
2672
+
2673
+ .B Usage:
2674
+ [options] <path>
2675
+
2676
+ .B Options:
2677
+ .TP
2678
+ .B \-\-json
2679
+ Output the full parsed YAML as JSON
2680
+
2681
+ .TP Examples:
2682
+
2683
+ Examples:
2684
+ postman dataset get ./postman/datasets/users/users.dataset.yaml
2685
+
2686
+
2687
+
2688
+ .SS "dataset query"
2689
+ [BETA] Run an ad\-hoc SQL query against a dataset.
2690
+
2691
+ .B Usage:
2692
+ [options] <path>
2693
+
2694
+ .B Options:
2695
+ .TP
2696
+ .B \-q, \-\-query <sql>
2697
+ SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
2698
+ .TP
2699
+ .B \-p, \-\-param <value...>
2700
+ Positional parameter values for $1, $2, ... bindings; repeatable
2701
+ .TP
2702
+ .B \-\-json
2703
+ Output rows as JSON instead of a table
2704
+
2705
+ .TP Examples:
2706
+
2707
+ Examples:
2708
+ postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
2709
+ postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users WHERE id = $1" \-p 42
2710
+
2711
+
2712
+
2713
+ .SS "dataset create"
2714
+ [BETA] Scaffold a new empty .dataset.yaml file at <path>.
2715
+
2716
+ .B Usage:
2717
+ [options] <path>
2718
+
2719
+ .B Options:
2720
+ .TP
2721
+ .B \-n, \-\-name <name>
2722
+ Human\-readable name for the dataset
2723
+ .TP
2724
+ .B \-d, \-\-description <desc>
2725
+ Optional description
2726
+ .TP
2727
+ .B \-\-id <uuid>
2728
+ Override the generated dataset id (defaults to a random v4 UUID)
2729
+ .TP
2730
+ .B \-\-force
2731
+ Overwrite an existing file at <path>
2732
+
2733
+ .TP Examples:
2734
+
2735
+ Examples:
2736
+ postman dataset create ./postman/datasets/users/users.dataset.yaml \-\-name "Users"
2737
+
2738
+
2739
+
2740
+ .SS "dataset delete"
2741
+ [BETA] Permanently remove a dataset's .dataset.yaml file and its .resources/ directory.
2742
+
2743
+ .B Usage:
2744
+ [options] <path>
2745
+
2746
+ .B Options:
2747
+ .TP
2748
+ .B \-y, \-\-yes
2749
+ Skip the confirmation prompt
2750
+ .TP
2751
+ .B \-\-keep\-resources
2752
+ Delete only the YAML file; leave the .resources/ directory intact
2753
+
2754
+ .TP Examples:
2755
+
2756
+ Examples:
2757
+ postman dataset delete ./postman/datasets/users/users.dataset.yaml
2758
+ postman dataset delete ./postman/datasets/users/users.dataset.yaml \-\-yes
2759
+
2760
+
2761
+
2762
+ .SS "dataset source"
2763
+ [BETA] Inspect and manage a dataset's datasources.
2764
+
2765
+ .B Usage:
2766
+ [options] [command]
2767
+
2768
+ .B Subcommands:
2769
+ .TP
2770
+ .B dataset source list
2771
+ [BETA] List the datasources defined on a dataset.
2772
+ .TP
2773
+ .B dataset source add
2774
+ [BETA] Add a datasource to a dataset.
2775
+ .TP
2776
+ .B dataset source remove
2777
+ [BETA] Remove a datasource from a dataset.
2778
+ .TP
2779
+ .B dataset source update
2780
+ [BETA] Update fields on an existing datasource. Only the flags you provide are changed.
2781
+
2782
+ .SS "dataset source list"
2783
+ [BETA] List the datasources defined on a dataset.
2784
+
2785
+ .B Usage:
2786
+ [options] <path>
2787
+
2788
+ .B Options:
2789
+ .TP
2790
+ .B \-\-json
2791
+ Output sources as JSON instead of a table
2792
+
2793
+ .TP Examples:
2794
+
2795
+ Examples:
2796
+ postman dataset source list ./postman/datasets/users/users.dataset.yaml
2797
+
2798
+
2799
+
2800
+ .SS "dataset source add"
2801
+ [BETA] Add a datasource to a dataset.
2802
+
2803
+ .B Usage:
2804
+ [options] <pathOrId>
2805
+
2806
+ .B Options:
2807
+ .TP
2808
+ .B \-n, \-\-name <name>
2809
+ Logical name for the source (becomes the SQL table name)
2810
+ .TP
2811
+ .B \-\-id <uuid>
2812
+ Override the generated source id
2813
+ .TP
2814
+ .B \-\-format <csv|json|mysql|postgres>
2815
+ Override the inferred format
2816
+ .TP
2817
+ .B \-\-type <local|remote\-url|mysql|postgresql>
2818
+ Source kind; inferred from \-\-file/\-\-url when omitted
2819
+ .TP
2820
+ .B \-\-file <path>
2821
+ Path to a local CSV/JSON file (absolute or cwd\-relative)
2822
+ .TP
2823
+ .B \-\-ref\-only
2824
+ Reference the file in place; do NOT copy into data_dir
2825
+ .TP
2826
+ .B \-\-force
2827
+ When copying, overwrite an existing file at the destination
2828
+ .TP
2829
+ .B \-\-url <url>
2830
+ HTTP(S) URL to a remote CSV/JSON file
2831
+ .TP
2832
+ .B \-\-host <host>
2833
+ DB host (mysql/postgresql)
2834
+ .TP
2835
+ .B \-\-port <port>
2836
+ DB port
2837
+ .TP
2838
+ .B \-\-user <user>
2839
+ DB user (warning: stored as plaintext in the YAML).
2840
+ .TP
2841
+ .B \-\-password <password>
2842
+ DB password (warning: stored as plaintext in the YAML).
2843
+ .TP
2844
+ .B \-\-database <db>
2845
+ DB database name
2846
+ .TP
2847
+ .B \-\-table <table>
2848
+ DB table name (optional)
2849
+ .TP
2850
+ .B \-\-slug <slug>
2851
+ Optional slug for the source
2852
+
2853
+ .SS "dataset source remove"
2854
+ [BETA] Remove a datasource from a dataset.
2855
+
2856
+ .B Usage:
2857
+ [options] <path> <sourceNameOrId>
2858
+
2859
+ .TP Examples:
2860
+
2861
+ Examples:
2862
+ postman dataset source remove ./users.dataset.yaml source_people_1
2863
+ postman dataset source remove ./users.dataset.yaml d3e67bc9\-f9a3\-43b5\-b894\-d00f1791258c
2864
+
2865
+
2866
+
2867
+ .SS "dataset source update"
2868
+ [BETA] Update fields on an existing datasource. Only the flags you provide are changed.
2869
+
2870
+ .B Usage:
2871
+ [options] <pathOrId> <sourceNameOrId>
2872
+
2873
+ .B Options:
2874
+ .TP
2875
+ .B \-n, \-\-name <name>
2876
+ Rename the source
2877
+ .TP
2878
+ .B \-\-format <csv|json|mysql|postgres>
2879
+ Change the format
2880
+ .TP
2881
+ .B \-\-file <path>
2882
+ Replace the source's file (local\-filesystem only)
2883
+ .TP
2884
+ .B \-\-ref\-only
2885
+ When using \-\-file, reference in place instead of copying
2886
+ .TP
2887
+ .B \-\-force
2888
+ When copying with \-\-file, overwrite existing destination
2889
+ .TP
2890
+ .B \-\-url <url>
2891
+ Replace the remote URL (remote\-url only)
2892
+ .TP
2893
+ .B \-\-host <host>
2894
+ Update DB host (mysql/postgresql)
2895
+ .TP
2896
+ .B \-\-port <port>
2897
+ Update DB port
2898
+ .TP
2899
+ .B \-\-user <user>
2900
+ Update DB user (warning: stored as plaintext in the YAML).
2901
+ .TP
2902
+ .B \-\-password <password>
2903
+ Update DB password (warning: stored as plaintext in the YAML).
2904
+ .TP
2905
+ .B \-\-database <db>
2906
+ Update DB database name
2907
+ .TP
2908
+ .B \-\-table <table>
2909
+ Update DB table name
2910
+ .TP
2911
+ .B \-\-slug <slug>
2912
+ Update slug
2913
+
2914
+ .SS "dataset view"
2915
+ [BETA] Inspect and manage saved views on a dataset.
2916
+
2917
+ .B Usage:
2918
+ [options] [command]
2919
+
2920
+ .B Subcommands:
2921
+ .TP
2922
+ .B dataset view list
2923
+ [BETA] List the saved views defined on a dataset.
2924
+ .TP
2925
+ .B dataset view run
2926
+ [BETA] Execute a saved view against a dataset and print the rows.
2927
+ .TP
2928
+ .B dataset view create
2929
+ [BETA] Add a saved view to a dataset.
2930
+ .TP
2931
+ .B dataset view delete
2932
+ [BETA] Remove a saved view from a dataset.
2933
+ .TP
2934
+ .B dataset view update
2935
+ [BETA] Update name and/or query on an existing view.
2936
+
2937
+ .SS "dataset view list"
2938
+ [BETA] List the saved views defined on a dataset.
2939
+
2940
+ .B Usage:
2941
+ [options] <path>
2942
+
2943
+ .B Options:
2944
+ .TP
2945
+ .B \-\-json
2946
+ Output views as JSON instead of a table
2947
+
2948
+ .TP Examples:
2949
+
2950
+ Examples:
2951
+ postman dataset view list ./postman/datasets/users/users.dataset.yaml
2952
+
2953
+
2954
+
2955
+ .SS "dataset view run"
2956
+ [BETA] Execute a saved view against a dataset and print the rows.
2957
+
2958
+ .B Usage:
2959
+ [options] <path> <viewNameOrId>
2960
+
2961
+ .B Options:
2962
+ .TP
2963
+ .B \-p, \-\-param <value...>
2964
+ Positional parameter values for $1, $2, ... bindings; repeatable
2965
+ .TP
2966
+ .B \-\-json
2967
+ Output rows as JSON instead of a table
2968
+
2969
+ .TP Examples:
2970
+
2971
+ Examples:
2972
+ postman dataset view run ./users.dataset.yaml "Active Users"
2973
+ postman dataset view run ./users.dataset.yaml ea748a6a\-ed3c\-496d\-b91e\-6ccc8e4d0e9d
2974
+
2975
+
2976
+
2977
+ .SS "dataset view create"
2978
+ [BETA] Add a saved view to a dataset.
2979
+
2980
+ .B Usage:
2981
+ [options] <path>
2982
+
2983
+ .B Options:
2984
+ .TP
2985
+ .B \-n, \-\-name <name>
2986
+ View name
2987
+ .TP
2988
+ .B \-q, \-\-query <sql>
2989
+ SQL query the view executes
2990
+ .TP
2991
+ .B \-\-id <uuid>
2992
+ Override the generated view id
2993
+
2994
+ .TP Examples:
2995
+
2996
+ Examples:
2997
+ postman dataset view create ./users.dataset.yaml \e
2998
+ \-n "Active Users" \-q "SELECT * FROM source_users WHERE active = true"
2999
+
3000
+
3001
+
3002
+ .SS "dataset view delete"
3003
+ [BETA] Remove a saved view from a dataset.
3004
+
3005
+ .B Usage:
3006
+ [options] <path> <viewNameOrId>
3007
+
3008
+ .TP Examples:
3009
+
3010
+ Examples:
3011
+ postman dataset view delete ./users.dataset.yaml "Active Users"
3012
+
3013
+
3014
+
3015
+ .SS "dataset view update"
3016
+ [BETA] Update name and/or query on an existing view.
3017
+
3018
+ .B Usage:
3019
+ [options] <path> <viewNameOrId>
3020
+
3021
+ .B Options:
3022
+ .TP
3023
+ .B \-n, \-\-name <name>
3024
+ New view name
3025
+ .TP
3026
+ .B \-q, \-\-query <sql>
3027
+ New SQL query
3028
+
3029
+ .TP Examples:
3030
+
3031
+ Examples:
3032
+ postman dataset view update ./users.dataset.yaml "Active Users" \-q "SELECT ..."
3033
+
3034
+
3035
+
2607
3036
  .SH SEE ALSO
2608
3037
  Full documentation: https://learning.postman.com/docs/postman\-cli/postman\-cli\-overview/
2609
3038
  .SH AUTHOR
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.39.0",
3
+ "version": "1.40.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.0",
62
- "@postman/pm-bin-macos-x64": "1.39.0",
63
- "@postman/pm-bin-linux-x64": "1.39.0",
64
- "@postman/pm-bin-linux-arm64": "1.39.0",
65
- "@postman/pm-bin-windows-x64": "1.39.0"
61
+ "@postman/pm-bin-macos-arm64": "1.40.0",
62
+ "@postman/pm-bin-macos-x64": "1.40.0",
63
+ "@postman/pm-bin-linux-x64": "1.40.0",
64
+ "@postman/pm-bin-linux-arm64": "1.40.0",
65
+ "@postman/pm-bin-windows-x64": "1.40.0"
66
66
  }
67
67
  }