postman-cli 1.37.0 → 1.38.1
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/bin/postman.js +0 -0
- package/man/postman.1 +235 -7
- package/package.json +6 -6
package/bin/postman.js
CHANGED
|
File without changes
|
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-05-
|
|
1
|
+
.TH POSTMAN 1 "2026-05-29" "v1.38.1" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -512,9 +512,6 @@ Pass condition in format: function(metric, value).
|
|
|
512
512
|
Functions: less_than, greater_than, less_than_eq, greater_than_eq.
|
|
513
513
|
Metrics: avg, p90, p95, p99, error_rate, rps.
|
|
514
514
|
Example: less_than(p95, 500) or less_than(error_rate, 5)
|
|
515
|
-
.TP
|
|
516
|
-
.B \-\-persist\-metrics
|
|
517
|
-
Persist detailed run results to cloud for analysis (default: false)
|
|
518
515
|
|
|
519
516
|
.TP Examples:
|
|
520
517
|
|
|
@@ -1623,14 +1620,14 @@ Environment override for the selected target (last value wins) (default: )
|
|
|
1623
1620
|
.B \-\-command <cmd>
|
|
1624
1621
|
Command to run first (primary task). Overrides config.
|
|
1625
1622
|
.TP
|
|
1626
|
-
.B \-\-network\-log <
|
|
1627
|
-
Directory to scan for captured artifacts.
|
|
1623
|
+
.B \-\-network\-log <path>
|
|
1624
|
+
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/.
|
|
1628
1625
|
.TP
|
|
1629
1626
|
.B \-\-capture\-only
|
|
1630
1627
|
Skip collection matching and tests; capture traffic and save a V3 collection organised by host
|
|
1631
1628
|
.TP
|
|
1632
1629
|
.B \-\-analyse\-only
|
|
1633
|
-
Do not run the primary command; analyse existing network\-capture NDJSON under the network log
|
|
1630
|
+
Do not run the primary command; analyse existing network\-capture NDJSON under the network log path
|
|
1634
1631
|
.TP
|
|
1635
1632
|
.B \-\-run\-only
|
|
1636
1633
|
Run only the primary command; skip analysis (use \-\-analyse\-only on merged captures later).
|
|
@@ -1688,6 +1685,237 @@ Start mocks with fault\-injection scenarios defined in a .sim.yaml file
|
|
|
1688
1685
|
.B Usage:
|
|
1689
1686
|
[options] <filepath>
|
|
1690
1687
|
|
|
1688
|
+
.SS "context"
|
|
1689
|
+
[Beta] Get API context for AI coding agents directly from the command line.
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
.B Usage:
|
|
1693
|
+
[options] [command]
|
|
1694
|
+
|
|
1695
|
+
.B Subcommands:
|
|
1696
|
+
.TP
|
|
1697
|
+
.B context instructions
|
|
1698
|
+
Get agent instructions for using Postman Context with AI coding agents.
|
|
1699
|
+
|
|
1700
|
+
Topics:
|
|
1701
|
+
(none) — Overview of capabilities, workflow, and API reference
|
|
1702
|
+
discovery — Agent instructions for searching for and exploring APIs
|
|
1703
|
+
code\-generation — Agent instructions for generating and maintaining client code
|
|
1704
|
+
maintenance — Agent instructions for maintaining and updating client code
|
|
1705
|
+
|
|
1706
|
+
.TP
|
|
1707
|
+
.B context collection
|
|
1708
|
+
Collection commands
|
|
1709
|
+
.TP
|
|
1710
|
+
.B context request
|
|
1711
|
+
Request commands
|
|
1712
|
+
.TP
|
|
1713
|
+
.B context folder
|
|
1714
|
+
Folder commands
|
|
1715
|
+
.TP
|
|
1716
|
+
.B context response
|
|
1717
|
+
Response commands
|
|
1718
|
+
.TP
|
|
1719
|
+
.B context workspace
|
|
1720
|
+
Workspace commands
|
|
1721
|
+
.TP
|
|
1722
|
+
.B context environment
|
|
1723
|
+
Environment commands
|
|
1724
|
+
|
|
1725
|
+
.SS "context instructions"
|
|
1726
|
+
Get agent instructions for using Postman Context with AI coding agents.
|
|
1727
|
+
|
|
1728
|
+
Topics:
|
|
1729
|
+
(none) — Overview of capabilities, workflow, and API reference
|
|
1730
|
+
discovery — Agent instructions for searching for and exploring APIs
|
|
1731
|
+
code\-generation — Agent instructions for generating and maintaining client code
|
|
1732
|
+
maintenance — Agent instructions for maintaining and updating client code
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
.B Usage:
|
|
1736
|
+
[options] [topic]
|
|
1737
|
+
|
|
1738
|
+
.SS "context collection"
|
|
1739
|
+
Collection commands
|
|
1740
|
+
|
|
1741
|
+
.B Usage:
|
|
1742
|
+
[options] [command]
|
|
1743
|
+
|
|
1744
|
+
.B Subcommands:
|
|
1745
|
+
.TP
|
|
1746
|
+
.B context collection get
|
|
1747
|
+
Get a collection's metadata and a map of its folders and requests.
|
|
1748
|
+
|
|
1749
|
+
Returns collection info (name, description, variables, auth) plus a
|
|
1750
|
+
recursive tree of folders and requests.
|
|
1751
|
+
|
|
1752
|
+
.SS "context collection get"
|
|
1753
|
+
Get a collection's metadata and a map of its folders and requests.
|
|
1754
|
+
|
|
1755
|
+
Returns collection info (name, description, variables, auth) plus a
|
|
1756
|
+
recursive tree of folders and requests.
|
|
1757
|
+
|
|
1758
|
+
.B Usage:
|
|
1759
|
+
[options]
|
|
1760
|
+
|
|
1761
|
+
.B Options:
|
|
1762
|
+
.TP
|
|
1763
|
+
.B \-c, \-\-collection\-id <id>
|
|
1764
|
+
Collection ID
|
|
1765
|
+
|
|
1766
|
+
.SS "context request"
|
|
1767
|
+
Request commands
|
|
1768
|
+
|
|
1769
|
+
.B Usage:
|
|
1770
|
+
[options] [command]
|
|
1771
|
+
|
|
1772
|
+
.B Subcommands:
|
|
1773
|
+
.TP
|
|
1774
|
+
.B context request get
|
|
1775
|
+
Get a request from a collection
|
|
1776
|
+
.TP
|
|
1777
|
+
.B context request context
|
|
1778
|
+
Fetch all context about a request and return it as a Markdown document.
|
|
1779
|
+
|
|
1780
|
+
Returns: collection metadata, request details (method, URL, headers, body,
|
|
1781
|
+
auth, docs), parent folder documentation, response examples, and
|
|
1782
|
+
environment variables.
|
|
1783
|
+
|
|
1784
|
+
Examples:
|
|
1785
|
+
postman context request context \-c <collection\-id> \-r <request\-id>
|
|
1786
|
+
|
|
1787
|
+
.SS "context request get"
|
|
1788
|
+
Get a request from a collection
|
|
1789
|
+
|
|
1790
|
+
.B Usage:
|
|
1791
|
+
[options]
|
|
1792
|
+
|
|
1793
|
+
.B Options:
|
|
1794
|
+
.TP
|
|
1795
|
+
.B \-r, \-\-request\-id <id>
|
|
1796
|
+
Request ID
|
|
1797
|
+
.TP
|
|
1798
|
+
.B \-c, \-\-collection\-id <id>
|
|
1799
|
+
Collection ID
|
|
1800
|
+
|
|
1801
|
+
.SS "context request context"
|
|
1802
|
+
Fetch all context about a request and return it as a Markdown document.
|
|
1803
|
+
|
|
1804
|
+
Returns: collection metadata, request details (method, URL, headers, body,
|
|
1805
|
+
auth, docs), parent folder documentation, response examples, and
|
|
1806
|
+
environment variables.
|
|
1807
|
+
|
|
1808
|
+
Examples:
|
|
1809
|
+
postman context request context \-c <collection\-id> \-r <request\-id>
|
|
1810
|
+
|
|
1811
|
+
.B Usage:
|
|
1812
|
+
[options]
|
|
1813
|
+
|
|
1814
|
+
.B Options:
|
|
1815
|
+
.TP
|
|
1816
|
+
.B \-c, \-\-collection\-id <id>
|
|
1817
|
+
Collection ID
|
|
1818
|
+
.TP
|
|
1819
|
+
.B \-r, \-\-request\-id <id>
|
|
1820
|
+
Request ID
|
|
1821
|
+
|
|
1822
|
+
.SS "context folder"
|
|
1823
|
+
Folder commands
|
|
1824
|
+
|
|
1825
|
+
.B Usage:
|
|
1826
|
+
[options] [command]
|
|
1827
|
+
|
|
1828
|
+
.B Subcommands:
|
|
1829
|
+
.TP
|
|
1830
|
+
.B context folder get
|
|
1831
|
+
Get a folder from a collection
|
|
1832
|
+
|
|
1833
|
+
.SS "context folder get"
|
|
1834
|
+
Get a folder from a collection
|
|
1835
|
+
|
|
1836
|
+
.B Usage:
|
|
1837
|
+
[options]
|
|
1838
|
+
|
|
1839
|
+
.B Options:
|
|
1840
|
+
.TP
|
|
1841
|
+
.B \-\-folder\-id <id>
|
|
1842
|
+
Folder ID
|
|
1843
|
+
.TP
|
|
1844
|
+
.B \-c, \-\-collection\-id <id>
|
|
1845
|
+
Collection ID
|
|
1846
|
+
|
|
1847
|
+
.SS "context response"
|
|
1848
|
+
Response commands
|
|
1849
|
+
|
|
1850
|
+
.B Usage:
|
|
1851
|
+
[options] [command]
|
|
1852
|
+
|
|
1853
|
+
.B Subcommands:
|
|
1854
|
+
.TP
|
|
1855
|
+
.B context response get
|
|
1856
|
+
Get a saved response example from a collection
|
|
1857
|
+
|
|
1858
|
+
.SS "context response get"
|
|
1859
|
+
Get a saved response example from a collection
|
|
1860
|
+
|
|
1861
|
+
.B Usage:
|
|
1862
|
+
[options]
|
|
1863
|
+
|
|
1864
|
+
.B Options:
|
|
1865
|
+
.TP
|
|
1866
|
+
.B \-\-id <id>
|
|
1867
|
+
Response ID
|
|
1868
|
+
.TP
|
|
1869
|
+
.B \-c, \-\-collection\-id <id>
|
|
1870
|
+
Collection ID
|
|
1871
|
+
.TP
|
|
1872
|
+
.B \-r, \-\-request\-id <id>
|
|
1873
|
+
Request ID
|
|
1874
|
+
|
|
1875
|
+
.SS "context workspace"
|
|
1876
|
+
Workspace commands
|
|
1877
|
+
|
|
1878
|
+
.B Usage:
|
|
1879
|
+
[options] [command]
|
|
1880
|
+
|
|
1881
|
+
.B Subcommands:
|
|
1882
|
+
.TP
|
|
1883
|
+
.B context workspace get
|
|
1884
|
+
Get a workspace by ID
|
|
1885
|
+
|
|
1886
|
+
.SS "context workspace get"
|
|
1887
|
+
Get a workspace by ID
|
|
1888
|
+
|
|
1889
|
+
.B Usage:
|
|
1890
|
+
[options]
|
|
1891
|
+
|
|
1892
|
+
.B Options:
|
|
1893
|
+
.TP
|
|
1894
|
+
.B \-w, \-\-workspace\-id <id>
|
|
1895
|
+
Workspace ID
|
|
1896
|
+
|
|
1897
|
+
.SS "context environment"
|
|
1898
|
+
Environment commands
|
|
1899
|
+
|
|
1900
|
+
.B Usage:
|
|
1901
|
+
[options] [command]
|
|
1902
|
+
|
|
1903
|
+
.B Subcommands:
|
|
1904
|
+
.TP
|
|
1905
|
+
.B context environment get
|
|
1906
|
+
Get a single environment by ID
|
|
1907
|
+
|
|
1908
|
+
.SS "context environment get"
|
|
1909
|
+
Get a single environment by ID
|
|
1910
|
+
|
|
1911
|
+
.B Usage:
|
|
1912
|
+
[options]
|
|
1913
|
+
|
|
1914
|
+
.B Options:
|
|
1915
|
+
.TP
|
|
1916
|
+
.B \-e, \-\-environment\-id <id>
|
|
1917
|
+
Environment ID
|
|
1918
|
+
|
|
1691
1919
|
.SS "search"
|
|
1692
1920
|
Search for Postman element types (requests, collections, workspaces, and more).
|
|
1693
1921
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.38.1",
|
|
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.38.1",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.38.1",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.38.1",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.38.1",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.38.1"
|
|
66
66
|
}
|
|
67
67
|
}
|