postman-cli 1.34.4 → 1.35.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 +124 -1
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-
|
|
1
|
+
.TH POSTMAN 1 "2026-05-06" "v1.35.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -711,6 +711,12 @@ Specify the path to the working directory
|
|
|
711
711
|
.B \-\-verbose
|
|
712
712
|
Show detailed information of flow run and each request (method, URL, assertions)
|
|
713
713
|
.TP
|
|
714
|
+
.B \-\-no\-truncate
|
|
715
|
+
Show full output without truncating long values
|
|
716
|
+
.TP
|
|
717
|
+
.B \-\-output <format>
|
|
718
|
+
Save execution result to a file (supported: json)
|
|
719
|
+
.TP
|
|
714
720
|
.B \-x, \-\-suppress\-exit\-code
|
|
715
721
|
Specify whether or not to override the default exit code for the current run
|
|
716
722
|
.TP
|
|
@@ -730,6 +736,7 @@ Example:
|
|
|
730
736
|
postman flows run ./path/to/flow.json \-i name=John \-i age=30
|
|
731
737
|
postman flows run ./path/to/flow.json \-\-input\-file ./inputs.json
|
|
732
738
|
postman flows run ./path/to/flow.json \-\-scenario production \-\-verbose
|
|
739
|
+
postman flows run ./path/to/flow.json \-\-output json
|
|
733
740
|
|
|
734
741
|
|
|
735
742
|
|
|
@@ -1435,6 +1442,122 @@ Eg. postman mock run ./postman/mock\-manifest.json
|
|
|
1435
1442
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1436
1443
|
|
|
1437
1444
|
|
|
1445
|
+
.SS "application"
|
|
1446
|
+
Application\-level commands: initialise config and run tests.
|
|
1447
|
+
|
|
1448
|
+
.B Usage:
|
|
1449
|
+
[options] [command]
|
|
1450
|
+
|
|
1451
|
+
.B Subcommands:
|
|
1452
|
+
.TP
|
|
1453
|
+
.B application init
|
|
1454
|
+
Initialise a postman.config.cjs file with target collections, environment, and test command.
|
|
1455
|
+
.TP
|
|
1456
|
+
.B application test
|
|
1457
|
+
Run a command first (primary task), then match captured traffic against Postman collections and run assertions.
|
|
1458
|
+
|
|
1459
|
+
.SS "application init"
|
|
1460
|
+
Initialise a postman.config.cjs file with target collections, environment, and test command.
|
|
1461
|
+
|
|
1462
|
+
.B Usage:
|
|
1463
|
+
[options]
|
|
1464
|
+
|
|
1465
|
+
.B Options:
|
|
1466
|
+
.TP
|
|
1467
|
+
.B \-\-target\-collection <name>
|
|
1468
|
+
Collection name or path for the default target (repeatable) (default: )
|
|
1469
|
+
.TP
|
|
1470
|
+
.B \-\-target\-environment <name>
|
|
1471
|
+
Environment name or path for the default target (last value wins) (default: )
|
|
1472
|
+
.TP
|
|
1473
|
+
.B \-\-filter\-urlpatterns <patterns>
|
|
1474
|
+
Comma\-separated URL patterns to exclude from captured traffic (default: )
|
|
1475
|
+
.TP
|
|
1476
|
+
.B \-\-filter\-methods <methods>
|
|
1477
|
+
Comma\-separated HTTP methods to exclude from captured traffic (default: )
|
|
1478
|
+
.TP
|
|
1479
|
+
.B \-\-filter\-headers <headers>
|
|
1480
|
+
Comma\-separated request header filters in header=value form (default: )
|
|
1481
|
+
.TP
|
|
1482
|
+
.B \-\-command <cmd>
|
|
1483
|
+
Command to run your tests (e.g. "npx playwright test")
|
|
1484
|
+
|
|
1485
|
+
.TP Examples:
|
|
1486
|
+
|
|
1487
|
+
In interactive mode (no CLI config flags), prompts for collections, environment, and command.
|
|
1488
|
+
In non\-interactive mode, pass \-\-target\-collection, \-\-target\-environment, filter flags, and/or \-\-command.
|
|
1489
|
+
|
|
1490
|
+
Examples:
|
|
1491
|
+
postman application init
|
|
1492
|
+
postman application init \-\-target\-collection "My API" \-\-target\-collection "Auth API" \-\-target\-environment Local \-\-command "npm test"
|
|
1493
|
+
postman application init \-\-filter\-urlpatterns "fonts.googleapis.com,fonts.gstatic.com" \-\-filter\-methods "OPTIONS,GET" \-\-filter\-headers "x\-requested\-with=fetch"
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
.SS "application test"
|
|
1497
|
+
Run a command first (primary task), then match captured traffic against Postman collections and run assertions.
|
|
1498
|
+
|
|
1499
|
+
.B Usage:
|
|
1500
|
+
[options]
|
|
1501
|
+
|
|
1502
|
+
.B Options:
|
|
1503
|
+
.TP
|
|
1504
|
+
.B \-\-target <name>
|
|
1505
|
+
Select a target from postman.config.js targets block (default: "default")
|
|
1506
|
+
.TP
|
|
1507
|
+
.B \-\-target\-collection <path>
|
|
1508
|
+
Collection override for the selected target (repeatable) (default: )
|
|
1509
|
+
.TP
|
|
1510
|
+
.B \-\-target\-environment <path>
|
|
1511
|
+
Environment override for the selected target (last value wins) (default: )
|
|
1512
|
+
.TP
|
|
1513
|
+
.B \-\-command <cmd>
|
|
1514
|
+
Command to run first (primary task). Overrides config.
|
|
1515
|
+
.TP
|
|
1516
|
+
.B \-\-network\-log <dir>
|
|
1517
|
+
Directory to scan for network\-capture NDJSON files (`network\-capture\-*.ndjson`; default: pm\-results/)
|
|
1518
|
+
.TP
|
|
1519
|
+
.B \-\-capture\-only
|
|
1520
|
+
Skip collection matching and tests; capture traffic and save a V3 collection organised by host
|
|
1521
|
+
.TP
|
|
1522
|
+
.B \-\-analyse\-only
|
|
1523
|
+
Do not run the primary command; analyse existing network\-capture NDJSON under the network log directory
|
|
1524
|
+
.TP
|
|
1525
|
+
.B \-\-run\-only
|
|
1526
|
+
Run only the primary command; skip analysis (use \-\-analyse\-only on merged captures later).
|
|
1527
|
+
.TP
|
|
1528
|
+
.B \-\-output <path>
|
|
1529
|
+
Output directory for captured collection (default: pm\-results/captured/; used with \-\-capture\-only)
|
|
1530
|
+
.TP
|
|
1531
|
+
.B \-\-save\-events\-local
|
|
1532
|
+
Write analytics events to pm\-results/test\-events\-debug.ndjson instead of sending to Postman
|
|
1533
|
+
.TP
|
|
1534
|
+
.B \-\-report\-events
|
|
1535
|
+
Send application test analytics to Postman
|
|
1536
|
+
.TP
|
|
1537
|
+
.B \-\-verbose
|
|
1538
|
+
Show detailed per\-request matching, sandbox errors, and debug information
|
|
1539
|
+
|
|
1540
|
+
.TP Examples:
|
|
1541
|
+
|
|
1542
|
+
Matches captured API traffic against your Postman dependency
|
|
1543
|
+
collections and runs pm.test assertions on the responses.
|
|
1544
|
+
|
|
1545
|
+
Collections and environments can be specified via postman.config.cjs targets
|
|
1546
|
+
or via \-\-target\-collection/\-\-target\-environment flags. CLI flags override the selected target.
|
|
1547
|
+
|
|
1548
|
+
Use \-\-capture\-only to skip tests and export captured traffic
|
|
1549
|
+
as a V3 Postman collection organised by host.
|
|
1550
|
+
|
|
1551
|
+
Analytics events are automatically sent when running in CI.
|
|
1552
|
+
|
|
1553
|
+
Examples:
|
|
1554
|
+
postman application test \-\-command "npx playwright test"
|
|
1555
|
+
postman application test \-\-target prod
|
|
1556
|
+
postman application test \-\-target beta \-\-target\-collection api.json \-\-target\-environment staging.json
|
|
1557
|
+
postman app test \-\-capture\-only \-\-command "npx playwright test"
|
|
1558
|
+
postman app test \-\-capture\-only \-\-output ./my\-captured\-traffic/
|
|
1559
|
+
|
|
1560
|
+
|
|
1438
1561
|
.SS "simulate"
|
|
1439
1562
|
Start mock servers with simulated failure scenarios.
|
|
1440
1563
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.35.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.35.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.35.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.35.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.35.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.35.0"
|
|
66
66
|
}
|
|
67
67
|
}
|