postman-cli 1.46.0 → 1.47.2
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 +134 -4
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-08-
|
|
1
|
+
.TH POSTMAN 1 "2026-08-17" "v1.47.2" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -266,6 +266,9 @@ Show detailed information of collection run and each request sent
|
|
|
266
266
|
.B \-\-mock <path>
|
|
267
267
|
Start a mock server from manifest (.json, .yaml or .yml) file
|
|
268
268
|
.TP
|
|
269
|
+
.B \-\-port <port>
|
|
270
|
+
Port for the \-\-mock server; pass "auto" for an OS\-assigned ephemeral port (default: configured port, falls back to an ephemeral one if busy). Only valid with \-\-mock.
|
|
271
|
+
.TP
|
|
269
272
|
.B \-\-simulate <path>
|
|
270
273
|
Start mock servers with fault\-injection scenarios from a .sim.yaml file
|
|
271
274
|
.TP
|
|
@@ -276,6 +279,76 @@ Send run results and analytics to Postman
|
|
|
276
279
|
Eg. postman collection run 123456\-45159473\-1e45\-1f34\-5678\-1234567890ab
|
|
277
280
|
|
|
278
281
|
|
|
282
|
+
.SS "environment"
|
|
283
|
+
Work with local Postman environments from the command line.
|
|
284
|
+
|
|
285
|
+
.B Usage:
|
|
286
|
+
[options] [command]
|
|
287
|
+
|
|
288
|
+
.B Subcommands:
|
|
289
|
+
.TP
|
|
290
|
+
.B environment lint
|
|
291
|
+
Run linting on a local Postman environment at the given file or directory path.
|
|
292
|
+
|
|
293
|
+
.SS "environment lint"
|
|
294
|
+
Run linting on a local Postman environment at the given file or directory path.
|
|
295
|
+
|
|
296
|
+
.B Usage:
|
|
297
|
+
<path> [options]
|
|
298
|
+
|
|
299
|
+
.B Options:
|
|
300
|
+
.TP
|
|
301
|
+
.B \-f, \-\-fail\-severity <value>
|
|
302
|
+
Exit with failure if diagnostics at this level or above are present. [choices: "error", "warning"] (default: error)
|
|
303
|
+
.TP
|
|
304
|
+
.B \-o, \-\-output <value>
|
|
305
|
+
Output format: cli (human\-readable), table, json, or csv. (default: cli)
|
|
306
|
+
|
|
307
|
+
.TP Examples:
|
|
308
|
+
|
|
309
|
+
Examples:
|
|
310
|
+
$ postman environment lint ./postman/environments
|
|
311
|
+
$ postman environment lint ./dev.environment.yaml
|
|
312
|
+
$ postman environment lint ./postman/environments \-\-output json
|
|
313
|
+
$ postman environment lint ./dev.environment.yaml \-\-fail\-severity warning
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
.SS "globals"
|
|
318
|
+
Work with local Postman globals from the command line.
|
|
319
|
+
|
|
320
|
+
.B Usage:
|
|
321
|
+
[options] [command]
|
|
322
|
+
|
|
323
|
+
.B Subcommands:
|
|
324
|
+
.TP
|
|
325
|
+
.B globals lint
|
|
326
|
+
Run linting on a local Postman globals file at the given file or directory path.
|
|
327
|
+
|
|
328
|
+
.SS "globals lint"
|
|
329
|
+
Run linting on a local Postman globals file at the given file or directory path.
|
|
330
|
+
|
|
331
|
+
.B Usage:
|
|
332
|
+
<path> [options]
|
|
333
|
+
|
|
334
|
+
.B Options:
|
|
335
|
+
.TP
|
|
336
|
+
.B \-f, \-\-fail\-severity <value>
|
|
337
|
+
Exit with failure if diagnostics at this level or above are present. [choices: "error", "warning"] (default: error)
|
|
338
|
+
.TP
|
|
339
|
+
.B \-o, \-\-output <value>
|
|
340
|
+
Output format: cli (human\-readable), table, json, or csv. (default: cli)
|
|
341
|
+
|
|
342
|
+
.TP Examples:
|
|
343
|
+
|
|
344
|
+
Examples:
|
|
345
|
+
$ postman globals lint ./postman/globals
|
|
346
|
+
$ postman globals lint ./workspace.globals.yaml
|
|
347
|
+
$ postman globals lint ./postman/globals \-\-output json
|
|
348
|
+
$ postman globals lint ./workspace.globals.yaml \-\-fail\-severity warning
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
279
352
|
.SS "api"
|
|
280
353
|
Publish and test your APIs directly from the command line
|
|
281
354
|
|
|
@@ -604,6 +677,21 @@ Load profile type: fixed, ramp\-up, spike, peak (default: ramp\-up)
|
|
|
604
677
|
.B \-\-data\-file <path>
|
|
605
678
|
Path to a JSON or CSV data file to use with the collection
|
|
606
679
|
.TP
|
|
680
|
+
.B \-\-dataset\-id <id>
|
|
681
|
+
Use a Postman Dataset as iteration data (with \-\-dataset\-view\-id)
|
|
682
|
+
.TP
|
|
683
|
+
.B \-\-dataset\-view\-id <id>
|
|
684
|
+
Dataset view to execute for iteration data (requires \-\-dataset\-id)
|
|
685
|
+
.TP
|
|
686
|
+
.B \-\-dataset\-offset <offset>
|
|
687
|
+
Row offset into the view result (optional range)
|
|
688
|
+
.TP
|
|
689
|
+
.B \-\-dataset\-limit <limit>
|
|
690
|
+
Max rows to fetch from the view (optional range)
|
|
691
|
+
.TP
|
|
692
|
+
.B \-\-dataset\-distribution <strategy>
|
|
693
|
+
How rows map to VUs: round\-robin (default), pinned, random
|
|
694
|
+
.TP
|
|
607
695
|
.B \-\-postman\-api\-key <apiKey>
|
|
608
696
|
API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
|
|
609
697
|
.TP
|
|
@@ -1301,7 +1389,7 @@ Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncA
|
|
|
1301
1389
|
.B Options:
|
|
1302
1390
|
.TP
|
|
1303
1391
|
.B \-l, \-\-language <languages...>
|
|
1304
|
-
Target language(s) for SDK generation. Specify one or more languages. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust"]
|
|
1392
|
+
Target language(s) for SDK generation. Specify one or more languages. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust", "swift"]
|
|
1305
1393
|
.TP
|
|
1306
1394
|
.B \-\-all
|
|
1307
1395
|
Generate SDKs for all supported languages
|
|
@@ -1403,7 +1491,7 @@ Enable change tracking for a generated SDK. Adds file hashes to .manifest.json s
|
|
|
1403
1491
|
.B Options:
|
|
1404
1492
|
.TP
|
|
1405
1493
|
.B \-l, \-\-language <languages...>
|
|
1406
|
-
Language(s) to track. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust"]
|
|
1494
|
+
Language(s) to track. [choices: "typescript", "python", "java", "go", "csharp", "php", "ruby", "cli", "kotlin", "rust", "swift"]
|
|
1407
1495
|
.TP
|
|
1408
1496
|
.B \-o, \-\-output\-dir <path>
|
|
1409
1497
|
Base directory containing generated SDKs (default: ./sdks)
|
|
@@ -1522,7 +1610,7 @@ Connect a collection or specification to a GitHub repository for automatic SDK p
|
|
|
1522
1610
|
.B Options:
|
|
1523
1611
|
.TP
|
|
1524
1612
|
.B \-l, \-\-language <language>
|
|
1525
|
-
SDK language (required) [choices: typescript, python, java, go, csharp, php, ruby, cli, kotlin, rust]
|
|
1613
|
+
SDK language (required) [choices: typescript, python, java, go, csharp, php, ruby, cli, kotlin, rust, swift]
|
|
1526
1614
|
.TP
|
|
1527
1615
|
.B \-r, \-\-repo <owner/name>
|
|
1528
1616
|
GitHub repository in <owner>/<name> form (alternative to \-\-repo\-owner + \-\-repo\-name)
|
|
@@ -1654,9 +1742,46 @@ Run and manage local Postman mock servers.
|
|
|
1654
1742
|
|
|
1655
1743
|
.B Subcommands:
|
|
1656
1744
|
.TP
|
|
1745
|
+
.B mock generate
|
|
1746
|
+
Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git\-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto\-detected.
|
|
1747
|
+
.TP
|
|
1657
1748
|
.B mock run
|
|
1658
1749
|
Start a local mock server given a manifest file (JSON or YAML).
|
|
1659
1750
|
|
|
1751
|
+
.SS "mock generate"
|
|
1752
|
+
Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git\-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto\-detected.
|
|
1753
|
+
|
|
1754
|
+
.B Usage:
|
|
1755
|
+
<sourcePath> [options]
|
|
1756
|
+
|
|
1757
|
+
.B Options:
|
|
1758
|
+
.TP
|
|
1759
|
+
.B \-o, \-\-output <dir>
|
|
1760
|
+
Output directory for the mock (default: postman/mocks/<slug>)
|
|
1761
|
+
.TP
|
|
1762
|
+
.B \-\-name <name>
|
|
1763
|
+
Display name for the generated mock
|
|
1764
|
+
.TP
|
|
1765
|
+
.B \-\-port <port>
|
|
1766
|
+
Port the mock server should listen on (default: 4500)
|
|
1767
|
+
.TP
|
|
1768
|
+
.B \-\-force
|
|
1769
|
+
Overwrite the config.yaml/default.js in the output directory if it already exists
|
|
1770
|
+
.TP
|
|
1771
|
+
.B \-u, \-\-update <mockPath>
|
|
1772
|
+
Update an existing mock in place from the source: path to its config.yaml (or the directory containing it). Regenerates the default scenario handler and preserves the existing name/port/scenarios. Cannot be combined with \-\-output.
|
|
1773
|
+
.TP
|
|
1774
|
+
.B \-x, \-\-suppress\-exit\-code
|
|
1775
|
+
Always exit with code 0, even on failure
|
|
1776
|
+
|
|
1777
|
+
.TP Examples:
|
|
1778
|
+
|
|
1779
|
+
Eg. postman mock generate ./my\-collection.json
|
|
1780
|
+
postman mock generate "./postman/collections/My Collection" \-\-port 4010
|
|
1781
|
+
postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
|
|
1782
|
+
postman mock generate ./my\-collection.json \-\-update ./postman/mocks/orders
|
|
1783
|
+
|
|
1784
|
+
|
|
1660
1785
|
.SS "mock run"
|
|
1661
1786
|
Start a local mock server given a manifest file (JSON or YAML).
|
|
1662
1787
|
|
|
@@ -1670,11 +1795,16 @@ Path to an environment file (JSON or YAML) for pm.environment
|
|
|
1670
1795
|
.TP
|
|
1671
1796
|
.B \-g, \-\-globals <path>
|
|
1672
1797
|
Path to a globals file (JSON or YAML) for pm.globals
|
|
1798
|
+
.TP
|
|
1799
|
+
.B \-p, \-\-port <port>
|
|
1800
|
+
Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
|
|
1673
1801
|
|
|
1674
1802
|
.TP Examples:
|
|
1675
1803
|
Eg. postman mock run ./postman/mock\-manifest.json
|
|
1676
1804
|
postman mock run ./postman/mock\-manifest.yaml
|
|
1677
1805
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1806
|
+
postman mock run ./manifest.yaml \-\-port auto # OS\-assigned ephemeral port
|
|
1807
|
+
postman mock run ./manifest.yaml \-\-port 4600 # exact port, errors if busy
|
|
1678
1808
|
|
|
1679
1809
|
|
|
1680
1810
|
.SS "application"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.47.2",
|
|
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.47.2",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.47.2",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.47.2",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.47.2",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.47.2"
|
|
66
66
|
}
|
|
67
67
|
}
|