postman-cli 1.45.0 → 1.46.1
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 +144 -9
- 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-12" "v1.46.1" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -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
|
|
@@ -276,6 +276,76 @@ Send run results and analytics to Postman
|
|
|
276
276
|
Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
|
|
277
277
|
|
|
278
278
|
|
|
279
|
+
.SS "environment"
|
|
280
|
+
Work with local Postman environments from the command line.
|
|
281
|
+
|
|
282
|
+
.B Usage:
|
|
283
|
+
[options] [command]
|
|
284
|
+
|
|
285
|
+
.B Subcommands:
|
|
286
|
+
.TP
|
|
287
|
+
.B environment lint
|
|
288
|
+
Run linting on a local Postman environment at the given file or directory path.
|
|
289
|
+
|
|
290
|
+
.SS "environment lint"
|
|
291
|
+
Run linting on a local Postman environment at the given file or directory path.
|
|
292
|
+
|
|
293
|
+
.B Usage:
|
|
294
|
+
<path> [options]
|
|
295
|
+
|
|
296
|
+
.B Options:
|
|
297
|
+
.TP
|
|
298
|
+
.B \-f, \-\-fail\-severity <value>
|
|
299
|
+
Exit with failure if diagnostics at this level or above are present. [choices: "error", "warning"] (default: error)
|
|
300
|
+
.TP
|
|
301
|
+
.B \-o, \-\-output <value>
|
|
302
|
+
Output format: cli (human\-readable), table, json, or csv. (default: cli)
|
|
303
|
+
|
|
304
|
+
.TP Examples:
|
|
305
|
+
|
|
306
|
+
Examples:
|
|
307
|
+
$ postman environment lint ./postman/environments
|
|
308
|
+
$ postman environment lint ./dev.environment.yaml
|
|
309
|
+
$ postman environment lint ./postman/environments \-\-output json
|
|
310
|
+
$ postman environment lint ./dev.environment.yaml \-\-fail\-severity warning
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
.SS "globals"
|
|
315
|
+
Work with local Postman globals from the command line.
|
|
316
|
+
|
|
317
|
+
.B Usage:
|
|
318
|
+
[options] [command]
|
|
319
|
+
|
|
320
|
+
.B Subcommands:
|
|
321
|
+
.TP
|
|
322
|
+
.B globals lint
|
|
323
|
+
Run linting on a local Postman globals file at the given file or directory path.
|
|
324
|
+
|
|
325
|
+
.SS "globals lint"
|
|
326
|
+
Run linting on a local Postman globals file at the given file or directory path.
|
|
327
|
+
|
|
328
|
+
.B Usage:
|
|
329
|
+
<path> [options]
|
|
330
|
+
|
|
331
|
+
.B Options:
|
|
332
|
+
.TP
|
|
333
|
+
.B \-f, \-\-fail\-severity <value>
|
|
334
|
+
Exit with failure if diagnostics at this level or above are present. [choices: "error", "warning"] (default: error)
|
|
335
|
+
.TP
|
|
336
|
+
.B \-o, \-\-output <value>
|
|
337
|
+
Output format: cli (human\-readable), table, json, or csv. (default: cli)
|
|
338
|
+
|
|
339
|
+
.TP Examples:
|
|
340
|
+
|
|
341
|
+
Examples:
|
|
342
|
+
$ postman globals lint ./postman/globals
|
|
343
|
+
$ postman globals lint ./workspace.globals.yaml
|
|
344
|
+
$ postman globals lint ./postman/globals \-\-output json
|
|
345
|
+
$ postman globals lint ./workspace.globals.yaml \-\-fail\-severity warning
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
279
349
|
.SS "api"
|
|
280
350
|
Publish and test your APIs directly from the command line
|
|
281
351
|
|
|
@@ -596,7 +666,7 @@ Specify an Id to a Postman Globals
|
|
|
596
666
|
Number of virtual users (default: 20)
|
|
597
667
|
.TP
|
|
598
668
|
.B \-d, \-\-duration <minutes>
|
|
599
|
-
Duration of the performance test in minutes (default:
|
|
669
|
+
Duration of the performance test in minutes (default: 1)
|
|
600
670
|
.TP
|
|
601
671
|
.B \-p, \-\-load\-profile <profile>
|
|
602
672
|
Load profile type: fixed, ramp\-up, spike, peak (default: ramp\-up)
|
|
@@ -802,6 +872,15 @@ Set flow inputs from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-f
|
|
|
802
872
|
.B \-s, \-\-scenario <name>
|
|
803
873
|
Use a pre\-built scenario as flow inputs (by scenario name). Can be combined with \-\-input and \-\-input\-file to override values.
|
|
804
874
|
.TP
|
|
875
|
+
.B \-\-iteration\-data\-dataset <path>
|
|
876
|
+
[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).
|
|
877
|
+
.TP
|
|
878
|
+
.B \-\-iteration\-data\-view <nameOrId>
|
|
879
|
+
[BETA] Name or id of the view (within \-\-iteration\-data\-dataset) whose rows drive the run.
|
|
880
|
+
.TP
|
|
881
|
+
.B \-\-map <input=column>
|
|
882
|
+
[BETA] Bind a flow input to a dataset column (e.g. \-\-map isActive=active). Repeatable. Inputs whose name matches a column bind automatically. (default: )
|
|
883
|
+
.TP
|
|
805
884
|
.B \-e, \-\-environment <path>
|
|
806
885
|
Specify a path to a Postman Environment file (JSON or YAML)
|
|
807
886
|
.TP
|
|
@@ -1292,7 +1371,7 @@ Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncA
|
|
|
1292
1371
|
.B Options:
|
|
1293
1372
|
.TP
|
|
1294
1373
|
.B \-l, \-\-language <languages...>
|
|
1295
|
-
Target language(s) for SDK generation. Specify one or more languages. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust"]
|
|
1374
|
+
Target language(s) for SDK generation. Specify one or more languages. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust", "swift"]
|
|
1296
1375
|
.TP
|
|
1297
1376
|
.B \-\-all
|
|
1298
1377
|
Generate SDKs for all supported languages
|
|
@@ -1394,7 +1473,7 @@ Enable change tracking for a generated SDK. Adds file hashes to .manifest.json s
|
|
|
1394
1473
|
.B Options:
|
|
1395
1474
|
.TP
|
|
1396
1475
|
.B \-l, \-\-language <languages...>
|
|
1397
|
-
Language(s) to track. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust"]
|
|
1476
|
+
Language(s) to track. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust", "swift"]
|
|
1398
1477
|
.TP
|
|
1399
1478
|
.B \-o, \-\-output\-dir <path>
|
|
1400
1479
|
Base directory containing generated SDKs (default: ./sdks)
|
|
@@ -1513,7 +1592,7 @@ Connect a collection or specification to a GitHub repository for automatic SDK p
|
|
|
1513
1592
|
.B Options:
|
|
1514
1593
|
.TP
|
|
1515
1594
|
.B \-l, \-\-language <language>
|
|
1516
|
-
SDK language (required) [choices: typescript, python, java, go, csharp, php, ruby, cli, kotlin, rust]
|
|
1595
|
+
SDK language (required) [choices: typescript, python, java, go, csharp, php, ruby, cli, kotlin, rust, swift]
|
|
1517
1596
|
.TP
|
|
1518
1597
|
.B \-r, \-\-repo <owner/name>
|
|
1519
1598
|
GitHub repository in <owner>/<name> form (alternative to \-\-repo\-owner + \-\-repo\-name)
|
|
@@ -1646,10 +1725,10 @@ Run and manage local Postman mock servers.
|
|
|
1646
1725
|
.B Subcommands:
|
|
1647
1726
|
.TP
|
|
1648
1727
|
.B mock run
|
|
1649
|
-
Start a local mock server given a manifest file.
|
|
1728
|
+
Start a local mock server given a manifest file (JSON or YAML).
|
|
1650
1729
|
|
|
1651
1730
|
.SS "mock run"
|
|
1652
|
-
Start a local mock server given a manifest file.
|
|
1731
|
+
Start a local mock server given a manifest file (JSON or YAML).
|
|
1653
1732
|
|
|
1654
1733
|
.B Usage:
|
|
1655
1734
|
<manifestPath>
|
|
@@ -1664,6 +1743,7 @@ Path to a globals file (JSON or YAML) for pm.globals
|
|
|
1664
1743
|
|
|
1665
1744
|
.TP Examples:
|
|
1666
1745
|
Eg. postman mock run ./postman/mock\-manifest.json
|
|
1746
|
+
postman mock run ./postman/mock\-manifest.yaml
|
|
1667
1747
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1668
1748
|
|
|
1669
1749
|
|
|
@@ -2070,7 +2150,7 @@ Quick start:
|
|
|
2070
2150
|
postman search requests "auth"
|
|
2071
2151
|
postman search requests "auth" \-\-filter "method=POST AND visibility=public" \-\-ownership org \-\-limit 10 \-\-output json
|
|
2072
2152
|
|
|
2073
|
-
Element types: requests, collections, workspaces, flows, specs, environments, mocks
|
|
2153
|
+
Element types: requests, collections, workspaces, flows, specs, environments, mocks, documents
|
|
2074
2154
|
|
|
2075
2155
|
Detailed help is split by element type:
|
|
2076
2156
|
postman search requests \-\-help Request filters and examples
|
|
@@ -2080,6 +2160,7 @@ Detailed help is split by element type:
|
|
|
2080
2160
|
postman search specs \-\-help API spec filters and examples
|
|
2081
2161
|
postman search mocks \-\-help Mock filters and examples
|
|
2082
2162
|
postman search environments \-\-help Environment filters and examples
|
|
2163
|
+
postman search documents \-\-help Document filters and examples
|
|
2083
2164
|
|
|
2084
2165
|
Pagination: \-\-limit accepts up to 25 results. Use \-\-cursor from the previous response to paginate.
|
|
2085
2166
|
|
|
@@ -2106,6 +2187,9 @@ Search for mocks by name or keyword.
|
|
|
2106
2187
|
.TP
|
|
2107
2188
|
.B search environments
|
|
2108
2189
|
Search for environments by name or keyword.
|
|
2190
|
+
.TP
|
|
2191
|
+
.B search documents
|
|
2192
|
+
Search for documents by name or keyword.
|
|
2109
2193
|
|
|
2110
2194
|
.SS "search requests"
|
|
2111
2195
|
Search for requests by name or keyword.
|
|
@@ -2478,6 +2562,57 @@ Examples:
|
|
|
2478
2562
|
postman search environments \-\-filter "environmentId=env\-abc123"
|
|
2479
2563
|
|
|
2480
2564
|
|
|
2565
|
+
.SS "search documents"
|
|
2566
|
+
Search for documents by name or keyword.
|
|
2567
|
+
|
|
2568
|
+
.B Usage:
|
|
2569
|
+
[options] [query]
|
|
2570
|
+
|
|
2571
|
+
.TP Examples:
|
|
2572
|
+
|
|
2573
|
+
Use \-\-cursor from the previous response to paginate.
|
|
2574
|
+
Ownership:
|
|
2575
|
+
organization, org Search resources owned by your organization
|
|
2576
|
+
external Search resources outside your organization
|
|
2577
|
+
all Search both organization and external resources
|
|
2578
|
+
|
|
2579
|
+
Output modes:
|
|
2580
|
+
default Card list including basic overview and web link per result
|
|
2581
|
+
json Detailed JSON response with search metadata
|
|
2582
|
+
|
|
2583
|
+
Filter syntax:
|
|
2584
|
+
Use = or != for single values: workspaceId=ws\-1
|
|
2585
|
+
Use IN or NIN for comma\-separated values: workspaceId IN ws\-1,ws\-2
|
|
2586
|
+
Combine filters with AND. Operators are case\-insensitive.
|
|
2587
|
+
Quote supported values that contain spaces or commas: <field>="value with spaces"
|
|
2588
|
+
|
|
2589
|
+
\-\-filter\-json format:
|
|
2590
|
+
{"$and":[{"workspaceId":{"$eq":"ws\-abc123"}}]}
|
|
2591
|
+
Only a top\-level $and array is supported; $or and nested groups are not supported.
|
|
2592
|
+
Each condition maps one field to one operator object ($eq, $ne, $in, $nin).
|
|
2593
|
+
|
|
2594
|
+
Shared filter fields:
|
|
2595
|
+
privateNetwork $eq, $ne (true/false)
|
|
2596
|
+
publisherIsVerified $eq, $ne (true/false)
|
|
2597
|
+
visibility $eq, $ne (internal, public, partner)
|
|
2598
|
+
workspaceId $eq, $ne, $in, $nin
|
|
2599
|
+
createdBy $eq, $ne, $in, $nin (user ID)
|
|
2600
|
+
organizationId $eq, $ne, $in, $nin (organization ID)
|
|
2601
|
+
teamId $eq, $ne, $in, $nin (team ID)
|
|
2602
|
+
isGitConnected $eq, $ne (true/false)
|
|
2603
|
+
|
|
2604
|
+
Document filter fields:
|
|
2605
|
+
documentId $eq, $ne, $in, $nin
|
|
2606
|
+
|
|
2607
|
+
ID filters such as createdBy, organizationId, teamId, workspaceId, and collectionId expect IDs.
|
|
2608
|
+
Use \-\-output json on a broader search result to inspect available IDs.
|
|
2609
|
+
|
|
2610
|
+
Examples:
|
|
2611
|
+
postman search documents "onboarding guide"
|
|
2612
|
+
postman search documents "api reference" \-\-filter "workspaceId=ws\-abc123"
|
|
2613
|
+
postman search documents \-\-filter "documentId=doc\-abc123"
|
|
2614
|
+
|
|
2615
|
+
|
|
2481
2616
|
.SS "webhook"
|
|
2482
2617
|
Create and manage Postman webhooks.
|
|
2483
2618
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.46.1",
|
|
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.1",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.46.1",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.46.1",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.46.1",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.46.1"
|
|
66
66
|
}
|
|
67
67
|
}
|