postman-cli 1.47.2 → 1.49.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 +82 -12
- 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-21" "v1.49.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -572,6 +572,9 @@ Prepare local collections and environments for push by validating and regenerati
|
|
|
572
572
|
.TP
|
|
573
573
|
.B workspace push
|
|
574
574
|
Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.
|
|
575
|
+
.TP
|
|
576
|
+
.B workspace lint
|
|
577
|
+
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
575
578
|
|
|
576
579
|
.SS "workspace list"
|
|
577
580
|
List all available Postman Workspaces
|
|
@@ -640,6 +643,26 @@ Show detailed logging
|
|
|
640
643
|
.B \-\-report\-events
|
|
641
644
|
Send workspace push events to Postman
|
|
642
645
|
|
|
646
|
+
.SS "workspace lint"
|
|
647
|
+
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
648
|
+
|
|
649
|
+
.B Usage:
|
|
650
|
+
[options]
|
|
651
|
+
|
|
652
|
+
.B Options:
|
|
653
|
+
.TP
|
|
654
|
+
.B \-f, \-\-fail\-severity <value>
|
|
655
|
+
Exit with failure if diagnostics at this level or above are present. [choices: "error", "warning", "info", "hint"] (default: error)
|
|
656
|
+
.TP
|
|
657
|
+
.B \-o, \-\-output <value>
|
|
658
|
+
Output format: cli (human\-readable), table, or json. (default: cli)
|
|
659
|
+
.TP
|
|
660
|
+
.B \-\-meta
|
|
661
|
+
Only lint the workspace configuration (.postman/resources.yaml); skip per\-entity linting.
|
|
662
|
+
.TP
|
|
663
|
+
.B \-\-workspace\-id <value>
|
|
664
|
+
The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.
|
|
665
|
+
|
|
643
666
|
.SS "performance"
|
|
644
667
|
Manage performance tests on your collections.
|
|
645
668
|
|
|
@@ -683,14 +706,8 @@ Use a Postman Dataset as iteration data (with \-\-dataset\-view\-id)
|
|
|
683
706
|
.B \-\-dataset\-view\-id <id>
|
|
684
707
|
Dataset view to execute for iteration data (requires \-\-dataset\-id)
|
|
685
708
|
.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
709
|
.B \-\-dataset\-distribution <strategy>
|
|
693
|
-
How rows map to VUs: round\-robin (default),
|
|
710
|
+
How rows map to VUs: round\-robin (default), fixed, random
|
|
694
711
|
.TP
|
|
695
712
|
.B \-\-postman\-api\-key <apiKey>
|
|
696
713
|
API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
|
|
@@ -890,14 +907,14 @@ Set flow inputs from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-f
|
|
|
890
907
|
.B \-s, \-\-scenario <name>
|
|
891
908
|
Use a pre\-built scenario as flow inputs (by scenario name). Can be combined with \-\-input and \-\-input\-file to override values.
|
|
892
909
|
.TP
|
|
893
|
-
.B \-\-iteration\-data\-dataset <
|
|
894
|
-
[BETA] Run the flow once per row of a local .dataset.yaml
|
|
910
|
+
.B \-\-iteration\-data\-dataset <pathOrId>
|
|
911
|
+
[BETA] Run the flow once per row of a dataset view. Accepts a local .dataset.yaml path or a cloud dataset id (cloud requires login). Requires \-\-iteration\-data\-view. Dataset columns feed the flow inputs (see \-\-map\-column).
|
|
895
912
|
.TP
|
|
896
913
|
.B \-\-iteration\-data\-view <nameOrId>
|
|
897
914
|
[BETA] Name or id of the view (within \-\-iteration\-data\-dataset) whose rows drive the run.
|
|
898
915
|
.TP
|
|
899
|
-
.B \-\-map <input=column>
|
|
900
|
-
[BETA] Bind a flow input to a dataset column (e.g.
|
|
916
|
+
.B \-m, \-\-map\-column <input=column>
|
|
917
|
+
[BETA] Bind a flow input to a dataset column (e.g. \-m isActive=active). Repeatable. Inputs whose name matches a column bind automatically. (default: )
|
|
901
918
|
.TP
|
|
902
919
|
.B \-e, \-\-environment <path>
|
|
903
920
|
Specify a path to a Postman Environment file (JSON or YAML)
|
|
@@ -905,6 +922,9 @@ Specify a path to a Postman Environment file (JSON or YAML)
|
|
|
905
922
|
.B \-\-working\-dir <path>
|
|
906
923
|
Specify the path to the working directory
|
|
907
924
|
.TP
|
|
925
|
+
.B \-\-no\-insecure\-file\-read
|
|
926
|
+
Prevent reading dataset files situated outside of the working directory (applies to \-\-iteration\-data\-dataset)
|
|
927
|
+
.TP
|
|
908
928
|
.B \-\-verbose
|
|
909
929
|
Show detailed information of flow run and each request (method, URL, assertions)
|
|
910
930
|
.TP
|
|
@@ -942,6 +962,9 @@ Example:
|
|
|
942
962
|
postman flows run ./path/to/flow.json \-\-output json
|
|
943
963
|
postman flows run ./path/to/flow.json \-\-reporters html
|
|
944
964
|
postman flows run ./path/to/flow.json \-\-workspace <workspaceId>
|
|
965
|
+
postman flows run ./path/to/flow.json \-\-iteration\-data\-dataset ./users.dataset.yaml \-\-iteration\-data\-view "active\-users"
|
|
966
|
+
postman flows run ./path/to/flow.json \-\-iteration\-data\-dataset ./users.dataset.yaml \-\-iteration\-data\-view "active\-users" \-\-map\-column isActive=active
|
|
967
|
+
postman flows run ./path/to/flow.json \-\-iteration\-data\-dataset ./users.dataset.yaml \-\-iteration\-data\-view "active\-users" \-i region=us\-east
|
|
945
968
|
|
|
946
969
|
|
|
947
970
|
|
|
@@ -1878,6 +1901,9 @@ Environment override for the selected target (last value wins) (default: )
|
|
|
1878
1901
|
.B \-\-command <cmd>
|
|
1879
1902
|
Command to run first (primary task). Overrides config.
|
|
1880
1903
|
.TP
|
|
1904
|
+
.B \-\-deployed\-version <version>
|
|
1905
|
+
Version identity of the application under test (e.g. a build ID, release tag, or version string). Also read from the APP_DEPLOYED_VERSION environment variable.
|
|
1906
|
+
.TP
|
|
1881
1907
|
.B \-\-network\-log <path>
|
|
1882
1908
|
Directory to scan for captured artifacts, or a direct path to a Playwright JSON report / NDJSON capture file. When a directory is given, recursively discovers `*.json` Playwright reports plus their `trace.zip` attachments, and `network\-capture\-*.ndjson` at the top level. By default, scans Playwright config `outputDir`, test\-results/, then pm\-results/.
|
|
1883
1909
|
.TP
|
|
@@ -1921,6 +1947,7 @@ Use \-\-report\-events to send run results to Postman. Analytics are also sent a
|
|
|
1921
1947
|
Examples:
|
|
1922
1948
|
postman application test \-\-command "npx playwright test"
|
|
1923
1949
|
postman application test \-\-target prod
|
|
1950
|
+
postman application test \-\-command "npx playwright test" \-\-deployed\-version $BUILD_ID
|
|
1924
1951
|
postman application test \-\-target beta \-\-target\-collection api.json \-\-target\-environment staging.json
|
|
1925
1952
|
postman app test \-\-capture\-only \-\-command "npx playwright test"
|
|
1926
1953
|
postman app test \-\-capture\-only \-\-output ./my\-captured\-traffic/
|
|
@@ -2702,6 +2729,9 @@ Show details for a webhook.
|
|
|
2702
2729
|
.B webhook requests
|
|
2703
2730
|
List, inspect, and replay requests received by a webhook.
|
|
2704
2731
|
.TP
|
|
2732
|
+
.B webhook scripts
|
|
2733
|
+
Create or update scripts executed by a webhook.
|
|
2734
|
+
.TP
|
|
2705
2735
|
.B webhook forward
|
|
2706
2736
|
Forward incoming webhook requests to a local port.
|
|
2707
2737
|
|
|
@@ -2894,11 +2924,15 @@ Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.j
|
|
|
2894
2924
|
.TP
|
|
2895
2925
|
.B \-\-api\-key <key>
|
|
2896
2926
|
Postman API key
|
|
2927
|
+
.TP
|
|
2928
|
+
.B \-\-verbose
|
|
2929
|
+
Show script execution logs
|
|
2897
2930
|
|
|
2898
2931
|
.TP Examples:
|
|
2899
2932
|
|
|
2900
2933
|
Examples:
|
|
2901
2934
|
postman webhook requests describe 0123456789abcdefghijklmno 11111111\-1111\-4111\-8111\-111111111111
|
|
2935
|
+
postman webhook requests describe 0123456789abcdefghijklmno 11111111\-1111\-4111\-8111\-111111111111 \-\-verbose
|
|
2902
2936
|
|
|
2903
2937
|
|
|
2904
2938
|
|
|
@@ -2923,6 +2957,42 @@ Examples:
|
|
|
2923
2957
|
|
|
2924
2958
|
|
|
2925
2959
|
|
|
2960
|
+
.SS "webhook scripts"
|
|
2961
|
+
Create or update scripts executed by a webhook.
|
|
2962
|
+
|
|
2963
|
+
.B Usage:
|
|
2964
|
+
[options] [command]
|
|
2965
|
+
|
|
2966
|
+
.B Subcommands:
|
|
2967
|
+
.TP
|
|
2968
|
+
.B webhook scripts set
|
|
2969
|
+
Create or update a webhook script from a JavaScript or TypeScript file.
|
|
2970
|
+
|
|
2971
|
+
.SS "webhook scripts set"
|
|
2972
|
+
Create or update a webhook script from a JavaScript or TypeScript file.
|
|
2973
|
+
|
|
2974
|
+
.B Usage:
|
|
2975
|
+
[options] <webhookId> <scriptPath>
|
|
2976
|
+
|
|
2977
|
+
.B Options:
|
|
2978
|
+
.TP
|
|
2979
|
+
.B \-\-event <event>
|
|
2980
|
+
Script event: onEvent or onResponse
|
|
2981
|
+
.TP
|
|
2982
|
+
.B \-w, \-\-workspace <workspaceId>
|
|
2983
|
+
Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
|
|
2984
|
+
.TP
|
|
2985
|
+
.B \-\-api\-key <key>
|
|
2986
|
+
Postman API key
|
|
2987
|
+
|
|
2988
|
+
.TP Examples:
|
|
2989
|
+
|
|
2990
|
+
Examples:
|
|
2991
|
+
postman webhook scripts set 0123456789abcdefghijklmno ./on\-event.js \-\-event onEvent
|
|
2992
|
+
postman webhook scripts set 0123456789abcdefghijklmno ./on\-response.js \-\-event onResponse
|
|
2993
|
+
|
|
2994
|
+
|
|
2995
|
+
|
|
2926
2996
|
.SS "webhook forward"
|
|
2927
2997
|
Forward incoming webhook requests to a local port.
|
|
2928
2998
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.49.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.49.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.49.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.49.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.49.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.49.0"
|
|
66
66
|
}
|
|
67
67
|
}
|