postman-cli 1.44.0 → 1.46.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 +271 -67
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-
|
|
1
|
+
.TH POSTMAN 1 "2026-08-11" "v1.46.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: )
|
|
@@ -264,7 +264,7 @@ Exports the cookie jar to a file after completing the run
|
|
|
264
264
|
Show detailed information of collection run and each request sent
|
|
265
265
|
.TP
|
|
266
266
|
.B \-\-mock <path>
|
|
267
|
-
Start a mock server from manifest (.json) file
|
|
267
|
+
Start a mock server from manifest (.json, .yaml or .yml) file
|
|
268
268
|
.TP
|
|
269
269
|
.B \-\-simulate <path>
|
|
270
270
|
Start mock servers with fault\-injection scenarios from a .sim.yaml file
|
|
@@ -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
|
|
|
@@ -560,7 +596,7 @@ Specify an Id to a Postman Globals
|
|
|
560
596
|
Number of virtual users (default: 20)
|
|
561
597
|
.TP
|
|
562
598
|
.B \-d, \-\-duration <minutes>
|
|
563
|
-
Duration of the performance test in minutes (default:
|
|
599
|
+
Duration of the performance test in minutes (default: 1)
|
|
564
600
|
.TP
|
|
565
601
|
.B \-p, \-\-load\-profile <profile>
|
|
566
602
|
Load profile type: fixed, ramp\-up, spike, peak (default: ramp\-up)
|
|
@@ -766,6 +802,15 @@ Set flow inputs from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-f
|
|
|
766
802
|
.B \-s, \-\-scenario <name>
|
|
767
803
|
Use a pre\-built scenario as flow inputs (by scenario name). Can be combined with \-\-input and \-\-input\-file to override values.
|
|
768
804
|
.TP
|
|
805
|
+
.B \-\-iteration\-data\-dataset <path>
|
|
806
|
+
[BETA] Run the flow once per row of a local .dataset.yaml view. Requires \-\-iteration\-data\-view. Dataset columns feed the flow inputs (see \-\-map).
|
|
807
|
+
.TP
|
|
808
|
+
.B \-\-iteration\-data\-view <nameOrId>
|
|
809
|
+
[BETA] Name or id of the view (within \-\-iteration\-data\-dataset) whose rows drive the run.
|
|
810
|
+
.TP
|
|
811
|
+
.B \-\-map <input=column>
|
|
812
|
+
[BETA] Bind a flow input to a dataset column (e.g. \-\-map isActive=active). Repeatable. Inputs whose name matches a column bind automatically. (default: )
|
|
813
|
+
.TP
|
|
769
814
|
.B \-e, \-\-environment <path>
|
|
770
815
|
Specify a path to a Postman Environment file (JSON or YAML)
|
|
771
816
|
.TP
|
|
@@ -1219,7 +1264,7 @@ Generate and manage your SDKs directly from the command line.
|
|
|
1219
1264
|
Create or update .postman/config.json with an SDK configuration stub.
|
|
1220
1265
|
.TP
|
|
1221
1266
|
.B sdk generate
|
|
1222
|
-
Generate a new SDK from a Postman collection or specification.
|
|
1267
|
+
Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).
|
|
1223
1268
|
.TP
|
|
1224
1269
|
.B sdk track
|
|
1225
1270
|
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 +1293,7 @@ Create or update .postman/config.json with an SDK configuration stub.
|
|
|
1248
1293
|
Skip prompts and overwrite existing sdk config
|
|
1249
1294
|
|
|
1250
1295
|
.SS "sdk generate"
|
|
1251
|
-
Generate a new SDK from a Postman collection or specification.
|
|
1296
|
+
Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).
|
|
1252
1297
|
|
|
1253
1298
|
.B Usage:
|
|
1254
1299
|
<idOrPath> [options]
|
|
@@ -1308,6 +1353,8 @@ Input:
|
|
|
1308
1353
|
\- A file path to a collection (.json) or specification (.json, .yaml, .yml) file
|
|
1309
1354
|
\- A URL to a publicly accessible collection or specification file
|
|
1310
1355
|
|
|
1356
|
+
Supported specification formats: OpenAPI (2.0/3.x) and AsyncAPI (2.x/3.x).
|
|
1357
|
+
|
|
1311
1358
|
When using an ID, the SDK generation updates the version in Postman Cloud.
|
|
1312
1359
|
When using a file path or URL, a one\-off build is created that does not update the Postman Cloud.
|
|
1313
1360
|
|
|
@@ -1327,6 +1374,9 @@ Examples:
|
|
|
1327
1374
|
Generate SDK from OpenAPI specification file (one\-off build):
|
|
1328
1375
|
postman sdk generate ./openapi.yaml \-l typescript \-o ./my\-sdk
|
|
1329
1376
|
|
|
1377
|
+
Generate SDK from AsyncAPI specification file (one\-off build):
|
|
1378
|
+
postman sdk generate ./asyncapi.yaml \-l typescript \-o ./my\-sdk
|
|
1379
|
+
|
|
1330
1380
|
Generate SDK from publicly accessible URL (one\-off build):
|
|
1331
1381
|
postman sdk generate https://petstore.swagger.io/v2/swagger.json \-l typescript \-o ./my\-sdk
|
|
1332
1382
|
|
|
@@ -1605,10 +1655,10 @@ Run and manage local Postman mock servers.
|
|
|
1605
1655
|
.B Subcommands:
|
|
1606
1656
|
.TP
|
|
1607
1657
|
.B mock run
|
|
1608
|
-
Start a local mock server given a manifest file.
|
|
1658
|
+
Start a local mock server given a manifest file (JSON or YAML).
|
|
1609
1659
|
|
|
1610
1660
|
.SS "mock run"
|
|
1611
|
-
Start a local mock server given a manifest file.
|
|
1661
|
+
Start a local mock server given a manifest file (JSON or YAML).
|
|
1612
1662
|
|
|
1613
1663
|
.B Usage:
|
|
1614
1664
|
<manifestPath>
|
|
@@ -1623,6 +1673,7 @@ Path to a globals file (JSON or YAML) for pm.globals
|
|
|
1623
1673
|
|
|
1624
1674
|
.TP Examples:
|
|
1625
1675
|
Eg. postman mock run ./postman/mock\-manifest.json
|
|
1676
|
+
postman mock run ./postman/mock\-manifest.yaml
|
|
1626
1677
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1627
1678
|
|
|
1628
1679
|
|
|
@@ -2029,7 +2080,7 @@ Quick start:
|
|
|
2029
2080
|
postman search requests "auth"
|
|
2030
2081
|
postman search requests "auth" \-\-filter "method=POST AND visibility=public" \-\-ownership org \-\-limit 10 \-\-output json
|
|
2031
2082
|
|
|
2032
|
-
Element types: requests, collections, workspaces, flows, specs, environments, mocks
|
|
2083
|
+
Element types: requests, collections, workspaces, flows, specs, environments, mocks, documents
|
|
2033
2084
|
|
|
2034
2085
|
Detailed help is split by element type:
|
|
2035
2086
|
postman search requests \-\-help Request filters and examples
|
|
@@ -2039,6 +2090,7 @@ Detailed help is split by element type:
|
|
|
2039
2090
|
postman search specs \-\-help API spec filters and examples
|
|
2040
2091
|
postman search mocks \-\-help Mock filters and examples
|
|
2041
2092
|
postman search environments \-\-help Environment filters and examples
|
|
2093
|
+
postman search documents \-\-help Document filters and examples
|
|
2042
2094
|
|
|
2043
2095
|
Pagination: \-\-limit accepts up to 25 results. Use \-\-cursor from the previous response to paginate.
|
|
2044
2096
|
|
|
@@ -2065,6 +2117,9 @@ Search for mocks by name or keyword.
|
|
|
2065
2117
|
.TP
|
|
2066
2118
|
.B search environments
|
|
2067
2119
|
Search for environments by name or keyword.
|
|
2120
|
+
.TP
|
|
2121
|
+
.B search documents
|
|
2122
|
+
Search for documents by name or keyword.
|
|
2068
2123
|
|
|
2069
2124
|
.SS "search requests"
|
|
2070
2125
|
Search for requests by name or keyword.
|
|
@@ -2437,6 +2492,57 @@ Examples:
|
|
|
2437
2492
|
postman search environments \-\-filter "environmentId=env\-abc123"
|
|
2438
2493
|
|
|
2439
2494
|
|
|
2495
|
+
.SS "search documents"
|
|
2496
|
+
Search for documents by name or keyword.
|
|
2497
|
+
|
|
2498
|
+
.B Usage:
|
|
2499
|
+
[options] [query]
|
|
2500
|
+
|
|
2501
|
+
.TP Examples:
|
|
2502
|
+
|
|
2503
|
+
Use \-\-cursor from the previous response to paginate.
|
|
2504
|
+
Ownership:
|
|
2505
|
+
organization, org Search resources owned by your organization
|
|
2506
|
+
external Search resources outside your organization
|
|
2507
|
+
all Search both organization and external resources
|
|
2508
|
+
|
|
2509
|
+
Output modes:
|
|
2510
|
+
default Card list including basic overview and web link per result
|
|
2511
|
+
json Detailed JSON response with search metadata
|
|
2512
|
+
|
|
2513
|
+
Filter syntax:
|
|
2514
|
+
Use = or != for single values: workspaceId=ws\-1
|
|
2515
|
+
Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
|
|
2516
|
+
Combine filters with AND. Operators are case\-insensitive.
|
|
2517
|
+
Quote supported values that contain spaces or commas: <field>="value with spaces"
|
|
2518
|
+
|
|
2519
|
+
\-\-filter\-json format:
|
|
2520
|
+
{"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
|
|
2521
|
+
Only a top\-level $and array is supported; $or and nested groups are not supported.
|
|
2522
|
+
Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
|
|
2523
|
+
|
|
2524
|
+
Shared filter fields:
|
|
2525
|
+
privateNetwork $eq, $ne (true/false)
|
|
2526
|
+
publisherIsVerified $eq, $ne (true/false)
|
|
2527
|
+
visibility $eq, $ne (internal, public, partner)
|
|
2528
|
+
workspaceId $eq, $ne, $in, $nin
|
|
2529
|
+
createdBy $eq, $ne, $in, $nin (user ID)
|
|
2530
|
+
organizationId $eq, $ne, $in, $nin (organization ID)
|
|
2531
|
+
teamId $eq, $ne, $in, $nin (team ID)
|
|
2532
|
+
isGitConnected $eq, $ne (true/false)
|
|
2533
|
+
|
|
2534
|
+
Document filter fields:
|
|
2535
|
+
documentId $eq, $ne, $in, $nin
|
|
2536
|
+
|
|
2537
|
+
ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
|
|
2538
|
+
Use \-\-output json on a broader search result to inspect available IDs.
|
|
2539
|
+
|
|
2540
|
+
Examples:
|
|
2541
|
+
postman search documents "onboarding guide"
|
|
2542
|
+
postman search documents "api reference" \-\-filter "workspaceId=ws\-abc123"
|
|
2543
|
+
postman search documents \-\-filter "documentId=doc\-abc123"
|
|
2544
|
+
|
|
2545
|
+
|
|
2440
2546
|
.SS "webhook"
|
|
2441
2547
|
Create and manage Postman webhooks.
|
|
2442
2548
|
|
|
@@ -2718,19 +2824,19 @@ Examples:
|
|
|
2718
2824
|
.B Subcommands:
|
|
2719
2825
|
.TP
|
|
2720
2826
|
.B dataset list
|
|
2721
|
-
[BETA] List dataset YAMLs under
|
|
2827
|
+
[BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
2722
2828
|
.TP
|
|
2723
2829
|
.B dataset get
|
|
2724
|
-
[BETA] Print a dataset's metadata and structure summary.
|
|
2830
|
+
[BETA] Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
2725
2831
|
.TP
|
|
2726
2832
|
.B dataset query
|
|
2727
|
-
[BETA] Run an ad\-hoc SQL query against a dataset.
|
|
2833
|
+
[BETA] Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
2728
2834
|
.TP
|
|
2729
2835
|
.B dataset create
|
|
2730
|
-
[BETA] Scaffold a new
|
|
2836
|
+
[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
2731
2837
|
.TP
|
|
2732
2838
|
.B dataset delete
|
|
2733
|
-
[BETA] Permanently remove a dataset
|
|
2839
|
+
[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
|
|
2734
2840
|
.TP
|
|
2735
2841
|
.B dataset source
|
|
2736
2842
|
[BETA] Inspect and manage a dataset's datasources.
|
|
@@ -2739,13 +2845,19 @@ Examples:
|
|
|
2739
2845
|
[BETA] Inspect and manage saved views on a dataset.
|
|
2740
2846
|
|
|
2741
2847
|
.SS "dataset list"
|
|
2742
|
-
[BETA] List dataset YAMLs under
|
|
2848
|
+
[BETA] List local dataset YAMLs under a path, or (no path) a workspace's cloud datasets.
|
|
2743
2849
|
|
|
2744
2850
|
.B Usage:
|
|
2745
|
-
[options]
|
|
2851
|
+
[options] [pathOrDir]
|
|
2746
2852
|
|
|
2747
2853
|
.B Options:
|
|
2748
2854
|
.TP
|
|
2855
|
+
.B \-w, \-\-workspace <id>
|
|
2856
|
+
Postman workspace ID (cloud list)
|
|
2857
|
+
.TP
|
|
2858
|
+
.B \-\-api\-key <key>
|
|
2859
|
+
Postman API key (defaults to the `postman login` session)
|
|
2860
|
+
.TP
|
|
2749
2861
|
.B \-\-json
|
|
2750
2862
|
Output as JSON instead of a table
|
|
2751
2863
|
|
|
@@ -2754,32 +2866,40 @@ Output as JSON instead of a table
|
|
|
2754
2866
|
Examples:
|
|
2755
2867
|
postman dataset list ./postman/datasets
|
|
2756
2868
|
postman dataset list ./postman/datasets/users/users.dataset.yaml
|
|
2869
|
+
postman dataset list \-w 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
2757
2870
|
|
|
2758
2871
|
|
|
2759
2872
|
|
|
2760
2873
|
.SS "dataset get"
|
|
2761
|
-
[BETA] Print a dataset's metadata and structure summary.
|
|
2874
|
+
[BETA] Print a dataset's metadata and structure summary (local YAML path or cloud id).
|
|
2762
2875
|
|
|
2763
2876
|
.B Usage:
|
|
2764
|
-
[options] <
|
|
2877
|
+
[options] <datasetPathOrId>
|
|
2765
2878
|
|
|
2766
2879
|
.B Options:
|
|
2767
2880
|
.TP
|
|
2881
|
+
.B \-\-api\-key <key>
|
|
2882
|
+
Postman API key (defaults to the `postman login` session)
|
|
2883
|
+
.TP
|
|
2884
|
+
.B \-\-no\-populate
|
|
2885
|
+
Skip fetching datasources/views for a cloud dataset
|
|
2886
|
+
.TP
|
|
2768
2887
|
.B \-\-json
|
|
2769
|
-
Output the full
|
|
2888
|
+
Output the full dataset as JSON
|
|
2770
2889
|
|
|
2771
2890
|
.TP Examples:
|
|
2772
2891
|
|
|
2773
2892
|
Examples:
|
|
2774
2893
|
postman dataset get ./postman/datasets/users/users.dataset.yaml
|
|
2894
|
+
postman dataset get 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
2775
2895
|
|
|
2776
2896
|
|
|
2777
2897
|
|
|
2778
2898
|
.SS "dataset query"
|
|
2779
|
-
[BETA] Run an ad\-hoc SQL query against a dataset.
|
|
2899
|
+
[BETA] Run an ad\-hoc SQL query against a dataset (local YAML path or cloud id).
|
|
2780
2900
|
|
|
2781
2901
|
.B Usage:
|
|
2782
|
-
[options] <
|
|
2902
|
+
[options] <datasetPathOrId>
|
|
2783
2903
|
|
|
2784
2904
|
.B Options:
|
|
2785
2905
|
.TP
|
|
@@ -2789,6 +2909,9 @@ SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")
|
|
|
2789
2909
|
.B \-p, \-\-param <value...>
|
|
2790
2910
|
Positional parameter values for $1, $2, ... bindings; repeatable
|
|
2791
2911
|
.TP
|
|
2912
|
+
.B \-\-api\-key <key>
|
|
2913
|
+
Postman API key (defaults to the `postman login` session)
|
|
2914
|
+
.TP
|
|
2792
2915
|
.B \-\-json
|
|
2793
2916
|
Output rows as JSON instead of a table
|
|
2794
2917
|
|
|
@@ -2797,14 +2920,15 @@ Output rows as JSON instead of a table
|
|
|
2797
2920
|
Examples:
|
|
2798
2921
|
postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users LIMIT 5"
|
|
2799
2922
|
postman dataset query ./users.dataset.yaml \-q "SELECT * FROM source_users WHERE id = $1" \-p 42
|
|
2923
|
+
postman dataset query 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT * FROM users LIMIT 5"
|
|
2800
2924
|
|
|
2801
2925
|
|
|
2802
2926
|
|
|
2803
2927
|
.SS "dataset create"
|
|
2804
|
-
[BETA] Scaffold a new
|
|
2928
|
+
[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with \-w) create a cloud dataset.
|
|
2805
2929
|
|
|
2806
2930
|
.B Usage:
|
|
2807
|
-
[options]
|
|
2931
|
+
[options] [path]
|
|
2808
2932
|
|
|
2809
2933
|
.B Options:
|
|
2810
2934
|
.TP
|
|
@@ -2814,24 +2938,31 @@ Human\-readable name for the dataset
|
|
|
2814
2938
|
.B \-d, \-\-description <desc>
|
|
2815
2939
|
Optional description
|
|
2816
2940
|
.TP
|
|
2817
|
-
.B \-\-id <uuid>
|
|
2818
|
-
Override the generated dataset id (defaults to a random v4 UUID)
|
|
2941
|
+
.B \-\-dataset\-id <uuid>
|
|
2942
|
+
Override the generated dataset id (local only; defaults to a random v4 UUID)
|
|
2819
2943
|
.TP
|
|
2820
2944
|
.B \-\-force
|
|
2821
2945
|
Overwrite an existing file at <path>
|
|
2946
|
+
.TP
|
|
2947
|
+
.B \-w, \-\-workspace <id>
|
|
2948
|
+
Postman workspace ID (create a cloud dataset)
|
|
2949
|
+
.TP
|
|
2950
|
+
.B \-\-api\-key <key>
|
|
2951
|
+
Postman API key (defaults to the `postman login` session)
|
|
2822
2952
|
|
|
2823
2953
|
.TP Examples:
|
|
2824
2954
|
|
|
2825
2955
|
Examples:
|
|
2826
2956
|
postman dataset create ./postman/datasets/users/users.dataset.yaml \-\-name "Users"
|
|
2957
|
+
postman dataset create \-\-name "Users" \-w 12345678\-90ab\-cdef\-1234\-567890abcdef
|
|
2827
2958
|
|
|
2828
2959
|
|
|
2829
2960
|
|
|
2830
2961
|
.SS "dataset delete"
|
|
2831
|
-
[BETA] Permanently remove a dataset
|
|
2962
|
+
[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.
|
|
2832
2963
|
|
|
2833
2964
|
.B Usage:
|
|
2834
|
-
[options] <
|
|
2965
|
+
[options] <datasetPathOrId>
|
|
2835
2966
|
|
|
2836
2967
|
.B Options:
|
|
2837
2968
|
.TP
|
|
@@ -2839,13 +2970,17 @@ Examples:
|
|
|
2839
2970
|
Skip the confirmation prompt
|
|
2840
2971
|
.TP
|
|
2841
2972
|
.B \-\-keep\-resources
|
|
2842
|
-
Delete only the YAML file; leave the .resources/ directory intact
|
|
2973
|
+
Delete only the YAML file; leave the .resources/ directory intact (local only)
|
|
2974
|
+
.TP
|
|
2975
|
+
.B \-\-api\-key <key>
|
|
2976
|
+
Postman API key (defaults to the `postman login` session)
|
|
2843
2977
|
|
|
2844
2978
|
.TP Examples:
|
|
2845
2979
|
|
|
2846
2980
|
Examples:
|
|
2847
2981
|
postman dataset delete ./postman/datasets/users/users.dataset.yaml
|
|
2848
2982
|
postman dataset delete ./postman/datasets/users/users.dataset.yaml \-\-yes
|
|
2983
|
+
postman dataset delete 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-\-yes
|
|
2849
2984
|
|
|
2850
2985
|
|
|
2851
2986
|
|
|
@@ -2858,32 +2993,39 @@ Examples:
|
|
|
2858
2993
|
.B Subcommands:
|
|
2859
2994
|
.TP
|
|
2860
2995
|
.B dataset source list
|
|
2861
|
-
[BETA] List the datasources defined on a dataset.
|
|
2996
|
+
[BETA] List the datasources defined on a dataset (local YAML path or cloud id).
|
|
2862
2997
|
.TP
|
|
2863
2998
|
.B dataset source add
|
|
2864
2999
|
[BETA] Add a datasource to a dataset.
|
|
2865
3000
|
.TP
|
|
2866
3001
|
.B dataset source remove
|
|
2867
|
-
[BETA] Remove a datasource from a dataset.
|
|
3002
|
+
[BETA] Remove a datasource from a dataset (local YAML path or cloud id).
|
|
2868
3003
|
.TP
|
|
2869
3004
|
.B dataset source update
|
|
2870
3005
|
[BETA] Update fields on an existing datasource. Only the flags you provide are changed.
|
|
2871
3006
|
|
|
2872
3007
|
.SS "dataset source list"
|
|
2873
|
-
[BETA] List the datasources defined on a dataset.
|
|
3008
|
+
[BETA] List the datasources defined on a dataset (local YAML path or cloud id).
|
|
2874
3009
|
|
|
2875
3010
|
.B Usage:
|
|
2876
|
-
[options]
|
|
3011
|
+
[options]
|
|
2877
3012
|
|
|
2878
3013
|
.B Options:
|
|
2879
3014
|
.TP
|
|
3015
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3016
|
+
Dataset whose sources to list — a local .dataset.yaml path or a cloud dataset id
|
|
3017
|
+
.TP
|
|
3018
|
+
.B \-\-api\-key <key>
|
|
3019
|
+
Postman API key (defaults to the `postman login` session)
|
|
3020
|
+
.TP
|
|
2880
3021
|
.B \-\-json
|
|
2881
3022
|
Output sources as JSON instead of a table
|
|
2882
3023
|
|
|
2883
3024
|
.TP Examples:
|
|
2884
3025
|
|
|
2885
3026
|
Examples:
|
|
2886
|
-
postman dataset source list ./postman/datasets/users/users.dataset.yaml
|
|
3027
|
+
postman dataset source list \-d ./postman/datasets/users/users.dataset.yaml
|
|
3028
|
+
postman dataset source list \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
2887
3029
|
|
|
2888
3030
|
|
|
2889
3031
|
|
|
@@ -2891,14 +3033,17 @@ Examples:
|
|
|
2891
3033
|
[BETA] Add a datasource to a dataset.
|
|
2892
3034
|
|
|
2893
3035
|
.B Usage:
|
|
2894
|
-
[options]
|
|
3036
|
+
[options]
|
|
2895
3037
|
|
|
2896
3038
|
.B Options:
|
|
2897
3039
|
.TP
|
|
3040
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3041
|
+
Dataset to add the source to — a local .dataset.yaml path or a cloud dataset id
|
|
3042
|
+
.TP
|
|
2898
3043
|
.B \-n, \-\-name <name>
|
|
2899
3044
|
Logical name for the source (becomes the SQL table name)
|
|
2900
3045
|
.TP
|
|
2901
|
-
.B \-\-id <uuid>
|
|
3046
|
+
.B \-\-source\-id <uuid>
|
|
2902
3047
|
Override the generated source id
|
|
2903
3048
|
.TP
|
|
2904
3049
|
.B \-\-format <csv|json|mysql|postgres>
|
|
@@ -2911,10 +3056,13 @@ Source kind; inferred from \-\-file/\-\-url when omitted
|
|
|
2911
3056
|
Path to a local CSV/JSON file (absolute or cwd\-relative)
|
|
2912
3057
|
.TP
|
|
2913
3058
|
.B \-\-ref\-only
|
|
2914
|
-
Reference the file in place; do NOT copy into data_dir
|
|
3059
|
+
Reference the file in place; do NOT copy into data_dir (local dataset)
|
|
2915
3060
|
.TP
|
|
2916
3061
|
.B \-\-force
|
|
2917
|
-
When copying, overwrite an existing file at the destination
|
|
3062
|
+
When copying, overwrite an existing file at the destination (local dataset)
|
|
3063
|
+
.TP
|
|
3064
|
+
.B \-\-upload
|
|
3065
|
+
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
3066
|
.TP
|
|
2919
3067
|
.B \-\-url <url>
|
|
2920
3068
|
HTTP(S) URL to a remote CSV/JSON file
|
|
@@ -2929,7 +3077,7 @@ DB port
|
|
|
2929
3077
|
DB user (warning: stored as plaintext in the YAML).
|
|
2930
3078
|
.TP
|
|
2931
3079
|
.B \-\-password <password>
|
|
2932
|
-
DB password
|
|
3080
|
+
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
3081
|
.TP
|
|
2934
3082
|
.B \-\-database <db>
|
|
2935
3083
|
DB database name
|
|
@@ -2939,18 +3087,30 @@ DB table name (optional)
|
|
|
2939
3087
|
.TP
|
|
2940
3088
|
.B \-\-slug <slug>
|
|
2941
3089
|
Optional slug for the source
|
|
3090
|
+
.TP
|
|
3091
|
+
.B \-\-api\-key <key>
|
|
3092
|
+
Postman API key (defaults to the `postman login` session)
|
|
2942
3093
|
|
|
2943
3094
|
.SS "dataset source remove"
|
|
2944
|
-
[BETA] Remove a datasource from a dataset.
|
|
3095
|
+
[BETA] Remove a datasource from a dataset (local YAML path or cloud id).
|
|
2945
3096
|
|
|
2946
3097
|
.B Usage:
|
|
2947
|
-
[options] <
|
|
3098
|
+
[options] <sourceNameOrId>
|
|
3099
|
+
|
|
3100
|
+
.B Options:
|
|
3101
|
+
.TP
|
|
3102
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3103
|
+
Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3104
|
+
.TP
|
|
3105
|
+
.B \-\-api\-key <key>
|
|
3106
|
+
Postman API key (defaults to the `postman login` session)
|
|
2948
3107
|
|
|
2949
3108
|
.TP Examples:
|
|
2950
3109
|
|
|
2951
3110
|
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
|
|
3111
|
+
postman dataset source remove \-d ./users.dataset.yaml source_people_1
|
|
3112
|
+
postman dataset source remove \-d ./users.dataset.yaml d3e67bc9\-f9a3\-43b5\-b894\-d00f1791258c
|
|
3113
|
+
postman dataset source remove \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de source_people_1
|
|
2954
3114
|
|
|
2955
3115
|
|
|
2956
3116
|
|
|
@@ -2958,10 +3118,13 @@ Examples:
|
|
|
2958
3118
|
[BETA] Update fields on an existing datasource. Only the flags you provide are changed.
|
|
2959
3119
|
|
|
2960
3120
|
.B Usage:
|
|
2961
|
-
[options] <
|
|
3121
|
+
[options] <sourceNameOrId>
|
|
2962
3122
|
|
|
2963
3123
|
.B Options:
|
|
2964
3124
|
.TP
|
|
3125
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3126
|
+
Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3127
|
+
.TP
|
|
2965
3128
|
.B \-n, \-\-name <name>
|
|
2966
3129
|
Rename the source
|
|
2967
3130
|
.TP
|
|
@@ -2990,7 +3153,7 @@ Update DB port
|
|
|
2990
3153
|
Update DB user (warning: stored as plaintext in the YAML).
|
|
2991
3154
|
.TP
|
|
2992
3155
|
.B \-\-password <password>
|
|
2993
|
-
Update DB password
|
|
3156
|
+
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
3157
|
.TP
|
|
2995
3158
|
.B \-\-database <db>
|
|
2996
3159
|
Update DB database name
|
|
@@ -3000,6 +3163,9 @@ Update DB table name
|
|
|
3000
3163
|
.TP
|
|
3001
3164
|
.B \-\-slug <slug>
|
|
3002
3165
|
Update slug
|
|
3166
|
+
.TP
|
|
3167
|
+
.B \-\-api\-key <key>
|
|
3168
|
+
Postman API key (defaults to the `postman login` session)
|
|
3003
3169
|
|
|
3004
3170
|
.SS "dataset view"
|
|
3005
3171
|
[BETA] Inspect and manage saved views on a dataset.
|
|
@@ -3010,35 +3176,42 @@ Update slug
|
|
|
3010
3176
|
.B Subcommands:
|
|
3011
3177
|
.TP
|
|
3012
3178
|
.B dataset view list
|
|
3013
|
-
[BETA] List the saved views defined on a dataset.
|
|
3179
|
+
[BETA] List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3014
3180
|
.TP
|
|
3015
3181
|
.B dataset view run
|
|
3016
3182
|
[BETA] Execute a saved view against a dataset and print the rows.
|
|
3017
3183
|
.TP
|
|
3018
3184
|
.B dataset view create
|
|
3019
|
-
[BETA] Add a saved view to a dataset.
|
|
3185
|
+
[BETA] Add a saved view to a dataset (local YAML path or cloud id).
|
|
3020
3186
|
.TP
|
|
3021
3187
|
.B dataset view delete
|
|
3022
|
-
[BETA] Remove a saved view from a dataset.
|
|
3188
|
+
[BETA] Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3023
3189
|
.TP
|
|
3024
3190
|
.B dataset view update
|
|
3025
|
-
[BETA] Update name and/or query on an existing view.
|
|
3191
|
+
[BETA] Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3026
3192
|
|
|
3027
3193
|
.SS "dataset view list"
|
|
3028
|
-
[BETA] List the saved views defined on a dataset.
|
|
3194
|
+
[BETA] List the saved views defined on a dataset (local YAML path or cloud id).
|
|
3029
3195
|
|
|
3030
3196
|
.B Usage:
|
|
3031
|
-
[options]
|
|
3197
|
+
[options]
|
|
3032
3198
|
|
|
3033
3199
|
.B Options:
|
|
3034
3200
|
.TP
|
|
3201
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3202
|
+
Dataset whose views to list — a local .dataset.yaml path or a cloud dataset id
|
|
3203
|
+
.TP
|
|
3204
|
+
.B \-\-api\-key <key>
|
|
3205
|
+
Postman API key (defaults to the `postman login` session)
|
|
3206
|
+
.TP
|
|
3035
3207
|
.B \-\-json
|
|
3036
3208
|
Output views as JSON instead of a table
|
|
3037
3209
|
|
|
3038
3210
|
.TP Examples:
|
|
3039
3211
|
|
|
3040
3212
|
Examples:
|
|
3041
|
-
postman dataset view list ./postman/datasets/users/users.dataset.yaml
|
|
3213
|
+
postman dataset view list \-d ./postman/datasets/users/users.dataset.yaml
|
|
3214
|
+
postman dataset view list \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
3042
3215
|
|
|
3043
3216
|
|
|
3044
3217
|
|
|
@@ -3046,80 +3219,111 @@ Examples:
|
|
|
3046
3219
|
[BETA] Execute a saved view against a dataset and print the rows.
|
|
3047
3220
|
|
|
3048
3221
|
.B Usage:
|
|
3049
|
-
[options] <
|
|
3222
|
+
[options] <viewNameOrId>
|
|
3050
3223
|
|
|
3051
3224
|
.B Options:
|
|
3052
3225
|
.TP
|
|
3226
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3227
|
+
Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3228
|
+
.TP
|
|
3053
3229
|
.B \-p, \-\-param <value...>
|
|
3054
3230
|
Positional parameter values for $1, $2, ... bindings; repeatable
|
|
3055
3231
|
.TP
|
|
3232
|
+
.B \-\-api\-key <key>
|
|
3233
|
+
Postman API key (defaults to the `postman login` session)
|
|
3234
|
+
.TP
|
|
3056
3235
|
.B \-\-json
|
|
3057
3236
|
Output rows as JSON instead of a table
|
|
3058
3237
|
|
|
3059
3238
|
.TP Examples:
|
|
3060
3239
|
|
|
3061
3240
|
Examples:
|
|
3062
|
-
postman dataset view run ./users.dataset.yaml
|
|
3063
|
-
postman dataset view run
|
|
3241
|
+
postman dataset view run "Active Users" \-d ./users.dataset.yaml
|
|
3242
|
+
postman dataset view run ea748a6a\-ed3c\-496d\-b91e\-6ccc8e4d0e9d \-d ./users.dataset.yaml
|
|
3243
|
+
postman dataset view run "Active Users" \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de
|
|
3064
3244
|
|
|
3065
3245
|
|
|
3066
3246
|
|
|
3067
3247
|
.SS "dataset view create"
|
|
3068
|
-
[BETA] Add a saved view to a dataset.
|
|
3248
|
+
[BETA] Add a saved view to a dataset (local YAML path or cloud id).
|
|
3069
3249
|
|
|
3070
3250
|
.B Usage:
|
|
3071
|
-
[options]
|
|
3251
|
+
[options]
|
|
3072
3252
|
|
|
3073
3253
|
.B Options:
|
|
3074
3254
|
.TP
|
|
3255
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3256
|
+
Dataset to add the view to — a local .dataset.yaml path or a cloud dataset id
|
|
3257
|
+
.TP
|
|
3075
3258
|
.B \-n, \-\-name <name>
|
|
3076
3259
|
View name
|
|
3077
3260
|
.TP
|
|
3078
3261
|
.B \-q, \-\-query <sql>
|
|
3079
3262
|
SQL query the view executes
|
|
3080
3263
|
.TP
|
|
3081
|
-
.B \-\-id <uuid>
|
|
3082
|
-
Override the generated view id
|
|
3264
|
+
.B \-\-view\-id <uuid>
|
|
3265
|
+
Override the generated view id (local only; cloud assigns its own)
|
|
3266
|
+
.TP
|
|
3267
|
+
.B \-\-api\-key <key>
|
|
3268
|
+
Postman API key (defaults to the `postman login` session)
|
|
3083
3269
|
|
|
3084
3270
|
.TP Examples:
|
|
3085
3271
|
|
|
3086
3272
|
Examples:
|
|
3087
|
-
postman dataset view create ./users.dataset.yaml \e
|
|
3273
|
+
postman dataset view create \-d ./users.dataset.yaml \e
|
|
3088
3274
|
\-n "Active Users" \-q "SELECT * FROM source_users WHERE active = true"
|
|
3275
|
+
postman dataset view create \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \e
|
|
3276
|
+
\-n "Active Users" \-q "SELECT * FROM users WHERE active = true"
|
|
3089
3277
|
|
|
3090
3278
|
|
|
3091
3279
|
|
|
3092
3280
|
.SS "dataset view delete"
|
|
3093
|
-
[BETA] Remove a saved view from a dataset.
|
|
3281
|
+
[BETA] Remove a saved view from a dataset (local YAML path or cloud id).
|
|
3094
3282
|
|
|
3095
3283
|
.B Usage:
|
|
3096
|
-
[options] <
|
|
3284
|
+
[options] <viewNameOrId>
|
|
3285
|
+
|
|
3286
|
+
.B Options:
|
|
3287
|
+
.TP
|
|
3288
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3289
|
+
Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3290
|
+
.TP
|
|
3291
|
+
.B \-\-api\-key <key>
|
|
3292
|
+
Postman API key (defaults to the `postman login` session)
|
|
3097
3293
|
|
|
3098
3294
|
.TP Examples:
|
|
3099
3295
|
|
|
3100
3296
|
Examples:
|
|
3101
|
-
postman dataset view delete ./users.dataset.yaml "Active Users"
|
|
3297
|
+
postman dataset view delete \-d ./users.dataset.yaml "Active Users"
|
|
3298
|
+
postman dataset view delete \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de "Active Users"
|
|
3102
3299
|
|
|
3103
3300
|
|
|
3104
3301
|
|
|
3105
3302
|
.SS "dataset view update"
|
|
3106
|
-
[BETA] Update name and/or query on an existing view.
|
|
3303
|
+
[BETA] Update name and/or query on an existing view (local YAML path or cloud id).
|
|
3107
3304
|
|
|
3108
3305
|
.B Usage:
|
|
3109
|
-
[options] <
|
|
3306
|
+
[options] <viewNameOrId>
|
|
3110
3307
|
|
|
3111
3308
|
.B Options:
|
|
3112
3309
|
.TP
|
|
3310
|
+
.B \-d, \-\-dataset <datasetPathOrId>
|
|
3311
|
+
Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id
|
|
3312
|
+
.TP
|
|
3113
3313
|
.B \-n, \-\-name <name>
|
|
3114
3314
|
New view name
|
|
3115
3315
|
.TP
|
|
3116
3316
|
.B \-q, \-\-query <sql>
|
|
3117
3317
|
New SQL query
|
|
3318
|
+
.TP
|
|
3319
|
+
.B \-\-api\-key <key>
|
|
3320
|
+
Postman API key (defaults to the `postman login` session)
|
|
3118
3321
|
|
|
3119
3322
|
.TP Examples:
|
|
3120
3323
|
|
|
3121
3324
|
Examples:
|
|
3122
|
-
postman dataset view update ./users.dataset.yaml
|
|
3325
|
+
postman dataset view update "Active Users" \-d ./users.dataset.yaml \-q "SELECT ..."
|
|
3326
|
+
postman dataset view update "Active Users" \-d 14e30f6c\-1234\-1234\-1234\-cafef00dc0de \-q "SELECT ..."
|
|
3123
3327
|
|
|
3124
3328
|
|
|
3125
3329
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.46.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.46.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.46.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.46.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.46.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.46.0"
|
|
66
66
|
}
|
|
67
67
|
}
|