postman-cli-completion 1.60.0 → 1.63.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/completions/bash/postman.bash +163 -35
- package/completions/fish/postman.fish +159 -71
- package/completions/zsh/_postman +247 -59
- package/package.json +1 -1
package/completions/zsh/_postman
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
#compdef postman
|
|
2
2
|
compdef _postman postman
|
|
3
|
-
# Zsh completion for Postman CLI (postman v1.
|
|
3
|
+
# Zsh completion for Postman CLI (postman v1.63.0)
|
|
4
4
|
# Auto-generated by scripts/generate.mjs — DO NOT EDIT
|
|
5
5
|
# Source: spec/commands.json
|
|
6
6
|
# https://github.com/yokawasa/postman-cli-completion
|
|
@@ -25,6 +25,7 @@ _postman() {
|
|
|
25
25
|
logout) _postman_logout ;;
|
|
26
26
|
init) _postman_init ;;
|
|
27
27
|
whoami) _postman_whoami ;;
|
|
28
|
+
feedback) _postman_feedback ;;
|
|
28
29
|
update) _postman_update ;;
|
|
29
30
|
skills) _postman_skills ;;
|
|
30
31
|
collection) _postman_collection ;;
|
|
@@ -35,6 +36,7 @@ _postman() {
|
|
|
35
36
|
spec) _postman_spec ;;
|
|
36
37
|
monitor) _postman_monitor ;;
|
|
37
38
|
workspace|ws) _postman_workspace ;;
|
|
39
|
+
team) _postman_team ;;
|
|
38
40
|
performance) _postman_performance ;;
|
|
39
41
|
flows|fl) _postman_flows ;;
|
|
40
42
|
request) _postman_request ;;
|
|
@@ -42,7 +44,7 @@ _postman() {
|
|
|
42
44
|
mock) _postman_mock ;;
|
|
43
45
|
application|app) _postman_application ;;
|
|
44
46
|
simulate) _postman_simulate ;;
|
|
45
|
-
|
|
47
|
+
describe) _postman_describe ;;
|
|
46
48
|
context-graph) _postman_context_graph ;;
|
|
47
49
|
search) _postman_search ;;
|
|
48
50
|
webhook) _postman_webhook ;;
|
|
@@ -61,6 +63,7 @@ _postman_commands() {
|
|
|
61
63
|
'logout:Delete the stored Postman API key.'
|
|
62
64
|
'init:Set up Postman artifacts and agent instructions in a repository.'
|
|
63
65
|
'whoami:Show the Postman account or guest session this CLI session is using.'
|
|
66
|
+
'feedback:Submit feedback about CLI usability, gaps, and improvement suggestions.'
|
|
64
67
|
'update:Update Postman CLI using the original installation method.'
|
|
65
68
|
'skills:Check and update the agent skills in this repository.'
|
|
66
69
|
'collection:Run and test your Postman collections directly from the command line.'
|
|
@@ -72,6 +75,7 @@ _postman_commands() {
|
|
|
72
75
|
'monitor:Run and manage Postman monitors.'
|
|
73
76
|
'workspace:Manage workspace resources.'
|
|
74
77
|
'ws:Alias for workspace'
|
|
78
|
+
'team:Work with the teams inside your organisation.'
|
|
75
79
|
'performance:Manage performance tests on your collections.'
|
|
76
80
|
'flows:Manage and interact with flows.'
|
|
77
81
|
'fl:Alias for flows'
|
|
@@ -81,7 +85,7 @@ _postman_commands() {
|
|
|
81
85
|
'application:Application-level commands\: initialise config and run tests.'
|
|
82
86
|
'app:Alias for application'
|
|
83
87
|
'simulate:Start mock servers with simulated failure scenarios.'
|
|
84
|
-
'
|
|
88
|
+
'describe:\[Beta\] Get API context for AI coding agents directly from the command line.'
|
|
85
89
|
'context-graph:Ask natural-language questions about your team'\''s Context Graph.'
|
|
86
90
|
'search:Search for Postman element types (requests, collections, workspaces, and more).'
|
|
87
91
|
'webhook:Create and manage Postman webhooks.'
|
|
@@ -119,7 +123,7 @@ _postman_init() {
|
|
|
119
123
|
'--dry-run[Report what would happen without writing anything]' \
|
|
120
124
|
'--no-fetch[Use the skills bundled with this CLI instead of fetching the latest]' \
|
|
121
125
|
'--spec[Which spec is authoritative, when more than one could be]:path:_files -g "*.(yaml|yml|json)"' \
|
|
122
|
-
'--visibility[Create and bind a workspace non-interactively (personal
|
|
126
|
+
'--visibility[Create and bind a workspace non-interactively (personal, team)]:status' \
|
|
123
127
|
'--no-cloud[Skip the workspace step entirely]' \
|
|
124
128
|
'--report-events[Send init analytics to Postman (requires login)]' \
|
|
125
129
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
@@ -132,6 +136,15 @@ _postman_whoami() {
|
|
|
132
136
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
133
137
|
}
|
|
134
138
|
|
|
139
|
+
_postman_feedback() {
|
|
140
|
+
_arguments \
|
|
141
|
+
'--type[Feedback type\: cli_gap, improvement_suggestion, bug_report, feature_request, general (default\: general)]:type' \
|
|
142
|
+
'--context[Command or feature context this feedback is about]:context' \
|
|
143
|
+
'--json[Print result as machine-readable JSON]' \
|
|
144
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
145
|
+
'*:text:'
|
|
146
|
+
}
|
|
147
|
+
|
|
135
148
|
_postman_update() {
|
|
136
149
|
_arguments \
|
|
137
150
|
'--check[Check whether a Postman CLI update is available.]' \
|
|
@@ -196,6 +209,8 @@ _postman_collection() {
|
|
|
196
209
|
lint) _postman_collection_lint ;;
|
|
197
210
|
ai-readiness) _postman_collection_ai_readiness ;;
|
|
198
211
|
get) _postman_collection_get ;;
|
|
212
|
+
request) _postman_collection_request ;;
|
|
213
|
+
folder) _postman_collection_folder ;;
|
|
199
214
|
list) _postman_collection_list ;;
|
|
200
215
|
run) _postman_collection_run ;;
|
|
201
216
|
esac
|
|
@@ -211,6 +226,8 @@ _postman_collection_commands() {
|
|
|
211
226
|
'lint:Run linting on a local v3 collection at the given file or directory path.'
|
|
212
227
|
'ai-readiness:Score a Postman collection for AI readiness by ID, local file path, or local-mode directory.'
|
|
213
228
|
'get:Fetch a Postman collection in the V3 format and print it.'
|
|
229
|
+
'request:Add, update, or remove requests in a local v3 collection.'
|
|
230
|
+
'folder:Add, update, or remove folders in a local v3 collection.'
|
|
214
231
|
'list:List collections\: your local project'\''s collections by default, or a Postman cloud workspace'\''s collections with --workspace.'
|
|
215
232
|
'run:Initiate a Postman collection run from a given ID or path.'
|
|
216
233
|
)
|
|
@@ -258,6 +275,142 @@ _postman_collection_get() {
|
|
|
258
275
|
'*:id:'
|
|
259
276
|
}
|
|
260
277
|
|
|
278
|
+
_postman_collection_request() {
|
|
279
|
+
local context state state_descr line
|
|
280
|
+
typeset -A opt_args
|
|
281
|
+
_arguments -C \
|
|
282
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
283
|
+
'1: :_postman_collection_request_commands' \
|
|
284
|
+
'*::arg:->args'
|
|
285
|
+
case $state in
|
|
286
|
+
args)
|
|
287
|
+
case $words[1] in
|
|
288
|
+
add) _postman_collection_request_add ;;
|
|
289
|
+
update) _postman_collection_request_update ;;
|
|
290
|
+
rm|remove) _postman_collection_request_rm ;;
|
|
291
|
+
esac
|
|
292
|
+
;;
|
|
293
|
+
esac
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
_postman_collection_request_commands() {
|
|
297
|
+
local -a sub
|
|
298
|
+
sub=(
|
|
299
|
+
'add:Add an empty request to a local v3 collection (set its details later with `update`).'
|
|
300
|
+
'update:Update a request in a v3 collection (only the fields you pass).'
|
|
301
|
+
'rm:Remove a request (any type) from a v3 collection.'
|
|
302
|
+
'remove:Alias for rm'
|
|
303
|
+
)
|
|
304
|
+
_describe -t commands 'request command' sub
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
_postman_collection_request_add() {
|
|
308
|
+
_arguments \
|
|
309
|
+
'--collection[Target collection\: name, directory, id, cloud id, or path. Required.]:id|name' \
|
|
310
|
+
'--folder[Folder within the collection, e.g. "Users/Admin". Defaults to the root.]:id|name|path' \
|
|
311
|
+
'--type[Request type\: http, graphql, grpc, websocket, socketio. (default\: "http")]:type' \
|
|
312
|
+
'(-w --workspace)'{-w,--workspace}'[Target a Postman cloud workspace by id (cloud mode).]:id' \
|
|
313
|
+
'--json[JSON output.]' \
|
|
314
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
315
|
+
'*:request-name:'
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
_postman_collection_request_update() {
|
|
319
|
+
_arguments \
|
|
320
|
+
'--collection[Target collection\: name, directory, id, cloud id, or path (cloud\: id only). Required.]:id|name' \
|
|
321
|
+
'--folder[Folder to scope the request selector, e.g. "Users/Admin" (local\: name/path; cloud\: id).]:id|name|path' \
|
|
322
|
+
'--rename[Rename the request (moves its file). Any request type.]:name' \
|
|
323
|
+
'--url[Request URL. Any request type.]:url' \
|
|
324
|
+
'--method[HTTP method (http requests only).]:method' \
|
|
325
|
+
'--param[Replace query parameters. Repeatable (http requests only). (default\: \[\])]:key\:value:_files -g "*.(pem|crt|key)"' \
|
|
326
|
+
'(-d --body)'{-d,--body}'[Request payload (inline, @file, or - for stdin), interpreted by request type. For http, an optional "<type>\:" prefix picks the content type\: json/text/xml/html/javascript, file\:<path>, urlencoded\:key=v&k2=v2, or formdata\:key=v&file=@path.]:body' \
|
|
327
|
+
'--variables[GraphQL variables JSON (graphql requests only).]:json' \
|
|
328
|
+
'--description[Request description.]:text' \
|
|
329
|
+
'--headers[Replace request headers. Repeatable; any request type with headers. (default\: \[\])]:key\:value:_files -g "*.(pem|crt|key)"' \
|
|
330
|
+
'--auth[Request auth\: none, inherit, bearer\:TOKEN, basic\:USER\:PASS, apikey\:KEY\:VALUE\[\:header|query\], oauth2\:TOKEN. Any request type.]:spec' \
|
|
331
|
+
'--scripts[Replace scripts. event is prerequest or test; script is @file, - for stdin, or inline. Repeatable; any request type. (default\: \[\])]:event\:script' \
|
|
332
|
+
'(-w --workspace)'{-w,--workspace}'[Target a Postman cloud workspace by id (cloud mode).]:id' \
|
|
333
|
+
'--type[Request type for cloud mode\: http, graphql, grpc, websocket, socketio. (default\: "http")]:type' \
|
|
334
|
+
'--json[JSON output.]' \
|
|
335
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
336
|
+
'*:request:'
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
_postman_collection_request_rm() {
|
|
340
|
+
_arguments \
|
|
341
|
+
'--collection[Target collection\: name, directory, id, cloud id, or path (cloud\: id only). Required.]:id|name' \
|
|
342
|
+
'--folder[Folder to scope the request selector, e.g. "Users/Admin" (local\: name/path; cloud\: id).]:id|name|path' \
|
|
343
|
+
'(-w --workspace)'{-w,--workspace}'[Target a Postman cloud workspace by id (cloud mode).]:id' \
|
|
344
|
+
'--type[Request type for cloud mode\: http, graphql, grpc, websocket, socketio. (default\: "http")]:type' \
|
|
345
|
+
'--json[JSON output.]' \
|
|
346
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
347
|
+
'*:request:'
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
_postman_collection_folder() {
|
|
351
|
+
local context state state_descr line
|
|
352
|
+
typeset -A opt_args
|
|
353
|
+
_arguments -C \
|
|
354
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
355
|
+
'1: :_postman_collection_folder_commands' \
|
|
356
|
+
'*::arg:->args'
|
|
357
|
+
case $state in
|
|
358
|
+
args)
|
|
359
|
+
case $words[1] in
|
|
360
|
+
add) _postman_collection_folder_add ;;
|
|
361
|
+
update) _postman_collection_folder_update ;;
|
|
362
|
+
rm|remove) _postman_collection_folder_rm ;;
|
|
363
|
+
esac
|
|
364
|
+
;;
|
|
365
|
+
esac
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
_postman_collection_folder_commands() {
|
|
369
|
+
local -a sub
|
|
370
|
+
sub=(
|
|
371
|
+
'add:Add an empty folder to a local v3 collection (set its details later with `update`).'
|
|
372
|
+
'update:Update a folder in a v3 collection (only the fields you pass).'
|
|
373
|
+
'rm:Remove a folder from a v3 collection (recursive\: removes everything inside it).'
|
|
374
|
+
'remove:Alias for rm'
|
|
375
|
+
)
|
|
376
|
+
_describe -t commands 'folder command' sub
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
_postman_collection_folder_add() {
|
|
380
|
+
_arguments \
|
|
381
|
+
'--collection[Target collection\: name, directory, id, cloud id, or path. Required.]:id|name' \
|
|
382
|
+
'--folder[Parent folder within the collection, e.g. "Users/Admin". Defaults to the root.]:id|name|path' \
|
|
383
|
+
'(-w --workspace)'{-w,--workspace}'[Target a Postman cloud workspace by id (cloud mode).]:id' \
|
|
384
|
+
'--json[JSON output.]' \
|
|
385
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
386
|
+
'*:folder-name:'
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
_postman_collection_folder_update() {
|
|
390
|
+
_arguments \
|
|
391
|
+
'--collection[Target collection\: name, directory, id, cloud id, or path (cloud\: id only). Required.]:id|name' \
|
|
392
|
+
'--folder[Parent folder to scope the selector, e.g. "Users" (local\: name/path; cloud\: id).]:id|name|path' \
|
|
393
|
+
'--name[Rename the folder (moves its directory).]:name' \
|
|
394
|
+
'--description[Folder description.]:text' \
|
|
395
|
+
'--auth[Folder auth\: none, inherit, bearer\:TOKEN, basic\:USER\:PASS, apikey\:KEY\:VALUE\[\:header|query\], oauth2\:TOKEN.]:spec' \
|
|
396
|
+
'--scripts[Replace folder scripts. event is prerequest or test; script is @file, - for stdin, or inline. Repeatable. (default\: \[\])]:event\:script' \
|
|
397
|
+
'(-w --workspace)'{-w,--workspace}'[Target a Postman cloud workspace by id (cloud mode).]:id' \
|
|
398
|
+
'--json[JSON output.]' \
|
|
399
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
400
|
+
'*:folder:'
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
_postman_collection_folder_rm() {
|
|
404
|
+
_arguments \
|
|
405
|
+
'--collection[Target collection\: name, directory, id, cloud id, or path (cloud\: id only). Required.]:id|name' \
|
|
406
|
+
'--folder[Parent folder to scope the selector, e.g. "Users" (local\: name/path; cloud\: id).]:id|name|path' \
|
|
407
|
+
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt (required when stdout is not a TTY).]' \
|
|
408
|
+
'(-w --workspace)'{-w,--workspace}'[Target a Postman cloud workspace by id (cloud mode).]:id' \
|
|
409
|
+
'--json[JSON output.]' \
|
|
410
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
411
|
+
'*:folder:'
|
|
412
|
+
}
|
|
413
|
+
|
|
261
414
|
_postman_collection_list() {
|
|
262
415
|
_arguments \
|
|
263
416
|
'(-w --workspace)'{-w,--workspace}'[List a Postman cloud workspace'\''s collections by id. Omit to list the local project'\''s collections.]:workspaceId' \
|
|
@@ -808,7 +961,7 @@ _postman_monitor_commands() {
|
|
|
808
961
|
|
|
809
962
|
_postman_monitor_run() {
|
|
810
963
|
_arguments \
|
|
811
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
964
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
812
965
|
'(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[Specify whether or not to override the default exit code for the current run]' \
|
|
813
966
|
'(-t --timeout)'{-t,--timeout}'[Maximum wait time for run completion in milliseconds (default\: 15 minutes) (default\: 900000)]:ms' \
|
|
814
967
|
'--async[Submit the run and return immediately with its job id and Postman URL, without waiting for completion]' \
|
|
@@ -840,7 +993,7 @@ _postman_monitor_create() {
|
|
|
840
993
|
'--iteration-count[Number of iterations to run]:n' \
|
|
841
994
|
'--iteration-strategy[How iteration data is consumed, for example round_robin, repeat_last or stop_at_end (requires --iteration-count, --dataset-id and --dataset-view-id)]:strategy' \
|
|
842
995
|
'--no-run-now[Do not trigger an immediate run after creating the monitor]' \
|
|
843
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
996
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
844
997
|
'--json[Output as JSON instead of a table]' \
|
|
845
998
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
846
999
|
}
|
|
@@ -867,7 +1020,7 @@ _postman_monitor_update() {
|
|
|
867
1020
|
'--dataset-view-id[Dataset view to iterate (used together with --dataset-id)]:id' \
|
|
868
1021
|
'--iteration-count[Number of iterations to run]:n' \
|
|
869
1022
|
'--iteration-strategy[How iteration data is consumed, for example round_robin, repeat_last or stop_at_end (requires --iteration-count, --dataset-id and --dataset-view-id)]:strategy' \
|
|
870
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1023
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
871
1024
|
'--json[Output as JSON instead of a table]' \
|
|
872
1025
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
873
1026
|
'*:monitorId:'
|
|
@@ -876,7 +1029,7 @@ _postman_monitor_update() {
|
|
|
876
1029
|
_postman_monitor_delete() {
|
|
877
1030
|
_arguments \
|
|
878
1031
|
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt]' \
|
|
879
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1032
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
880
1033
|
'--json[Output the outcome, including any failure, as JSON instead of a plain message]' \
|
|
881
1034
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
882
1035
|
'*:monitorId:'
|
|
@@ -965,7 +1118,7 @@ _postman_monitor_runs_get() {
|
|
|
965
1118
|
|
|
966
1119
|
_postman_monitor_list() {
|
|
967
1120
|
_arguments \
|
|
968
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1121
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
969
1122
|
'(-w --workspace)'{-w,--workspace}'[Filter to monitors in this workspace]:id' \
|
|
970
1123
|
'(-c --collection)'{-c,--collection}'[Filter to monitors on this collection]:id' \
|
|
971
1124
|
'(-e --environment)'{-e,--environment}'[Filter to monitors on this environment]:id' \
|
|
@@ -985,7 +1138,7 @@ _postman_monitor_list() {
|
|
|
985
1138
|
|
|
986
1139
|
_postman_monitor_get() {
|
|
987
1140
|
_arguments \
|
|
988
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1141
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
989
1142
|
'--json[Output as JSON instead of a table]' \
|
|
990
1143
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
991
1144
|
'*:monitorId:'
|
|
@@ -993,7 +1146,7 @@ _postman_monitor_get() {
|
|
|
993
1146
|
|
|
994
1147
|
_postman_monitor_metrics() {
|
|
995
1148
|
_arguments \
|
|
996
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1149
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
997
1150
|
'--since[Only executions at or after this ISO 8601 date-time (defaults to 7 days ago)]:dateTime' \
|
|
998
1151
|
'--until[Only executions at or before this ISO 8601 date-time (defaults to now)]:dateTime' \
|
|
999
1152
|
'(-f --filter)'{-f,--filter}'[Show only requests whose name contains this text (case-insensitive)]:text' \
|
|
@@ -1005,7 +1158,7 @@ _postman_monitor_metrics() {
|
|
|
1005
1158
|
|
|
1006
1159
|
_postman_monitor_pause() {
|
|
1007
1160
|
_arguments \
|
|
1008
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1161
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1009
1162
|
'--json[Output as JSON instead of a table]' \
|
|
1010
1163
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1011
1164
|
'*:monitorId:'
|
|
@@ -1013,7 +1166,7 @@ _postman_monitor_pause() {
|
|
|
1013
1166
|
|
|
1014
1167
|
_postman_monitor_resume() {
|
|
1015
1168
|
_arguments \
|
|
1016
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1169
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1017
1170
|
'--json[Output as JSON instead of a table]' \
|
|
1018
1171
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1019
1172
|
'*:monitorId:'
|
|
@@ -1107,9 +1260,11 @@ _postman_workspace_get() {
|
|
|
1107
1260
|
|
|
1108
1261
|
_postman_workspace_create() {
|
|
1109
1262
|
_arguments \
|
|
1110
|
-
'--visibility[Required.
|
|
1263
|
+
'--visibility[Required. One of\: personal, private, team, public, partner.]:status' \
|
|
1111
1264
|
'--name[Workspace name (defaults to owner/repo from the git remote)]:name' \
|
|
1112
1265
|
'--summary[Optional workspace summary]:text' \
|
|
1266
|
+
'--team-id[The team inside your organisation the workspace belongs to. Required for a team workspace when your organisation has teams inside it. Find it with `postman team list`.]:id' \
|
|
1267
|
+
'--team-role[What a team or public workspace grants\: view or edit. Applies to the team named by --team-id, or to your whole organisation when none is named. Defaults to your team'\''s configured default.]:level' \
|
|
1113
1268
|
'--path[Directory to bind (defaults to the current directory)]:dir:_files -g "*.json"' \
|
|
1114
1269
|
'--no-connect[Create the workspace without binding it to the repository]' \
|
|
1115
1270
|
'--force[Create even when a workspace is already recorded for this repo]' \
|
|
@@ -1144,6 +1299,38 @@ _postman_workspace_diff() {
|
|
|
1144
1299
|
'*:workspaceId:'
|
|
1145
1300
|
}
|
|
1146
1301
|
|
|
1302
|
+
_postman_team() {
|
|
1303
|
+
local context state state_descr line
|
|
1304
|
+
typeset -A opt_args
|
|
1305
|
+
_arguments -C \
|
|
1306
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1307
|
+
'1: :_postman_team_commands' \
|
|
1308
|
+
'*::arg:->args'
|
|
1309
|
+
case $state in
|
|
1310
|
+
args)
|
|
1311
|
+
case $words[1] in
|
|
1312
|
+
list) _postman_team_list ;;
|
|
1313
|
+
esac
|
|
1314
|
+
;;
|
|
1315
|
+
esac
|
|
1316
|
+
}
|
|
1317
|
+
|
|
1318
|
+
_postman_team_commands() {
|
|
1319
|
+
local -a sub
|
|
1320
|
+
sub=(
|
|
1321
|
+
'list:List the teams inside your organisation.'
|
|
1322
|
+
)
|
|
1323
|
+
_describe -t commands 'team command' sub
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
_postman_team_list() {
|
|
1327
|
+
_arguments \
|
|
1328
|
+
'--can-create-workspace[Only list teams you could create a workspace in.]' \
|
|
1329
|
+
'--json[Print the list as machine-readable JSON.]' \
|
|
1330
|
+
'--timeout[Abort the run after this many milliseconds. Defaults to 30000.]:ms' \
|
|
1331
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1332
|
+
}
|
|
1333
|
+
|
|
1147
1334
|
_postman_performance() {
|
|
1148
1335
|
local context state state_descr line
|
|
1149
1336
|
typeset -A opt_args
|
|
@@ -1184,6 +1371,7 @@ _postman_performance_run() {
|
|
|
1184
1371
|
'--dataset-view-id[Dataset view to execute for iteration data (requires --dataset-id)]:id' \
|
|
1185
1372
|
'--dataset-distribution[How rows map to VUs\: round-robin (default), fixed, random]:strategy' \
|
|
1186
1373
|
'--postman-api-key[API Key used to load the resources from the Postman API (Only supported in the US region, use '\''postman login --region'\'' to authenticate instead)]:apiKey' \
|
|
1374
|
+
'--output[Output format for live results\: auto (default, interactive dashboard) or ndjson (one JSON object per line on stdout, ending with a "summary" event — for CI or other non-interactive use) (default\: "auto")]:format' \
|
|
1187
1375
|
'--runner[Runner to execute the performance test on\: local, postman-cloud, or postman-cloud-static-ip (egress from your account region'\''s static-IP cluster) (default\: local)]:runner' \
|
|
1188
1376
|
'--pass-if[Pass condition in format\: function(metric, value). Functions\: less_than, greater_than, less_than_eq, greater_than_eq. Metrics\: avg, p90, p95, p99, error_rate, rps. Example\: less_than(p95, 500) or less_than(error_rate, 5)]:condition' \
|
|
1189
1377
|
'--use-mock[Redirect a variable/host to a local code mock or cloud Mock Server (repeatable). Format\: "<{{var}}|host> mock|mock-server\:<path|id> \[scenario\]" (default\: \[\])]:mapping' \
|
|
@@ -1595,7 +1783,7 @@ _postman_mock_generate() {
|
|
|
1595
1783
|
|
|
1596
1784
|
_postman_mock_run() {
|
|
1597
1785
|
_arguments \
|
|
1598
|
-
'(-e --environment)'{-e,--environment}'[Path to a file of environment variables for the mock. Relative or absolute, e.g. ./postman/environments/dev.
|
|
1786
|
+
'(-e --environment)'{-e,--environment}'[Path to a file of environment variables for the mock. Relative or absolute, e.g. ./postman/environments/dev.environment.yaml]:path:_files -g "*.json"' \
|
|
1599
1787
|
'(-g --globals)'{-g,--globals}'[Path to a file of global variables for the mock. Relative or absolute, e.g. ./globals.json]:path:_files -g "*.json"' \
|
|
1600
1788
|
'(-p --port)'{-p,--port}'[Port to run on (e.g. 4010), or "auto" for a free one. Defaults to the mock'\''s configured port.]:port' \
|
|
1601
1789
|
'--api-key[Postman API key, used with a Postman cloud id (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
@@ -1755,29 +1943,29 @@ _postman_simulate_run() {
|
|
|
1755
1943
|
'*:filepath:_files -g "*.json"'
|
|
1756
1944
|
}
|
|
1757
1945
|
|
|
1758
|
-
|
|
1946
|
+
_postman_describe() {
|
|
1759
1947
|
local context state state_descr line
|
|
1760
1948
|
typeset -A opt_args
|
|
1761
1949
|
_arguments -C \
|
|
1762
1950
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1763
|
-
'1: :
|
|
1951
|
+
'1: :_postman_describe_commands' \
|
|
1764
1952
|
'*::arg:->args'
|
|
1765
1953
|
case $state in
|
|
1766
1954
|
args)
|
|
1767
1955
|
case $words[1] in
|
|
1768
|
-
instructions)
|
|
1769
|
-
collection)
|
|
1770
|
-
request)
|
|
1771
|
-
folder)
|
|
1772
|
-
response)
|
|
1773
|
-
workspace)
|
|
1774
|
-
environment)
|
|
1956
|
+
instructions) _postman_describe_instructions ;;
|
|
1957
|
+
collection) _postman_describe_collection ;;
|
|
1958
|
+
request) _postman_describe_request ;;
|
|
1959
|
+
folder) _postman_describe_folder ;;
|
|
1960
|
+
response) _postman_describe_response ;;
|
|
1961
|
+
workspace) _postman_describe_workspace ;;
|
|
1962
|
+
environment) _postman_describe_environment ;;
|
|
1775
1963
|
esac
|
|
1776
1964
|
;;
|
|
1777
1965
|
esac
|
|
1778
1966
|
}
|
|
1779
1967
|
|
|
1780
|
-
|
|
1968
|
+
_postman_describe_commands() {
|
|
1781
1969
|
local -a sub
|
|
1782
1970
|
sub=(
|
|
1783
1971
|
'instructions:Get agent instructions for using Postman Context with AI coding agents.'
|
|
@@ -1788,32 +1976,32 @@ _postman_context_commands() {
|
|
|
1788
1976
|
'workspace:Workspace commands'
|
|
1789
1977
|
'environment:Environment commands'
|
|
1790
1978
|
)
|
|
1791
|
-
_describe -t commands '
|
|
1979
|
+
_describe -t commands 'describe command' sub
|
|
1792
1980
|
}
|
|
1793
1981
|
|
|
1794
|
-
|
|
1982
|
+
_postman_describe_instructions() {
|
|
1795
1983
|
_arguments \
|
|
1796
1984
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1797
1985
|
'*:topic:'
|
|
1798
1986
|
}
|
|
1799
1987
|
|
|
1800
|
-
|
|
1988
|
+
_postman_describe_collection() {
|
|
1801
1989
|
local context state state_descr line
|
|
1802
1990
|
typeset -A opt_args
|
|
1803
1991
|
_arguments -C \
|
|
1804
1992
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1805
|
-
'1: :
|
|
1993
|
+
'1: :_postman_describe_collection_commands' \
|
|
1806
1994
|
'*::arg:->args'
|
|
1807
1995
|
case $state in
|
|
1808
1996
|
args)
|
|
1809
1997
|
case $words[1] in
|
|
1810
|
-
get)
|
|
1998
|
+
get) _postman_describe_collection_get ;;
|
|
1811
1999
|
esac
|
|
1812
2000
|
;;
|
|
1813
2001
|
esac
|
|
1814
2002
|
}
|
|
1815
2003
|
|
|
1816
|
-
|
|
2004
|
+
_postman_describe_collection_commands() {
|
|
1817
2005
|
local -a sub
|
|
1818
2006
|
sub=(
|
|
1819
2007
|
'get:Get a collection'\''s metadata and a map of its folders and requests. Returns collection info (name, description, variables, auth) plus a recursive tree of folders and requests.'
|
|
@@ -1821,30 +2009,30 @@ _postman_context_collection_commands() {
|
|
|
1821
2009
|
_describe -t commands 'collection command' sub
|
|
1822
2010
|
}
|
|
1823
2011
|
|
|
1824
|
-
|
|
2012
|
+
_postman_describe_collection_get() {
|
|
1825
2013
|
_arguments \
|
|
1826
2014
|
'(-c --collection-id)'{-c,--collection-id}'[Collection ID]:id' \
|
|
1827
2015
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1828
2016
|
}
|
|
1829
2017
|
|
|
1830
|
-
|
|
2018
|
+
_postman_describe_request() {
|
|
1831
2019
|
local context state state_descr line
|
|
1832
2020
|
typeset -A opt_args
|
|
1833
2021
|
_arguments -C \
|
|
1834
2022
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1835
|
-
'1: :
|
|
2023
|
+
'1: :_postman_describe_request_commands' \
|
|
1836
2024
|
'*::arg:->args'
|
|
1837
2025
|
case $state in
|
|
1838
2026
|
args)
|
|
1839
2027
|
case $words[1] in
|
|
1840
|
-
get)
|
|
1841
|
-
context)
|
|
2028
|
+
get) _postman_describe_request_get ;;
|
|
2029
|
+
context) _postman_describe_request_context ;;
|
|
1842
2030
|
esac
|
|
1843
2031
|
;;
|
|
1844
2032
|
esac
|
|
1845
2033
|
}
|
|
1846
2034
|
|
|
1847
|
-
|
|
2035
|
+
_postman_describe_request_commands() {
|
|
1848
2036
|
local -a sub
|
|
1849
2037
|
sub=(
|
|
1850
2038
|
'get:Get a request from a collection'
|
|
@@ -1853,37 +2041,37 @@ _postman_context_request_commands() {
|
|
|
1853
2041
|
_describe -t commands 'request command' sub
|
|
1854
2042
|
}
|
|
1855
2043
|
|
|
1856
|
-
|
|
2044
|
+
_postman_describe_request_get() {
|
|
1857
2045
|
_arguments \
|
|
1858
2046
|
'(-r --request-id)'{-r,--request-id}'[Request ID]:id' \
|
|
1859
2047
|
'(-c --collection-id)'{-c,--collection-id}'[Collection ID]:id' \
|
|
1860
2048
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1861
2049
|
}
|
|
1862
2050
|
|
|
1863
|
-
|
|
2051
|
+
_postman_describe_request_context() {
|
|
1864
2052
|
_arguments \
|
|
1865
2053
|
'(-c --collection-id)'{-c,--collection-id}'[Collection ID]:id' \
|
|
1866
2054
|
'(-r --request-id)'{-r,--request-id}'[Request ID]:id' \
|
|
1867
2055
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1868
2056
|
}
|
|
1869
2057
|
|
|
1870
|
-
|
|
2058
|
+
_postman_describe_folder() {
|
|
1871
2059
|
local context state state_descr line
|
|
1872
2060
|
typeset -A opt_args
|
|
1873
2061
|
_arguments -C \
|
|
1874
2062
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1875
|
-
'1: :
|
|
2063
|
+
'1: :_postman_describe_folder_commands' \
|
|
1876
2064
|
'*::arg:->args'
|
|
1877
2065
|
case $state in
|
|
1878
2066
|
args)
|
|
1879
2067
|
case $words[1] in
|
|
1880
|
-
get)
|
|
2068
|
+
get) _postman_describe_folder_get ;;
|
|
1881
2069
|
esac
|
|
1882
2070
|
;;
|
|
1883
2071
|
esac
|
|
1884
2072
|
}
|
|
1885
2073
|
|
|
1886
|
-
|
|
2074
|
+
_postman_describe_folder_commands() {
|
|
1887
2075
|
local -a sub
|
|
1888
2076
|
sub=(
|
|
1889
2077
|
'get:Get a folder from a collection'
|
|
@@ -1891,30 +2079,30 @@ _postman_context_folder_commands() {
|
|
|
1891
2079
|
_describe -t commands 'folder command' sub
|
|
1892
2080
|
}
|
|
1893
2081
|
|
|
1894
|
-
|
|
2082
|
+
_postman_describe_folder_get() {
|
|
1895
2083
|
_arguments \
|
|
1896
2084
|
'--folder-id[Folder ID]:id' \
|
|
1897
2085
|
'(-c --collection-id)'{-c,--collection-id}'[Collection ID]:id' \
|
|
1898
2086
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1899
2087
|
}
|
|
1900
2088
|
|
|
1901
|
-
|
|
2089
|
+
_postman_describe_response() {
|
|
1902
2090
|
local context state state_descr line
|
|
1903
2091
|
typeset -A opt_args
|
|
1904
2092
|
_arguments -C \
|
|
1905
2093
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1906
|
-
'1: :
|
|
2094
|
+
'1: :_postman_describe_response_commands' \
|
|
1907
2095
|
'*::arg:->args'
|
|
1908
2096
|
case $state in
|
|
1909
2097
|
args)
|
|
1910
2098
|
case $words[1] in
|
|
1911
|
-
get)
|
|
2099
|
+
get) _postman_describe_response_get ;;
|
|
1912
2100
|
esac
|
|
1913
2101
|
;;
|
|
1914
2102
|
esac
|
|
1915
2103
|
}
|
|
1916
2104
|
|
|
1917
|
-
|
|
2105
|
+
_postman_describe_response_commands() {
|
|
1918
2106
|
local -a sub
|
|
1919
2107
|
sub=(
|
|
1920
2108
|
'get:Get a saved response example from a collection'
|
|
@@ -1922,7 +2110,7 @@ _postman_context_response_commands() {
|
|
|
1922
2110
|
_describe -t commands 'response command' sub
|
|
1923
2111
|
}
|
|
1924
2112
|
|
|
1925
|
-
|
|
2113
|
+
_postman_describe_response_get() {
|
|
1926
2114
|
_arguments \
|
|
1927
2115
|
'--id[Response ID]:id' \
|
|
1928
2116
|
'(-c --collection-id)'{-c,--collection-id}'[Collection ID]:id' \
|
|
@@ -1930,23 +2118,23 @@ _postman_context_response_get() {
|
|
|
1930
2118
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1931
2119
|
}
|
|
1932
2120
|
|
|
1933
|
-
|
|
2121
|
+
_postman_describe_workspace() {
|
|
1934
2122
|
local context state state_descr line
|
|
1935
2123
|
typeset -A opt_args
|
|
1936
2124
|
_arguments -C \
|
|
1937
2125
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1938
|
-
'1: :
|
|
2126
|
+
'1: :_postman_describe_workspace_commands' \
|
|
1939
2127
|
'*::arg:->args'
|
|
1940
2128
|
case $state in
|
|
1941
2129
|
args)
|
|
1942
2130
|
case $words[1] in
|
|
1943
|
-
get)
|
|
2131
|
+
get) _postman_describe_workspace_get ;;
|
|
1944
2132
|
esac
|
|
1945
2133
|
;;
|
|
1946
2134
|
esac
|
|
1947
2135
|
}
|
|
1948
2136
|
|
|
1949
|
-
|
|
2137
|
+
_postman_describe_workspace_commands() {
|
|
1950
2138
|
local -a sub
|
|
1951
2139
|
sub=(
|
|
1952
2140
|
'get:Get a workspace by ID'
|
|
@@ -1954,29 +2142,29 @@ _postman_context_workspace_commands() {
|
|
|
1954
2142
|
_describe -t commands 'workspace command' sub
|
|
1955
2143
|
}
|
|
1956
2144
|
|
|
1957
|
-
|
|
2145
|
+
_postman_describe_workspace_get() {
|
|
1958
2146
|
_arguments \
|
|
1959
2147
|
'(-w --workspace-id)'{-w,--workspace-id}'[Workspace ID]:id' \
|
|
1960
2148
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1961
2149
|
}
|
|
1962
2150
|
|
|
1963
|
-
|
|
2151
|
+
_postman_describe_environment() {
|
|
1964
2152
|
local context state state_descr line
|
|
1965
2153
|
typeset -A opt_args
|
|
1966
2154
|
_arguments -C \
|
|
1967
2155
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1968
|
-
'1: :
|
|
2156
|
+
'1: :_postman_describe_environment_commands' \
|
|
1969
2157
|
'*::arg:->args'
|
|
1970
2158
|
case $state in
|
|
1971
2159
|
args)
|
|
1972
2160
|
case $words[1] in
|
|
1973
|
-
get)
|
|
2161
|
+
get) _postman_describe_environment_get ;;
|
|
1974
2162
|
esac
|
|
1975
2163
|
;;
|
|
1976
2164
|
esac
|
|
1977
2165
|
}
|
|
1978
2166
|
|
|
1979
|
-
|
|
2167
|
+
_postman_describe_environment_commands() {
|
|
1980
2168
|
local -a sub
|
|
1981
2169
|
sub=(
|
|
1982
2170
|
'get:Get a single environment by ID'
|
|
@@ -1984,7 +2172,7 @@ _postman_context_environment_commands() {
|
|
|
1984
2172
|
_describe -t commands 'environment command' sub
|
|
1985
2173
|
}
|
|
1986
2174
|
|
|
1987
|
-
|
|
2175
|
+
_postman_describe_environment_get() {
|
|
1988
2176
|
_arguments \
|
|
1989
2177
|
'(-e --environment-id)'{-e,--environment-id}'[Environment ID]:id' \
|
|
1990
2178
|
'(-h --help)'{-h,--help}'[display help for command]'
|