postman-cli 1.45.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 +71 -6
- 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
|
|
@@ -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
|
|
@@ -596,7 +596,7 @@ Specify an Id to a Postman Globals
|
|
|
596
596
|
Number of virtual users (default: 20)
|
|
597
597
|
.TP
|
|
598
598
|
.B \-d, \-\-duration <minutes>
|
|
599
|
-
Duration of the performance test in minutes (default:
|
|
599
|
+
Duration of the performance test in minutes (default: 1)
|
|
600
600
|
.TP
|
|
601
601
|
.B \-p, \-\-load\-profile <profile>
|
|
602
602
|
Load profile type: fixed, ramp\-up, spike, peak (default: ramp\-up)
|
|
@@ -802,6 +802,15 @@ Set flow inputs from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-f
|
|
|
802
802
|
.B \-s, \-\-scenario <name>
|
|
803
803
|
Use a pre\-built scenario as flow inputs (by scenario name). Can be combined with \-\-input and \-\-input\-file to override values.
|
|
804
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
|
|
805
814
|
.B \-e, \-\-environment <path>
|
|
806
815
|
Specify a path to a Postman Environment file (JSON or YAML)
|
|
807
816
|
.TP
|
|
@@ -1646,10 +1655,10 @@ Run and manage local Postman mock servers.
|
|
|
1646
1655
|
.B Subcommands:
|
|
1647
1656
|
.TP
|
|
1648
1657
|
.B mock run
|
|
1649
|
-
Start a local mock server given a manifest file.
|
|
1658
|
+
Start a local mock server given a manifest file (JSON or YAML).
|
|
1650
1659
|
|
|
1651
1660
|
.SS "mock run"
|
|
1652
|
-
Start a local mock server given a manifest file.
|
|
1661
|
+
Start a local mock server given a manifest file (JSON or YAML).
|
|
1653
1662
|
|
|
1654
1663
|
.B Usage:
|
|
1655
1664
|
<manifestPath>
|
|
@@ -1664,6 +1673,7 @@ Path to a globals file (JSON or YAML) for pm.globals
|
|
|
1664
1673
|
|
|
1665
1674
|
.TP Examples:
|
|
1666
1675
|
Eg. postman mock run ./postman/mock\-manifest.json
|
|
1676
|
+
postman mock run ./postman/mock\-manifest.yaml
|
|
1667
1677
|
postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
|
|
1668
1678
|
|
|
1669
1679
|
|
|
@@ -2070,7 +2080,7 @@ Quick start:
|
|
|
2070
2080
|
postman search requests "auth"
|
|
2071
2081
|
postman search requests "auth" \-\-filter "method=POST AND visibility=public" \-\-ownership org \-\-limit 10 \-\-output json
|
|
2072
2082
|
|
|
2073
|
-
Element types: requests, collections, workspaces, flows, specs, environments, mocks
|
|
2083
|
+
Element types: requests, collections, workspaces, flows, specs, environments, mocks, documents
|
|
2074
2084
|
|
|
2075
2085
|
Detailed help is split by element type:
|
|
2076
2086
|
postman search requests \-\-help Request filters and examples
|
|
@@ -2080,6 +2090,7 @@ Detailed help is split by element type:
|
|
|
2080
2090
|
postman search specs \-\-help API spec filters and examples
|
|
2081
2091
|
postman search mocks \-\-help Mock filters and examples
|
|
2082
2092
|
postman search environments \-\-help Environment filters and examples
|
|
2093
|
+
postman search documents \-\-help Document filters and examples
|
|
2083
2094
|
|
|
2084
2095
|
Pagination: \-\-limit accepts up to 25 results. Use \-\-cursor from the previous response to paginate.
|
|
2085
2096
|
|
|
@@ -2106,6 +2117,9 @@ Search for mocks by name or keyword.
|
|
|
2106
2117
|
.TP
|
|
2107
2118
|
.B search environments
|
|
2108
2119
|
Search for environments by name or keyword.
|
|
2120
|
+
.TP
|
|
2121
|
+
.B search documents
|
|
2122
|
+
Search for documents by name or keyword.
|
|
2109
2123
|
|
|
2110
2124
|
.SS "search requests"
|
|
2111
2125
|
Search for requests by name or keyword.
|
|
@@ -2478,6 +2492,57 @@ Examples:
|
|
|
2478
2492
|
postman search environments \-\-filter "environmentId=env\-abc123"
|
|
2479
2493
|
|
|
2480
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
|
+
|
|
2481
2546
|
.SS "webhook"
|
|
2482
2547
|
Create and manage Postman webhooks.
|
|
2483
2548
|
|
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
|
}
|