postman-cli 1.53.0 → 1.54.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 +100 -1
- package/package.json +6 -6
package/man/postman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH POSTMAN 1 "2026-09-
|
|
1
|
+
.TH POSTMAN 1 "2026-09-03" "v1.54.0" "Postman CLI Manual"
|
|
2
2
|
.SH NAME
|
|
3
3
|
postman \- Command\-line companion utility for Postman
|
|
4
4
|
.SH SYNOPSIS
|
|
@@ -52,6 +52,65 @@ Delete the stored Postman API key.
|
|
|
52
52
|
Specify the alias of the API key to fetch your resources using it.
|
|
53
53
|
(This option is discontinued and will be removed in a future release.)
|
|
54
54
|
|
|
55
|
+
.SS "init"
|
|
56
|
+
Set up Postman artifacts and agent instructions in a repository.
|
|
57
|
+
|
|
58
|
+
.B Usage:
|
|
59
|
+
[options] [path]
|
|
60
|
+
|
|
61
|
+
.B Options:
|
|
62
|
+
.TP
|
|
63
|
+
.B \-\-json
|
|
64
|
+
Emit machine\-readable output for agents
|
|
65
|
+
.TP
|
|
66
|
+
.B \-\-dry\-run
|
|
67
|
+
Report what would happen without writing anything
|
|
68
|
+
.TP
|
|
69
|
+
.B \-\-no\-seed
|
|
70
|
+
Do not derive a spec from source
|
|
71
|
+
.TP
|
|
72
|
+
.B \-\-spec <path>
|
|
73
|
+
Which spec is authoritative, when more than one could be
|
|
74
|
+
.TP
|
|
75
|
+
.B \-\-visibility <status>
|
|
76
|
+
Create and bind a workspace non\-interactively (personal or team)
|
|
77
|
+
.TP
|
|
78
|
+
.B \-\-no\-cloud
|
|
79
|
+
Skip the workspace step entirely
|
|
80
|
+
.TP
|
|
81
|
+
.B \-\-report\-events
|
|
82
|
+
Send init analytics to Postman (requires login)
|
|
83
|
+
|
|
84
|
+
.TP Examples:
|
|
85
|
+
|
|
86
|
+
Runs entirely locally: no authentication, no network, safe in CI.
|
|
87
|
+
|
|
88
|
+
Not the same as `postman app init`, which writes a postman.config.cjs
|
|
89
|
+
for test\-traffic capture.
|
|
90
|
+
|
|
91
|
+
Exit codes:
|
|
92
|
+
0 set up, or adopted an existing setup
|
|
93
|
+
1 init could not run: bad usage, or an unexpected error
|
|
94
|
+
2 several specs could be authoritative \- re\-run with \-\-spec <path>
|
|
95
|
+
4 refused: postman/ holds source files, or a binding names a missing file
|
|
96
|
+
5 local setup done, but the workspace \-\-visibility asked for was not made
|
|
97
|
+
|
|
98
|
+
Code 5 needs \-\-visibility: without it no workspace was requested, so nothing
|
|
99
|
+
can fail for not getting one. It does not mean re\-run init \- the local files
|
|
100
|
+
are already written.
|
|
101
|
+
|
|
102
|
+
Under \-\-json, read `exitCode` and `refusal` from the payload rather than
|
|
103
|
+
matching the messages on stderr. `refusal.kind` is one of
|
|
104
|
+
foreign\-postman\-dir, bound\-spec\-missing, spec\-hint\-unmatched.
|
|
105
|
+
|
|
106
|
+
Examples:
|
|
107
|
+
$ postman init
|
|
108
|
+
$ postman init ./services/api \-\-json
|
|
109
|
+
$ postman init \-\-dry\-run
|
|
110
|
+
$ postman init \-\-spec postman/specs/orders.yaml
|
|
111
|
+
$ postman init \-\-visibility personal
|
|
112
|
+
|
|
113
|
+
|
|
55
114
|
.SS "collection"
|
|
56
115
|
Run and test your Postman collections directly from the command line.
|
|
57
116
|
|
|
@@ -590,6 +649,9 @@ Push local workspace entities (collections, environments, specifications, and mo
|
|
|
590
649
|
.B workspace lint
|
|
591
650
|
Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use \-\-meta to lint only the configuration.
|
|
592
651
|
.TP
|
|
652
|
+
.B workspace create
|
|
653
|
+
Create a Postman workspace and bind it to this git repository.
|
|
654
|
+
.TP
|
|
593
655
|
.B workspace pull
|
|
594
656
|
Pull workspace entities from a Postman workspace into the local git\-native folder.
|
|
595
657
|
.TP
|
|
@@ -689,6 +751,43 @@ The workspace ID to use for fetching governance rulesets. Defaults to the id in
|
|
|
689
751
|
.B \-\-fix
|
|
690
752
|
Apply safe autofixes to repairable workspace lint issues.
|
|
691
753
|
|
|
754
|
+
.SS "workspace create"
|
|
755
|
+
Create a Postman workspace and bind it to this git repository.
|
|
756
|
+
|
|
757
|
+
.B Usage:
|
|
758
|
+
[options]
|
|
759
|
+
|
|
760
|
+
.B Options:
|
|
761
|
+
.TP
|
|
762
|
+
.B \-\-visibility <status>
|
|
763
|
+
Required. Workspace visibility, e.g. personal or team
|
|
764
|
+
.TP
|
|
765
|
+
.B \-\-name <name>
|
|
766
|
+
Workspace name (defaults to owner/repo from the git remote)
|
|
767
|
+
.TP
|
|
768
|
+
.B \-\-summary <text>
|
|
769
|
+
Optional workspace summary
|
|
770
|
+
.TP
|
|
771
|
+
.B \-\-path <dir>
|
|
772
|
+
Directory to bind (defaults to the current directory)
|
|
773
|
+
.TP
|
|
774
|
+
.B \-\-no\-connect
|
|
775
|
+
Create the workspace without binding it to the repository
|
|
776
|
+
.TP
|
|
777
|
+
.B \-\-force
|
|
778
|
+
Create even when a workspace is already recorded for this repo
|
|
779
|
+
|
|
780
|
+
.TP Examples:
|
|
781
|
+
|
|
782
|
+
Requires a login (`postman login`) or POSTMAN_API_KEY.
|
|
783
|
+
Refuses to run on CI: create once locally and commit the binding.
|
|
784
|
+
|
|
785
|
+
Examples:
|
|
786
|
+
$ postman workspace create \-\-visibility personal
|
|
787
|
+
$ postman workspace create \-\-visibility team \-\-name "acme/orders"
|
|
788
|
+
$ postman workspace create \-\-visibility personal \-\-no\-connect
|
|
789
|
+
|
|
790
|
+
|
|
692
791
|
.SS "workspace pull"
|
|
693
792
|
Pull workspace entities from a Postman workspace into the local git\-native folder.
|
|
694
793
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "postman-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.54.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.54.0",
|
|
62
|
+
"@postman/pm-bin-macos-x64": "1.54.0",
|
|
63
|
+
"@postman/pm-bin-linux-x64": "1.54.0",
|
|
64
|
+
"@postman/pm-bin-linux-arm64": "1.54.0",
|
|
65
|
+
"@postman/pm-bin-windows-x64": "1.54.0"
|
|
66
66
|
}
|
|
67
67
|
}
|