postman-cli 1.48.0 → 1.50.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.
Files changed (2) hide show
  1. package/man/postman.1 +274 -24
  2. package/package.json +6 -6
package/man/postman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH POSTMAN 1 "2026-08-19" "v1.48.0" "Postman CLI Manual"
1
+ .TH POSTMAN 1 "2026-08-27" "v1.50.0" "Postman CLI Manual"
2
2
  .SH NAME
3
3
  postman \- Command\-line companion utility for Postman
4
4
  .SH SYNOPSIS
@@ -575,6 +575,12 @@ Push local workspace entities (collections, environments, specifications, and mo
575
575
  .TP
576
576
  .B workspace lint
577
577
  Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
578
+ .TP
579
+ .B workspace pull
580
+ Pull workspace entities from a Postman workspace into the local git\-native folder.
581
+ .TP
582
+ .B workspace connect-git
583
+ Connect a Postman workspace to a local git repository.
578
584
 
579
585
  .SS "workspace list"
580
586
  List all available Postman Workspaces
@@ -662,6 +668,62 @@ Only lint the workspace configuration (.postman/resources.yaml); skip per\-entit
662
668
  .TP
663
669
  .B \-\-workspace\-id <value>
664
670
  The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.
671
+ .TP
672
+ .B \-\-fix
673
+ Apply safe autofixes to repairable workspace lint issues.
674
+
675
+ .SS "workspace pull"
676
+ Pull workspace entities from a Postman workspace into the local git\-native folder.
677
+
678
+ .B Usage:
679
+ [options] [workspaceId]
680
+
681
+ .B Options:
682
+ .TP
683
+ .B \-y, \-\-yes
684
+ Skip all confirmation prompts
685
+ .TP
686
+ .B \-\-source\-workspace <workspaceId>
687
+ Pull from a different source workspace.
688
+ .TP
689
+ .B \-\-verbose
690
+ Show detailed logging
691
+
692
+ .TP Examples:
693
+
694
+ Examples:
695
+ postman workspace pull
696
+ Pull from the workspace connected to the current directory's git remote
697
+ postman workspace pull <workspaceId>
698
+ Connect the workspace to the current directory's git remote and pull
699
+ from the workspace.
700
+ postman workspace pull \-\-source\-workspace <workspaceId>
701
+ Pull from another workspace
702
+
703
+
704
+
705
+ .SS "workspace connect\-git"
706
+ Connect a Postman workspace to a local git repository.
707
+
708
+ .B Usage:
709
+ [options] <workspaceId> [path]
710
+
711
+ .B Options:
712
+ .TP
713
+ .B \-\-verbose
714
+ Show detailed logging
715
+
716
+ .TP Examples:
717
+
718
+ Examples:
719
+ postman workspace connect\-git <workspaceId>
720
+ Register the current directory's git remote with the workspace and write the
721
+ local .postman/resources.yaml claim. Prerequisite for `pull` and `push`.
722
+ postman workspace connect\-git <workspaceId> ./services/api
723
+ Connect a specific folder. A folder below the repo root binds to its subpath,
724
+ so one repository can back several workspaces.
725
+
726
+
665
727
 
666
728
  .SS "performance"
667
729
  Manage performance tests on your collections.
@@ -706,20 +768,14 @@ Use a Postman Dataset as iteration data (with \-\-dataset\-view\-id)
706
768
  .B \-\-dataset\-view\-id <id>
707
769
  Dataset view to execute for iteration data (requires \-\-dataset\-id)
708
770
  .TP
709
- .B \-\-dataset\-offset <offset>
710
- Row offset into the view result (optional range)
711
- .TP
712
- .B \-\-dataset\-limit <limit>
713
- Max rows to fetch from the view (optional range)
714
- .TP
715
771
  .B \-\-dataset\-distribution <strategy>
716
- How rows map to VUs: round\-robin (default), pinned, random
772
+ How rows map to VUs: round\-robin (default), fixed, random
717
773
  .TP
718
774
  .B \-\-postman\-api\-key <apiKey>
719
775
  API Key used to load the resources from the Postman API (Only supported in the US region, use 'postman login \-\-region' to authenticate instead)
720
776
  .TP
721
- .B \-\-cloud
722
- Execute the performance test on Postman Cloud (beta) (default: false)
777
+ .B \-\-runner <runner>
778
+ Runner to execute the performance test on (local or postman\-cloud) (default: )
723
779
  .TP
724
780
  .B \-\-pass\-if <condition>
725
781
  Pass condition in format: function(metric, value).
@@ -913,14 +969,14 @@ Set flow inputs from JSON files (e.g. \-\-input\-file ./inputs.json \-\-input\-f
913
969
  .B \-s, \-\-scenario <name>
914
970
  Use a pre\-built scenario as flow inputs (by scenario name). Can be combined with \-\-input and \-\-input\-file to override values.
915
971
  .TP
916
- .B \-\-iteration\-data\-dataset <path>
917
- [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).
972
+ .B \-\-iteration\-data\-dataset <pathOrId>
973
+ [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).
918
974
  .TP
919
975
  .B \-\-iteration\-data\-view <nameOrId>
920
976
  [BETA] Name or id of the view (within \-\-iteration\-data\-dataset) whose rows drive the run.
921
977
  .TP
922
- .B \-\-map <input=column>
923
- [BETA] Bind a flow input to a dataset column (e.g. \-\-map isActive=active). Repeatable. Inputs whose name matches a column bind automatically. (default: )
978
+ .B \-m, \-\-map\-column <input=column>
979
+ [BETA] Bind a flow input to a dataset column (e.g. \-m isActive=active). Repeatable. Inputs whose name matches a column bind automatically. (default: )
924
980
  .TP
925
981
  .B \-e, \-\-environment <path>
926
982
  Specify a path to a Postman Environment file (JSON or YAML)
@@ -928,6 +984,9 @@ Specify a path to a Postman Environment file (JSON or YAML)
928
984
  .B \-\-working\-dir <path>
929
985
  Specify the path to the working directory
930
986
  .TP
987
+ .B \-\-no\-insecure\-file\-read
988
+ Prevent reading dataset files situated outside of the working directory (applies to \-\-iteration\-data\-dataset)
989
+ .TP
931
990
  .B \-\-verbose
932
991
  Show detailed information of flow run and each request (method, URL, assertions)
933
992
  .TP
@@ -965,6 +1024,9 @@ Example:
965
1024
  postman flows run ./path/to/flow.json \-\-output json
966
1025
  postman flows run ./path/to/flow.json \-\-reporters html
967
1026
  postman flows run ./path/to/flow.json \-\-workspace <workspaceId>
1027
+ postman flows run ./path/to/flow.json \-\-iteration\-data\-dataset ./users.dataset.yaml \-\-iteration\-data\-view "active\-users"
1028
+ postman flows run ./path/to/flow.json \-\-iteration\-data\-dataset ./users.dataset.yaml \-\-iteration\-data\-view "active\-users" \-\-map\-column isActive=active
1029
+ postman flows run ./path/to/flow.json \-\-iteration\-data\-dataset ./users.dataset.yaml \-\-iteration\-data\-view "active\-users" \-i region=us\-east
968
1030
 
969
1031
 
970
1032
 
@@ -1766,24 +1828,33 @@ Run and manage local Postman mock servers.
1766
1828
  .B Subcommands:
1767
1829
  .TP
1768
1830
  .B mock generate
1769
- 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.
1831
+ 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. Omit the source to scaffold a sample mock with a GET /health endpoint.
1770
1832
  .TP
1771
1833
  .B mock run
1772
- Start a local mock server given a manifest file (JSON or YAML).
1834
+ Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
1835
+ .TP
1836
+ .B mock get
1837
+ Show a local mock's details and run status.
1838
+ .TP
1839
+ .B mock list
1840
+ List local mocks found under a directory.
1841
+ .TP
1842
+ .B mock delete
1843
+ Permanently remove a local mock artifact.
1773
1844
 
1774
1845
  .SS "mock generate"
1775
- 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.
1846
+ 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. Omit the source to scaffold a sample mock with a GET /health endpoint.
1776
1847
 
1777
1848
  .B Usage:
1778
- <sourcePath> [options]
1849
+ [sourcePath] [options]
1779
1850
 
1780
1851
  .B Options:
1781
1852
  .TP
1782
1853
  .B \-o, \-\-output <dir>
1783
1854
  Output directory for the mock (default: postman/mocks/<slug>)
1784
1855
  .TP
1785
- .B \-\-name <name>
1786
- Display name for the generated mock
1856
+ .B \-n, \-\-name <name>
1857
+ Display name for the generated mock. Optional with a source (derived from it); required when generating without a source.
1787
1858
  .TP
1788
1859
  .B \-\-port <port>
1789
1860
  Port the mock server should listen on (default: 4500)
@@ -1800,16 +1871,17 @@ Always exit with code 0, even on failure
1800
1871
  .TP Examples:
1801
1872
 
1802
1873
  Eg. postman mock generate ./my\-collection.json
1803
- postman mock generate "./postman/collections/My Collection" \-\-port 4010
1874
+ postman mock generate \-\-name "My Mock" # sample mock with a GET /health endpoint
1875
+ postman mock generate \-\-name "My Mock" \-\-port 4010 # sample mock, custom port
1804
1876
  postman mock generate ./openapi.yaml \-\-output ./postman/mocks/api \-\-port 4010
1805
1877
  postman mock generate ./my\-collection.json \-\-update ./postman/mocks/orders
1806
1878
 
1807
1879
 
1808
1880
  .SS "mock run"
1809
- Start a local mock server given a manifest file (JSON or YAML).
1881
+ Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.
1810
1882
 
1811
1883
  .B Usage:
1812
- <manifestPath>
1884
+ <pathOrDir>
1813
1885
 
1814
1886
  .B Options:
1815
1887
  .TP
@@ -1823,13 +1895,67 @@ Path to a globals file (JSON or YAML) for pm.globals
1823
1895
  Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).
1824
1896
 
1825
1897
  .TP Examples:
1826
- Eg. postman mock run ./postman/mock\-manifest.json
1898
+ Eg. postman mock run ./postman/mocks/orders # a mock directory
1899
+ postman mock run ./postman/mock\-manifest.json
1827
1900
  postman mock run ./postman/mock\-manifest.yaml
1828
1901
  postman mock run ./manifest.json \-\-environment ./postman/environments/dev.yaml
1829
1902
  postman mock run ./manifest.yaml \-\-port auto # OS\-assigned ephemeral port
1830
1903
  postman mock run ./manifest.yaml \-\-port 4600 # exact port, errors if busy
1831
1904
 
1832
1905
 
1906
+ .SS "mock get"
1907
+ Show a local mock's details and run status.
1908
+
1909
+ .B Usage:
1910
+ <pathOrDir> [options]
1911
+
1912
+ .B Options:
1913
+ .TP
1914
+ .B \-\-json
1915
+ Output the mock details as JSON instead of a table
1916
+
1917
+ .TP Examples:
1918
+
1919
+ Eg. postman mock get ./postman/mocks/orders
1920
+ postman mock get ./postman/mocks/orders \-\-json
1921
+
1922
+
1923
+ .SS "mock list"
1924
+ List local mocks found under a directory.
1925
+
1926
+ .B Usage:
1927
+ [pathOrDir] [options]
1928
+
1929
+ .B Options:
1930
+ .TP
1931
+ .B \-\-json
1932
+ Output the mock list as JSON instead of a table
1933
+
1934
+ .TP Examples:
1935
+
1936
+ Eg. postman mock list
1937
+ postman mock list ./postman/mocks
1938
+ postman mock list ./postman/mocks \-\-json
1939
+
1940
+
1941
+ .SS "mock delete"
1942
+ Permanently remove a local mock artifact.
1943
+
1944
+ .B Usage:
1945
+ <pathOrDir> [options]
1946
+
1947
+ .B Options:
1948
+ .TP
1949
+ .B \-y, \-\-yes
1950
+ Skip the confirmation prompt
1951
+
1952
+ .TP Examples:
1953
+
1954
+ Eg. postman mock delete ./postman/mocks/orders
1955
+ postman mock delete ./postman/mocks/orders \-\-yes
1956
+ postman mock delete ./postman/mocks/orders/config.yaml \-\-yes
1957
+
1958
+
1833
1959
  .SS "application"
1834
1960
  Application\-level commands: initialise config and run tests.
1835
1961
 
@@ -1839,12 +1965,17 @@ Application\-level commands: initialise config and run tests.
1839
1965
  .B Subcommands:
1840
1966
  .TP
1841
1967
  .B application init
1968
+ [DEPRECATED] Use `postman app test` instead.
1842
1969
  Initialise a postman.config.cjs file with target collections, environment, and test command.
1843
1970
  .TP
1844
1971
  .B application test
1845
1972
  Run a command first (primary task), then match captured traffic against Postman collections and run assertions.
1973
+ .TP
1974
+ .B application setup-capture
1975
+ Install postman\-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().
1846
1976
 
1847
1977
  .SS "application init"
1978
+ [DEPRECATED] Use `postman app test` instead.
1848
1979
  Initialise a postman.config.cjs file with target collections, environment, and test command.
1849
1980
 
1850
1981
  .B Usage:
@@ -1953,6 +2084,34 @@ Examples:
1953
2084
  postman app test \-\-capture\-only \-\-output ./my\-captured\-traffic/
1954
2085
 
1955
2086
 
2087
+ .SS "application setup\-capture"
2088
+ Install postman\-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().
2089
+
2090
+ .B Usage:
2091
+ [options]
2092
+
2093
+ .B Options:
2094
+ .TP
2095
+ .B \-\-config <path>
2096
+ Path to playwright.config.* to patch (default: auto\-detect)
2097
+
2098
+ .TP Examples:
2099
+
2100
+ Detects the package manager (npm / yarn / pnpm / bun) from lockfiles,
2101
+ installs postman\-playwright as a dev dependency if needed, then
2102
+ wraps your Playwright config's default export with withPostman().
2103
+
2104
+ If auto\-patching is not possible (unusual config patterns), the
2105
+ command prints manual setup steps instead.
2106
+
2107
+ Examples:
2108
+ postman app setup\-capture
2109
+ postman app setup\-capture \-\-config apps/api/playwright.config.ts
2110
+
2111
+ After setup, run your tests normally:
2112
+ postman app test
2113
+
2114
+
1956
2115
  .SS "simulate"
1957
2116
  Start mock servers with simulated failure scenarios.
1958
2117
 
@@ -2729,6 +2888,9 @@ Show details for a webhook.
2729
2888
  .B webhook requests
2730
2889
  List, inspect, and replay requests received by a webhook.
2731
2890
  .TP
2891
+ .B webhook scripts
2892
+ Create or update scripts executed by a webhook.
2893
+ .TP
2732
2894
  .B webhook forward
2733
2895
  Forward incoming webhook requests to a local port.
2734
2896
 
@@ -2921,11 +3083,15 @@ Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.j
2921
3083
  .TP
2922
3084
  .B \-\-api\-key <key>
2923
3085
  Postman API key
3086
+ .TP
3087
+ .B \-\-verbose
3088
+ Show script execution logs
2924
3089
 
2925
3090
  .TP Examples:
2926
3091
 
2927
3092
  Examples:
2928
3093
  postman webhook requests describe 0123456789abcdefghijklmno 11111111\-1111\-4111\-8111\-111111111111
3094
+ postman webhook requests describe 0123456789abcdefghijklmno 11111111\-1111\-4111\-8111\-111111111111 \-\-verbose
2929
3095
 
2930
3096
 
2931
3097
 
@@ -2950,6 +3116,42 @@ Examples:
2950
3116
 
2951
3117
 
2952
3118
 
3119
+ .SS "webhook scripts"
3120
+ Create or update scripts executed by a webhook.
3121
+
3122
+ .B Usage:
3123
+ [options] [command]
3124
+
3125
+ .B Subcommands:
3126
+ .TP
3127
+ .B webhook scripts set
3128
+ Create or update a webhook script from a JavaScript or TypeScript file.
3129
+
3130
+ .SS "webhook scripts set"
3131
+ Create or update a webhook script from a JavaScript or TypeScript file.
3132
+
3133
+ .B Usage:
3134
+ [options] <webhookId> <scriptPath>
3135
+
3136
+ .B Options:
3137
+ .TP
3138
+ .B \-\-event <event>
3139
+ Script event: onEvent or onResponse
3140
+ .TP
3141
+ .B \-w, \-\-workspace <workspaceId>
3142
+ Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)
3143
+ .TP
3144
+ .B \-\-api\-key <key>
3145
+ Postman API key
3146
+
3147
+ .TP Examples:
3148
+
3149
+ Examples:
3150
+ postman webhook scripts set 0123456789abcdefghijklmno ./on\-event.js \-\-event onEvent
3151
+ postman webhook scripts set 0123456789abcdefghijklmno ./on\-response.js \-\-event onResponse
3152
+
3153
+
3154
+
2953
3155
  .SS "webhook forward"
2954
3156
  Forward incoming webhook requests to a local port.
2955
3157
 
@@ -3242,6 +3444,30 @@ DB database name
3242
3444
  .B \-\-table <table>
3243
3445
  DB table name (optional)
3244
3446
  .TP
3447
+ .B \-\-ssh\-host <host>
3448
+ SSH bastion host
3449
+ .TP
3450
+ .B \-\-ssh\-port <port>
3451
+ SSH bastion port
3452
+ .TP
3453
+ .B \-\-ssh\-user <user>
3454
+ SSH bastion user
3455
+ .TP
3456
+ .B \-\-ssh\-private\-key <filepath>
3457
+ Path to the SSH private key. WARNING: the path is visible in `ps` output and shell history; key contents are read locally at execution time and are not stored in the dataset config.
3458
+ .TP
3459
+ .B \-\-ssh\-host\-key <publicKey>
3460
+ SSH bastion public host key
3461
+ .TP
3462
+ .B \-\-ssh\-host\-key\-vault\-id <id>
3463
+ Shared Vault ID containing the SSH public host key
3464
+ .TP
3465
+ .B \-\-ssh\-host\-key\-secret\-id <id>
3466
+ Shared Vault secret ID containing the SSH public host key
3467
+ .TP
3468
+ .B \-\-ssh\-insecure\-skip\-host\-key\-verification
3469
+ WARNING: disable SSH host\-key verification; use only for trusted local testing
3470
+ .TP
3245
3471
  .B \-\-slug <slug>
3246
3472
  Optional slug for the source
3247
3473
  .TP
@@ -3318,6 +3544,30 @@ Update DB database name
3318
3544
  .B \-\-table <table>
3319
3545
  Update DB table name
3320
3546
  .TP
3547
+ .B \-\-ssh\-host <host>
3548
+ Update SSH bastion host
3549
+ .TP
3550
+ .B \-\-ssh\-port <port>
3551
+ Update SSH bastion port
3552
+ .TP
3553
+ .B \-\-ssh\-user <user>
3554
+ Update SSH bastion user
3555
+ .TP
3556
+ .B \-\-ssh\-private\-key <filepath>
3557
+ Update the SSH private\-key file path. WARNING: the path is visible in `ps` output and shell history; key contents are read locally and are not stored in the dataset config.
3558
+ .TP
3559
+ .B \-\-ssh\-host\-key <publicKey>
3560
+ Update the SSH bastion public host key
3561
+ .TP
3562
+ .B \-\-ssh\-host\-key\-vault\-id <id>
3563
+ Update the Shared Vault ID containing the SSH public host key
3564
+ .TP
3565
+ .B \-\-ssh\-host\-key\-secret\-id <id>
3566
+ Update the Shared Vault secret ID containing the SSH public host key
3567
+ .TP
3568
+ .B \-\-ssh\-insecure\-skip\-host\-key\-verification
3569
+ WARNING: disable SSH host\-key verification; use only for trusted local testing
3570
+ .TP
3321
3571
  .B \-\-slug <slug>
3322
3572
  Update slug
3323
3573
  .TP
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli",
3
- "version": "1.48.0",
3
+ "version": "1.50.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.48.0",
62
- "@postman/pm-bin-macos-x64": "1.48.0",
63
- "@postman/pm-bin-linux-x64": "1.48.0",
64
- "@postman/pm-bin-linux-arm64": "1.48.0",
65
- "@postman/pm-bin-windows-x64": "1.48.0"
61
+ "@postman/pm-bin-macos-arm64": "1.50.0",
62
+ "@postman/pm-bin-macos-x64": "1.50.0",
63
+ "@postman/pm-bin-linux-x64": "1.50.0",
64
+ "@postman/pm-bin-linux-arm64": "1.50.0",
65
+ "@postman/pm-bin-windows-x64": "1.50.0"
66
66
  }
67
67
  }