postman-cli-completion 1.39.2 → 1.41.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/completions/bash/postman.bash +199 -7
- package/completions/fish/postman.fish +119 -4
- package/completions/zsh/_postman +269 -31
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Bash completion for Postman CLI (postman v1.
|
|
1
|
+
# Bash completion for Postman CLI (postman v1.41.1)
|
|
2
2
|
# Auto-generated by scripts/generate.mjs — DO NOT EDIT
|
|
3
3
|
# Source: spec/commands.json
|
|
4
4
|
# https://github.com/yokawasa/postman-cli-completion
|
|
@@ -22,7 +22,7 @@ _postman() {
|
|
|
22
22
|
cur="${COMP_WORDS[COMP_CWORD]}"
|
|
23
23
|
prev="${COMP_WORDS[COMP_CWORD-1]}"
|
|
24
24
|
|
|
25
|
-
local top_commands="login logout collection api runner spec monitor workspace performance flows fl request sdk mock application app simulate context search webhook"
|
|
25
|
+
local top_commands="login logout collection api runner spec monitor workspace performance flows fl request sdk mock application app simulate context search webhook dataset"
|
|
26
26
|
local global_flags="-v --version --silent --color -h --help -h --help"
|
|
27
27
|
|
|
28
28
|
local i cmd="" subcmd=""
|
|
@@ -64,6 +64,7 @@ _postman() {
|
|
|
64
64
|
context) _postman_context ;;
|
|
65
65
|
search) _postman_search ;;
|
|
66
66
|
webhook) _postman_webhook ;;
|
|
67
|
+
dataset) _postman_dataset ;;
|
|
67
68
|
esac
|
|
68
69
|
}
|
|
69
70
|
|
|
@@ -140,7 +141,7 @@ _postman_collection_ai_readiness() {
|
|
|
140
141
|
|
|
141
142
|
_postman_collection_run() {
|
|
142
143
|
if [[ "$cur" == -* ]]; then
|
|
143
|
-
COMPREPLY=( $(compgen -W "-e --environment -g --globals -r --reporters --reporter-json-structure -n --iteration-count -d --iteration-data -i --global-var --env-var --integration-id --postman-api-key --alias --bail --ignore-redirects -x --suppress-exit-code --silent --disable-unicode --delay-request --timeout --timeout-request --timeout-script --working-dir --no-insecure-file-read -k --insecure --ssl-client-cert-list --ssl-client-cert --ssl-client-key --ssl-client-passphrase --ssl-extra-ca-certs --cookie-jar --export-cookie-jar --verbose --mock --simulate -h --help --reporter-json-export --reporter-junit-export --reporter-html-export --reporter-json-omitRequestBodies --reporter-html-omitRequestBodies --reporter-json-omitResponseBodies --reporter-html-omitResponseBodies --reporter-json-omitHeaders --reporter-html-omitHeaders --reporter-json-omitAllHeadersAndBody --reporter-html-omitAllHeadersAndBody" -- "$cur") )
|
|
144
|
+
COMPREPLY=( $(compgen -W "-e --environment -g --globals -r --reporters --reporter-json-structure -n --iteration-count -d --iteration-data --iteration-data-dataset --iteration-data-view --dataset -i --global-var --env-var --integration-id --postman-api-key --alias --bail --ignore-redirects -x --suppress-exit-code --silent --disable-unicode --delay-request --timeout --timeout-request --timeout-script --working-dir --no-insecure-file-read -k --insecure --ssl-client-cert-list --ssl-client-cert --ssl-client-key --ssl-client-passphrase --ssl-extra-ca-certs --cookie-jar --export-cookie-jar --verbose --mock --simulate -h --help --reporter-json-export --reporter-junit-export --reporter-html-export --reporter-json-omitRequestBodies --reporter-html-omitRequestBodies --reporter-json-omitResponseBodies --reporter-html-omitResponseBodies --reporter-json-omitHeaders --reporter-html-omitHeaders --reporter-json-omitAllHeadersAndBody --reporter-html-omitAllHeadersAndBody" -- "$cur") )
|
|
144
145
|
return 0
|
|
145
146
|
fi
|
|
146
147
|
case "$prev" in
|
|
@@ -156,6 +157,12 @@ _postman_collection_run() {
|
|
|
156
157
|
-d|--iteration-data)
|
|
157
158
|
_postman_filematch '!*.@(json|csv)' "$cur"
|
|
158
159
|
return 0 ;;
|
|
160
|
+
--iteration-data-dataset)
|
|
161
|
+
_postman_filematch '!*.@(json|csv)' "$cur"
|
|
162
|
+
return 0 ;;
|
|
163
|
+
--dataset)
|
|
164
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
165
|
+
return 0 ;;
|
|
159
166
|
--bail)
|
|
160
167
|
COMPREPLY=( $(compgen -W "folder failure" -- "$cur") )
|
|
161
168
|
return 0 ;;
|
|
@@ -337,7 +344,7 @@ _postman_workspace() {
|
|
|
337
344
|
|
|
338
345
|
_postman_workspace_prepare() {
|
|
339
346
|
if [[ "$cur" == -* ]]; then
|
|
340
|
-
COMPREPLY=( $(compgen -W "--collections-dir --environments-dir -h --help" -- "$cur") )
|
|
347
|
+
COMPREPLY=( $(compgen -W "--collections-dir --environments-dir --verbose -h --help" -- "$cur") )
|
|
341
348
|
return 0
|
|
342
349
|
fi
|
|
343
350
|
case "$prev" in
|
|
@@ -352,7 +359,7 @@ _postman_workspace_prepare() {
|
|
|
352
359
|
|
|
353
360
|
_postman_workspace_push() {
|
|
354
361
|
if [[ "$cur" == -* ]]; then
|
|
355
|
-
COMPREPLY=( $(compgen -W "--collections-dir --environments-dir --no-prepare -y --yes -h --help" -- "$cur") )
|
|
362
|
+
COMPREPLY=( $(compgen -W "--collections-dir --environments-dir --no-prepare -y --yes --verbose -h --help" -- "$cur") )
|
|
356
363
|
return 0
|
|
357
364
|
fi
|
|
358
365
|
case "$prev" in
|
|
@@ -505,13 +512,16 @@ _postman_flows_get_run() {
|
|
|
505
512
|
|
|
506
513
|
_postman_request() {
|
|
507
514
|
if [[ "$cur" == -* ]]; then
|
|
508
|
-
COMPREPLY=( $(compgen -W "-H --header -d --body -f --form -e --environment --timeout --redirects-ignore --redirects-max --redirects-follow-method --redirects-remove-referrer --retry --retry-delay --script-pre-request --script-post-request -o --output --verbose --response-only --debug -h --help --auth-basic-username --auth-basic-password --auth-bearer-token --auth-digest-username --auth-digest-password --auth-oauth1-consumerKey --auth-oauth1-consumerSecret --auth-oauth1-token --auth-oauth1-tokenSecret --auth-oauth2-accessToken --auth-oauth2-tokenType --auth-hawk-authId --auth-hawk-authKey --auth-hawk-algorithm --auth-aws-accessKey --auth-aws-secretKey --auth-aws-region --auth-aws-service --auth-aws-sessionToken --auth-ntlm-username --auth-ntlm-password --auth-ntlm-domain --auth-ntlm-workstation --auth-apikey-key --auth-apikey-value --auth-apikey-in" -- "$cur") )
|
|
515
|
+
COMPREPLY=( $(compgen -W "-H --header -d --body -f --form -e --environment --timeout --redirects-ignore --redirects-max --redirects-follow-method --redirects-remove-referrer --retry --retry-delay --script-pre-request --script-post-request --dataset -o --output --verbose --response-only --debug -h --help --auth-basic-username --auth-basic-password --auth-bearer-token --auth-digest-username --auth-digest-password --auth-oauth1-consumerKey --auth-oauth1-consumerSecret --auth-oauth1-token --auth-oauth1-tokenSecret --auth-oauth2-accessToken --auth-oauth2-tokenType --auth-hawk-authId --auth-hawk-authKey --auth-hawk-algorithm --auth-aws-accessKey --auth-aws-secretKey --auth-aws-region --auth-aws-service --auth-aws-sessionToken --auth-ntlm-username --auth-ntlm-password --auth-ntlm-domain --auth-ntlm-workstation --auth-apikey-key --auth-apikey-value --auth-apikey-in" -- "$cur") )
|
|
509
516
|
return 0
|
|
510
517
|
fi
|
|
511
518
|
case "$prev" in
|
|
512
519
|
-e|--environment)
|
|
513
520
|
_postman_filematch '!*.@(json)' "$cur"
|
|
514
521
|
return 0 ;;
|
|
522
|
+
--dataset)
|
|
523
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
524
|
+
return 0 ;;
|
|
515
525
|
-o|--output)
|
|
516
526
|
_postman_filematch '!*.@(json)' "$cur"
|
|
517
527
|
return 0 ;;
|
|
@@ -595,7 +605,7 @@ _postman_sdk_fetch() {
|
|
|
595
605
|
|
|
596
606
|
_postman_sdk_connect() {
|
|
597
607
|
if [[ "$cur" == -* ]]; then
|
|
598
|
-
COMPREPLY=( $(compgen -W "-l --language -r --repo --repo-owner --repo-name -b --branch --push-to-base --
|
|
608
|
+
COMPREPLY=( $(compgen -W "-l --language -r --repo --repo-owner --repo-name -b --branch --push-to-base --auto-update-pull-requests --auth-provider --verbose -h --help" -- "$cur") )
|
|
599
609
|
return 0
|
|
600
610
|
fi
|
|
601
611
|
case "$prev" in
|
|
@@ -1075,4 +1085,186 @@ _postman_webhook_forward() {
|
|
|
1075
1085
|
esac
|
|
1076
1086
|
}
|
|
1077
1087
|
|
|
1088
|
+
_postman_dataset() {
|
|
1089
|
+
if [[ -z "$subcmd" ]]; then
|
|
1090
|
+
if [[ "$cur" == -* ]]; then
|
|
1091
|
+
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1092
|
+
else
|
|
1093
|
+
COMPREPLY=( $(compgen -W "list get query create delete source view" -- "$cur") )
|
|
1094
|
+
fi
|
|
1095
|
+
return 0
|
|
1096
|
+
fi
|
|
1097
|
+
case "$subcmd" in
|
|
1098
|
+
list) _postman_dataset_list ;;
|
|
1099
|
+
get) _postman_dataset_get ;;
|
|
1100
|
+
query) _postman_dataset_query ;;
|
|
1101
|
+
create) _postman_dataset_create ;;
|
|
1102
|
+
delete) _postman_dataset_delete ;;
|
|
1103
|
+
source) _postman_dataset_source ;;
|
|
1104
|
+
view) _postman_dataset_view ;;
|
|
1105
|
+
esac
|
|
1106
|
+
}
|
|
1107
|
+
|
|
1108
|
+
_postman_dataset_list() {
|
|
1109
|
+
if [[ "$cur" == -* ]]; then
|
|
1110
|
+
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1111
|
+
return 0
|
|
1112
|
+
fi
|
|
1113
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1114
|
+
}
|
|
1115
|
+
|
|
1116
|
+
_postman_dataset_get() {
|
|
1117
|
+
if [[ "$cur" == -* ]]; then
|
|
1118
|
+
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1119
|
+
return 0
|
|
1120
|
+
fi
|
|
1121
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
_postman_dataset_query() {
|
|
1125
|
+
if [[ "$cur" == -* ]]; then
|
|
1126
|
+
COMPREPLY=( $(compgen -W "-q --query -p --param --json -h --help" -- "$cur") )
|
|
1127
|
+
return 0
|
|
1128
|
+
fi
|
|
1129
|
+
case "$prev" in
|
|
1130
|
+
esac
|
|
1131
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1132
|
+
}
|
|
1133
|
+
|
|
1134
|
+
_postman_dataset_create() {
|
|
1135
|
+
if [[ "$cur" == -* ]]; then
|
|
1136
|
+
COMPREPLY=( $(compgen -W "-n --name -d --description --id --force -h --help" -- "$cur") )
|
|
1137
|
+
return 0
|
|
1138
|
+
fi
|
|
1139
|
+
case "$prev" in
|
|
1140
|
+
esac
|
|
1141
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
_postman_dataset_delete() {
|
|
1145
|
+
if [[ "$cur" == -* ]]; then
|
|
1146
|
+
COMPREPLY=( $(compgen -W "-y --yes --keep-resources -h --help" -- "$cur") )
|
|
1147
|
+
return 0
|
|
1148
|
+
fi
|
|
1149
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1150
|
+
}
|
|
1151
|
+
|
|
1152
|
+
_postman_dataset_source() {
|
|
1153
|
+
if [[ -z "$subcmd" ]]; then
|
|
1154
|
+
if [[ "$cur" == -* ]]; then
|
|
1155
|
+
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1156
|
+
else
|
|
1157
|
+
COMPREPLY=( $(compgen -W "list add remove update" -- "$cur") )
|
|
1158
|
+
fi
|
|
1159
|
+
return 0
|
|
1160
|
+
fi
|
|
1161
|
+
case "$subcmd" in
|
|
1162
|
+
list) _postman_dataset_source_list ;;
|
|
1163
|
+
add) _postman_dataset_source_add ;;
|
|
1164
|
+
remove) _postman_dataset_source_remove ;;
|
|
1165
|
+
update) _postman_dataset_source_update ;;
|
|
1166
|
+
esac
|
|
1167
|
+
}
|
|
1168
|
+
|
|
1169
|
+
_postman_dataset_source_list() {
|
|
1170
|
+
if [[ "$cur" == -* ]]; then
|
|
1171
|
+
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1172
|
+
return 0
|
|
1173
|
+
fi
|
|
1174
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1175
|
+
}
|
|
1176
|
+
|
|
1177
|
+
_postman_dataset_source_add() {
|
|
1178
|
+
if [[ "$cur" == -* ]]; then
|
|
1179
|
+
COMPREPLY=( $(compgen -W "-n --name --id --format --type --file --ref-only --force --url --host --port --user --password --database --table --slug -h --help" -- "$cur") )
|
|
1180
|
+
return 0
|
|
1181
|
+
fi
|
|
1182
|
+
case "$prev" in
|
|
1183
|
+
--file)
|
|
1184
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1185
|
+
return 0 ;;
|
|
1186
|
+
esac
|
|
1187
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1188
|
+
}
|
|
1189
|
+
|
|
1190
|
+
_postman_dataset_source_remove() {
|
|
1191
|
+
if [[ "$cur" == -* ]]; then
|
|
1192
|
+
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1193
|
+
return 0
|
|
1194
|
+
fi
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1197
|
+
_postman_dataset_source_update() {
|
|
1198
|
+
if [[ "$cur" == -* ]]; then
|
|
1199
|
+
COMPREPLY=( $(compgen -W "-n --name --format --file --ref-only --force --url --host --port --user --password --database --table --slug -h --help" -- "$cur") )
|
|
1200
|
+
return 0
|
|
1201
|
+
fi
|
|
1202
|
+
case "$prev" in
|
|
1203
|
+
--file)
|
|
1204
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1205
|
+
return 0 ;;
|
|
1206
|
+
esac
|
|
1207
|
+
}
|
|
1208
|
+
|
|
1209
|
+
_postman_dataset_view() {
|
|
1210
|
+
if [[ -z "$subcmd" ]]; then
|
|
1211
|
+
if [[ "$cur" == -* ]]; then
|
|
1212
|
+
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1213
|
+
else
|
|
1214
|
+
COMPREPLY=( $(compgen -W "list run create delete update" -- "$cur") )
|
|
1215
|
+
fi
|
|
1216
|
+
return 0
|
|
1217
|
+
fi
|
|
1218
|
+
case "$subcmd" in
|
|
1219
|
+
list) _postman_dataset_view_list ;;
|
|
1220
|
+
run) _postman_dataset_view_run ;;
|
|
1221
|
+
create) _postman_dataset_view_create ;;
|
|
1222
|
+
delete) _postman_dataset_view_delete ;;
|
|
1223
|
+
update) _postman_dataset_view_update ;;
|
|
1224
|
+
esac
|
|
1225
|
+
}
|
|
1226
|
+
|
|
1227
|
+
_postman_dataset_view_list() {
|
|
1228
|
+
if [[ "$cur" == -* ]]; then
|
|
1229
|
+
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1230
|
+
return 0
|
|
1231
|
+
fi
|
|
1232
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1233
|
+
}
|
|
1234
|
+
|
|
1235
|
+
_postman_dataset_view_run() {
|
|
1236
|
+
if [[ "$cur" == -* ]]; then
|
|
1237
|
+
COMPREPLY=( $(compgen -W "-p --param --json -h --help" -- "$cur") )
|
|
1238
|
+
return 0
|
|
1239
|
+
fi
|
|
1240
|
+
case "$prev" in
|
|
1241
|
+
esac
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1244
|
+
_postman_dataset_view_create() {
|
|
1245
|
+
if [[ "$cur" == -* ]]; then
|
|
1246
|
+
COMPREPLY=( $(compgen -W "-n --name -q --query --id -h --help" -- "$cur") )
|
|
1247
|
+
return 0
|
|
1248
|
+
fi
|
|
1249
|
+
case "$prev" in
|
|
1250
|
+
esac
|
|
1251
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
1252
|
+
}
|
|
1253
|
+
|
|
1254
|
+
_postman_dataset_view_delete() {
|
|
1255
|
+
if [[ "$cur" == -* ]]; then
|
|
1256
|
+
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1257
|
+
return 0
|
|
1258
|
+
fi
|
|
1259
|
+
}
|
|
1260
|
+
|
|
1261
|
+
_postman_dataset_view_update() {
|
|
1262
|
+
if [[ "$cur" == -* ]]; then
|
|
1263
|
+
COMPREPLY=( $(compgen -W "-n --name -q --query -h --help" -- "$cur") )
|
|
1264
|
+
return 0
|
|
1265
|
+
fi
|
|
1266
|
+
case "$prev" in
|
|
1267
|
+
esac
|
|
1268
|
+
}
|
|
1269
|
+
|
|
1078
1270
|
complete -F _postman postman
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Fish completion for Postman CLI (postman v1.
|
|
1
|
+
# Fish completion for Postman CLI (postman v1.41.1)
|
|
2
2
|
# Auto-generated by scripts/generate.mjs — DO NOT EDIT
|
|
3
3
|
# Source: spec/commands.json
|
|
4
4
|
# https://github.com/yokawasa/postman-cli-completion
|
|
5
5
|
|
|
6
6
|
function __postman_no_subcommand
|
|
7
|
-
not __fish_seen_subcommand_from login logout collection api runner spec monitor workspace performance flows fl request sdk mock application app simulate context search webhook
|
|
7
|
+
not __fish_seen_subcommand_from login logout collection api runner spec monitor workspace performance flows fl request sdk mock application app simulate context search webhook dataset
|
|
8
8
|
end
|
|
9
9
|
|
|
10
10
|
function __postman_using_subcommand
|
|
@@ -41,6 +41,7 @@ complete -c postman -n __postman_no_subcommand -a simulate -d 'Start mock server
|
|
|
41
41
|
complete -c postman -n __postman_no_subcommand -a context -d '[Beta] Get API context for AI coding agents directly from the command line.'
|
|
42
42
|
complete -c postman -n __postman_no_subcommand -a search -d 'Search for Postman element types (requests, collections, workspaces, and more).'
|
|
43
43
|
complete -c postman -n __postman_no_subcommand -a webhook -d 'Create and manage Postman webhooks.'
|
|
44
|
+
complete -c postman -n __postman_no_subcommand -a dataset -d '[BETA] Work with Postman datasets defined in local YAML files.'
|
|
44
45
|
|
|
45
46
|
# ---------- login ----------
|
|
46
47
|
complete -c postman -n '__fish_seen_subcommand_from login' -l alias -d 'Specify the alias of the API key to fetch your resources using it. (This option is discontinued and will be removed in a future release.)' -x
|
|
@@ -80,6 +81,9 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
80
81
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l reporter-json-structure -d '[Optional] Generate JSON report using the Newman schema. By default, JSON reports use the native structure of Postman CLI.'
|
|
81
82
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s n -l iteration-count -d 'Define the number of iterations to run' -x
|
|
82
83
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s d -l iteration-data -d 'Specify a data file to use for iterations (either JSON or CSV)' -r
|
|
84
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l iteration-data-dataset -d '[BETA] Path to a .dataset.yaml whose view drives the iteration data. Mutually exclusive with --iteration-data. Requires --iteration-data-view.' -r
|
|
85
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l iteration-data-view -d '[BETA] Name or id of the view to execute (within --iteration-data-dataset). The view\'s result set drives one iteration per row.' -x
|
|
86
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l dataset -d '[BETA] Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to scripts as pm.datasets(<id>). When provided, auto-discovery of .dataset.yaml files from the collection\'s parent repo is disabled. (default: [])' -r
|
|
83
87
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s i -d 'Specify the request/folder id, name, or path to run from the collection. Use a path (e.g. "FolderName/RequestName") to disambiguate items with the same name. Can be specified multiple times to run multiple items (default: [])' -x
|
|
84
88
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l global-var -d 'Allows the specification of global variables via the command line, in a key=value format' -x
|
|
85
89
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l env-var -d 'Allows the specification of environment variables via the command line, in a key=value format (default: [])' -x
|
|
@@ -179,17 +183,19 @@ complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_sub
|
|
|
179
183
|
|
|
180
184
|
# ---------- workspace ----------
|
|
181
185
|
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
182
|
-
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a push -d 'Push local collection, environment, and
|
|
186
|
+
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a push -d 'Push local collection, environment, specification, mock, and simulation changes to Postman workspace.'
|
|
183
187
|
complete -c postman -n '__fish_seen_subcommand_from workspace' -s h -l help -d 'display help for command'
|
|
184
188
|
# ---------- workspace prepare ----------
|
|
185
189
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -l collections-dir -d 'Path to the collections directory (default: "postman/collections")' -x
|
|
186
190
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -l environments-dir -d 'Path to the environments directory (default: "postman/environments")' -x
|
|
191
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -l verbose -d 'Show detailed logging'
|
|
187
192
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -s h -l help -d 'display help for command'
|
|
188
193
|
# ---------- workspace push ----------
|
|
189
194
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l collections-dir -d 'Path to the collections directory (default: "postman/collections")' -x
|
|
190
195
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l environments-dir -d 'Path to the environments directory (default: "postman/environments")' -x
|
|
191
196
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l no-prepare -d 'Skip ID validation and auto-fix before pushing'
|
|
192
197
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -s y -l yes -d 'Skip all confirmation prompts'
|
|
198
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l verbose -d 'Show detailed logging'
|
|
193
199
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -s h -l help -d 'display help for command'
|
|
194
200
|
|
|
195
201
|
# ---------- performance ----------
|
|
@@ -301,6 +307,7 @@ complete -c postman -n '__fish_seen_subcommand_from request' -l retry -d 'Number
|
|
|
301
307
|
complete -c postman -n '__fish_seen_subcommand_from request' -l retry-delay -d 'Delay between retry attempts in milliseconds. (default: 1000)' -x
|
|
302
308
|
complete -c postman -n '__fish_seen_subcommand_from request' -l script-pre-request -d 'Add JavaScript script to run before the request. Can be inline JS or @filepath to load from file. Scripts have access to pm.* APIs. Example: --script-pre-request "pm.environment.set(\'timestamp\', Date.now());" or --script-pre-request @setup.js' -x
|
|
303
309
|
complete -c postman -n '__fish_seen_subcommand_from request' -l script-post-request -d 'Add JavaScript script to run after the request. Can be inline JS or @filepath to load from file. Scripts have access to pm.* APIs. Example: --script-post-request "console.log(pm.response.json());" or --script-post-request @validate.js' -x
|
|
310
|
+
complete -c postman -n '__fish_seen_subcommand_from request' -l dataset -d '[BETA] Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to pre/post-request scripts as pm.datasets(<id>). (default: [])' -r
|
|
304
311
|
complete -c postman -n '__fish_seen_subcommand_from request' -s o -l output -d 'Save complete response to JSON file.Useful for debugging or further processing.' -r
|
|
305
312
|
complete -c postman -n '__fish_seen_subcommand_from request' -l verbose -d 'Show detailed request and response information including headers, body, and metadata.'
|
|
306
313
|
complete -c postman -n '__fish_seen_subcommand_from request' -l response-only -d 'suppress all output except response body. Useful for piping to other commands.'
|
|
@@ -387,7 +394,7 @@ complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcomm
|
|
|
387
394
|
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -l repo-name -d 'GitHub repository name' -x
|
|
388
395
|
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -s b -l branch -d 'Target branch for SDK pull requests (default: "main")' -x
|
|
389
396
|
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -l push-to-base -d 'Push SDK updates directly to the base branch instead of opening a pull request (default: false)'
|
|
390
|
-
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -l
|
|
397
|
+
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -l auto-update-pull-requests -d 'Open auto-update pull requests when the SDK changes (true|false). Defaults to true server-side when omitted' -x
|
|
391
398
|
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -l auth-provider -d 'OAuth provider used by the server when pushing (choices: githubapp, github) (default: "githubapp")' -x
|
|
392
399
|
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -l verbose -d 'Show extra logging'
|
|
393
400
|
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connect' -s h -l help -d 'display help for command'
|
|
@@ -572,3 +579,111 @@ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_sub
|
|
|
572
579
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -s w -l workspace -d 'Postman workspace ID' -x
|
|
573
580
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -l api-key -d 'Postman API key' -r
|
|
574
581
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -s h -l help -d 'display help for command'
|
|
582
|
+
|
|
583
|
+
# ---------- dataset ----------
|
|
584
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a list -d '[BETA] List dataset YAMLs under the given directory, or print summary for a single YAML file.'
|
|
585
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a get -d '[BETA] Print a dataset\'s metadata and structure summary.'
|
|
586
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a query -d '[BETA] Run an ad-hoc SQL query against a dataset.'
|
|
587
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a create -d '[BETA] Scaffold a new empty .dataset.yaml file at <path>.'
|
|
588
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a delete -d '[BETA] Permanently remove a dataset\'s .dataset.yaml file and its .resources/ directory.'
|
|
589
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a source -d '[BETA] Inspect and manage a dataset\'s datasources.'
|
|
590
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a view -d '[BETA] Inspect and manage saved views on a dataset.'
|
|
591
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset' -s h -l help -d 'display help for command'
|
|
592
|
+
# ---------- dataset list ----------
|
|
593
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from list' -l json -d 'Output as JSON instead of a table'
|
|
594
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
595
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from list' -r -k -a '(__fish_complete_suffix .json)'
|
|
596
|
+
# ---------- dataset get ----------
|
|
597
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -l json -d 'Output the full parsed YAML as JSON'
|
|
598
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -s h -l help -d 'display help for command'
|
|
599
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -r -k -a '(__fish_complete_suffix .json)'
|
|
600
|
+
# ---------- dataset query ----------
|
|
601
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s q -l query -d 'SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")' -x
|
|
602
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s p -l param -d 'Positional parameter values for $1, $2, ... bindings; repeatable' -x
|
|
603
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -l json -d 'Output rows as JSON instead of a table'
|
|
604
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s h -l help -d 'display help for command'
|
|
605
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -r -k -a '(__fish_complete_suffix .json)'
|
|
606
|
+
# ---------- dataset create ----------
|
|
607
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -s n -l name -d 'Human-readable name for the dataset' -x
|
|
608
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -s d -l description -d 'Optional description' -x
|
|
609
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -l id -d 'Override the generated dataset id (defaults to a random v4 UUID)' -x
|
|
610
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -l force -d 'Overwrite an existing file at <path>'
|
|
611
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -s h -l help -d 'display help for command'
|
|
612
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -r -k -a '(__fish_complete_suffix .json)'
|
|
613
|
+
# ---------- dataset delete ----------
|
|
614
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -s y -l yes -d 'Skip the confirmation prompt'
|
|
615
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -l keep-resources -d 'Delete only the YAML file; leave the .resources/ directory intact'
|
|
616
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -s h -l help -d 'display help for command'
|
|
617
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -r -k -a '(__fish_complete_suffix .json)'
|
|
618
|
+
# ---------- dataset source ----------
|
|
619
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a list -d '[BETA] List the datasources defined on a dataset.'
|
|
620
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a add -d '[BETA] Add a datasource to a dataset.'
|
|
621
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a remove -d '[BETA] Remove a datasource from a dataset.'
|
|
622
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a update -d '[BETA] Update fields on an existing datasource. Only the flags you provide are changed.'
|
|
623
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source' -s h -l help -d 'display help for command'
|
|
624
|
+
# ---------- dataset source list ----------
|
|
625
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from list' -l json -d 'Output sources as JSON instead of a table'
|
|
626
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
627
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from list' -r -k -a '(__fish_complete_suffix .json)'
|
|
628
|
+
# ---------- dataset source add ----------
|
|
629
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -s n -l name -d 'Logical name for the source (becomes the SQL table name)' -x
|
|
630
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l id -d 'Override the generated source id' -x
|
|
631
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l format -d 'Override the inferred format' -x
|
|
632
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l type -d 'Source kind; inferred from --file/--url when omitted' -x
|
|
633
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l file -d 'Path to a local CSV/JSON file (absolute or cwd-relative)' -r
|
|
634
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ref-only -d 'Reference the file in place; do NOT copy into data_dir'
|
|
635
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l force -d 'When copying, overwrite an existing file at the destination'
|
|
636
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l url -d 'HTTP(S) URL to a remote CSV/JSON file' -x
|
|
637
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l host -d 'DB host (mysql/postgresql)' -x
|
|
638
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l port -d 'DB port' -x
|
|
639
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l user -d 'DB user (warning: stored as plaintext in the YAML).' -x
|
|
640
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l password -d 'DB password (warning: stored as plaintext in the YAML).' -x
|
|
641
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l database -d 'DB database name' -x
|
|
642
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l table -d 'DB table name (optional)' -x
|
|
643
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l slug -d 'Optional slug for the source' -x
|
|
644
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -s h -l help -d 'display help for command'
|
|
645
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -r -k -a '(__fish_complete_suffix .json)'
|
|
646
|
+
# ---------- dataset source remove ----------
|
|
647
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from remove' -s h -l help -d 'display help for command'
|
|
648
|
+
# ---------- dataset source update ----------
|
|
649
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -s n -l name -d 'Rename the source' -x
|
|
650
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l format -d 'Change the format' -x
|
|
651
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l file -d 'Replace the source\'s file (local-filesystem only)' -r
|
|
652
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ref-only -d 'When using --file, reference in place instead of copying'
|
|
653
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l force -d 'When copying with --file, overwrite existing destination'
|
|
654
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l url -d 'Replace the remote URL (remote-url only)' -x
|
|
655
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l host -d 'Update DB host (mysql/postgresql)' -x
|
|
656
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l port -d 'Update DB port' -x
|
|
657
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l user -d 'Update DB user (warning: stored as plaintext in the YAML).' -x
|
|
658
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l password -d 'Update DB password (warning: stored as plaintext in the YAML).' -x
|
|
659
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l database -d 'Update DB database name' -x
|
|
660
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l table -d 'Update DB table name' -x
|
|
661
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l slug -d 'Update slug' -x
|
|
662
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -s h -l help -d 'display help for command'
|
|
663
|
+
# ---------- dataset view ----------
|
|
664
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a list -d '[BETA] List the saved views defined on a dataset.'
|
|
665
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a run -d '[BETA] Execute a saved view against a dataset and print the rows.'
|
|
666
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a create -d '[BETA] Add a saved view to a dataset.'
|
|
667
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a delete -d '[BETA] Remove a saved view from a dataset.'
|
|
668
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a update -d '[BETA] Update name and/or query on an existing view.'
|
|
669
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view' -s h -l help -d 'display help for command'
|
|
670
|
+
# ---------- dataset view list ----------
|
|
671
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from list' -l json -d 'Output views as JSON instead of a table'
|
|
672
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
673
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from list' -r -k -a '(__fish_complete_suffix .json)'
|
|
674
|
+
# ---------- dataset view run ----------
|
|
675
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from run' -s p -l param -d 'Positional parameter values for $1, $2, ... bindings; repeatable' -x
|
|
676
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from run' -l json -d 'Output rows as JSON instead of a table'
|
|
677
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
678
|
+
# ---------- dataset view create ----------
|
|
679
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -s n -l name -d 'View name' -x
|
|
680
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -s q -l query -d 'SQL query the view executes' -x
|
|
681
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -l id -d 'Override the generated view id' -x
|
|
682
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -s h -l help -d 'display help for command'
|
|
683
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -r -k -a '(__fish_complete_suffix .json)'
|
|
684
|
+
# ---------- dataset view delete ----------
|
|
685
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from delete' -s h -l help -d 'display help for command'
|
|
686
|
+
# ---------- dataset view update ----------
|
|
687
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from update' -s n -l name -d 'New view name' -x
|
|
688
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from update' -s q -l query -d 'New SQL query' -x
|
|
689
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from update' -s h -l help -d 'display help for command'
|
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.41.1)
|
|
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
|
|
@@ -38,6 +38,7 @@ _postman() {
|
|
|
38
38
|
context) _postman_context ;;
|
|
39
39
|
search) _postman_search ;;
|
|
40
40
|
webhook) _postman_webhook ;;
|
|
41
|
+
dataset) _postman_dataset ;;
|
|
41
42
|
esac
|
|
42
43
|
;;
|
|
43
44
|
esac
|
|
@@ -66,6 +67,7 @@ _postman_commands() {
|
|
|
66
67
|
'context:\[Beta\] Get API context for AI coding agents directly from the command line.'
|
|
67
68
|
'search:Search for Postman element types (requests, collections, workspaces, and more).'
|
|
68
69
|
'webhook:Create and manage Postman webhooks.'
|
|
70
|
+
'dataset:\[BETA\] Work with Postman datasets defined in local YAML files.'
|
|
69
71
|
)
|
|
70
72
|
_describe -t commands 'postman command' commands
|
|
71
73
|
}
|
|
@@ -117,9 +119,9 @@ _postman_collection_commands() {
|
|
|
117
119
|
|
|
118
120
|
_postman_collection_migrate() {
|
|
119
121
|
_arguments \
|
|
120
|
-
'(-o --output)'{-o,--output}'[Output directory (default\: ./<collection-name>)]:dir:_files -g "*.
|
|
122
|
+
'(-o --output)'{-o,--output}'[Output directory (default\: ./<collection-name>)]:dir:_files -g "*.json"' \
|
|
121
123
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
122
|
-
'*:path:_files -g "*.
|
|
124
|
+
'*:path:_files -g "*.json"'
|
|
123
125
|
}
|
|
124
126
|
|
|
125
127
|
_postman_collection_lint() {
|
|
@@ -127,7 +129,7 @@ _postman_collection_lint() {
|
|
|
127
129
|
'(-f --fail-severity)'{-f,--fail-severity}'[Exit with failure if diagnostics at this level or above are present. \[choices\: "error", "warning"\] (default\: "error")]:value' \
|
|
128
130
|
'(-r --reporter)'{-r,--reporter}'[Output format\: cli (human-readable) or json. (default\: "cli")]:value' \
|
|
129
131
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
130
|
-
'*:path:_files -g "*.
|
|
132
|
+
'*:path:_files -g "*.json"'
|
|
131
133
|
}
|
|
132
134
|
|
|
133
135
|
_postman_collection_ai_readiness() {
|
|
@@ -135,17 +137,20 @@ _postman_collection_ai_readiness() {
|
|
|
135
137
|
'(-o --output)'{-o,--output}'[Output format for the results. \[choices\: "cli", "json", "html"\]]:value' \
|
|
136
138
|
'--min-score[Exit with a non-zero code if the overall score is below this threshold (0-100).]:n' \
|
|
137
139
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
138
|
-
'*:collectionId/Path:_files -g "*.
|
|
140
|
+
'*:collectionId/Path:_files -g "*.json"'
|
|
139
141
|
}
|
|
140
142
|
|
|
141
143
|
_postman_collection_run() {
|
|
142
144
|
_arguments \
|
|
143
|
-
'(-e --environment)'{-e,--environment}'[Specify an Id or path to a Postman Environment]:path:_files -g "*.
|
|
144
|
-
'(-g --globals)'{-g,--globals}'[Specify an Id or path to a file containing Postman Globals]:path:_files -g "*.
|
|
145
|
+
'(-e --environment)'{-e,--environment}'[Specify an Id or path to a Postman Environment]:path:_files -g "*.json"' \
|
|
146
|
+
'(-g --globals)'{-g,--globals}'[Specify an Id or path to a file containing Postman Globals]:path:_files -g "*.json"' \
|
|
145
147
|
'(-r --reporters)'{-r,--reporters}'[Specify the reporters to use for the run\: cli,json,junit,html. For multiple reporters, provide their names as a comma-separated list (E.g., -r cli,json) (default\: \["cli"\])]:reporter:(cli json junit html)' \
|
|
146
148
|
'--reporter-json-structure[\[Optional\] Generate JSON report using the Newman schema. By default, JSON reports use the native structure of Postman CLI.]' \
|
|
147
149
|
'(-n --iteration-count)'{-n,--iteration-count}'[Define the number of iterations to run]:n' \
|
|
148
150
|
'(-d --iteration-data)'{-d,--iteration-data}'[Specify a data file to use for iterations (either JSON or CSV)]:path:_files -g "*.(json|csv)"' \
|
|
151
|
+
'--iteration-data-dataset[\[BETA\] Path to a .dataset.yaml whose view drives the iteration data. Mutually exclusive with --iteration-data. Requires --iteration-data-view.]:path:_files -g "*.(json|csv)"' \
|
|
152
|
+
'--iteration-data-view[\[BETA\] Name or id of the view to execute (within --iteration-data-dataset). The view'\''s result set drives one iteration per row.]:nameOrId' \
|
|
153
|
+
'--dataset[\[BETA\] Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to scripts as pm.datasets(<id>). When provided, auto-discovery of .dataset.yaml files from the collection'\''s parent repo is disabled. (default\: \[\])]:pathOrDir:_files -g "*.json"' \
|
|
149
154
|
'-i[Specify the request/folder id, name, or path to run from the collection. Use a path (e.g. "FolderName/RequestName") to disambiguate items with the same name. Can be specified multiple times to run multiple items (default\: \[\])]:id' \
|
|
150
155
|
'--global-var[Allows the specification of global variables via the command line, in a key=value format]:value' \
|
|
151
156
|
'--env-var[Allows the specification of environment variables via the command line, in a key=value format (default\: \[\])]:value' \
|
|
@@ -169,10 +174,10 @@ _postman_collection_run() {
|
|
|
169
174
|
'--ssl-client-key[Specify the path to a client certificate private key]:path:_files -g "*.(pem|crt|key)"' \
|
|
170
175
|
'--ssl-client-passphrase[Specify the client certificate passphrase (for protected key)]:passphrase' \
|
|
171
176
|
'--ssl-extra-ca-certs[Specify additionally trusted CA certificates (PEM)]:path:_files -g "*.(pem|crt|key)"' \
|
|
172
|
-
'--cookie-jar[Specify the path to a custom cookie jar (serialized tough-cookie JSON)]:path:_files -g "*.
|
|
173
|
-
'--export-cookie-jar[Exports the cookie jar to a file after completing the run]:path:_files -g "*.
|
|
177
|
+
'--cookie-jar[Specify the path to a custom cookie jar (serialized tough-cookie JSON)]:path:_files -g "*.json"' \
|
|
178
|
+
'--export-cookie-jar[Exports the cookie jar to a file after completing the run]:path:_files -g "*.json"' \
|
|
174
179
|
'--verbose[Show detailed information of collection run and each request sent]' \
|
|
175
|
-
'--mock[Start a mock server from manifest (.json) file]:path:_files -g "*.
|
|
180
|
+
'--mock[Start a mock server from manifest (.json) file]:path:_files -g "*.json"' \
|
|
176
181
|
'--simulate[Start mock servers with fault-injection scenarios from a .sim.yaml file]:path:_files -g "*.(sim.yaml|yaml|yml)"' \
|
|
177
182
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
178
183
|
'--reporter-json-export[Path to save the report for the given reporter.]:value:_files -g "*.(json|xml|html)"' \
|
|
@@ -186,7 +191,7 @@ _postman_collection_run() {
|
|
|
186
191
|
'--reporter-html-omitHeaders[Remove all request and response headers from the report.]' \
|
|
187
192
|
'--reporter-json-omitAllHeadersAndBody[Remove all request/response headers and bodies from the report.]' \
|
|
188
193
|
'--reporter-html-omitAllHeadersAndBody[Remove all request/response headers and bodies from the report.]' \
|
|
189
|
-
'*:collectionId/Path:_files -g "*.
|
|
194
|
+
'*:collectionId/Path:_files -g "*.json"'
|
|
190
195
|
}
|
|
191
196
|
|
|
192
197
|
_postman_api() {
|
|
@@ -228,7 +233,7 @@ _postman_api_publish() {
|
|
|
228
233
|
_arguments \
|
|
229
234
|
'--name[Specify the name of the version to publish.]:name' \
|
|
230
235
|
'--release-notes[Specify release notes for the version to publish.]:releaseNotes' \
|
|
231
|
-
'--collections[Specify the collections to publish. If API is connected to a repository, provide file path instead of IDs.]:collectionIds/paths...:_files -g "*.
|
|
236
|
+
'--collections[Specify the collections to publish. If API is connected to a repository, provide file path instead of IDs.]:collectionIds/paths...:_files -g "*.json"' \
|
|
232
237
|
'--api-definition[Specify the API Definition to publish. If API is connected to a repository, provide schema root file path. Note that some repository connections utilize a schema directory path; for such APIs, provide schema directory path instead of file path.]:apiDefinitionId/directory/file' \
|
|
233
238
|
'--do-not-poll[Specify whether or not to poll for completion status of the publish action.]' \
|
|
234
239
|
'(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[Specify whether or not to override the default exit code for the current run.]' \
|
|
@@ -370,7 +375,7 @@ _postman_workspace_commands() {
|
|
|
370
375
|
local -a sub
|
|
371
376
|
sub=(
|
|
372
377
|
'prepare:Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
373
|
-
'push:Push local collection, environment, and
|
|
378
|
+
'push:Push local collection, environment, specification, mock, and simulation changes to Postman workspace.'
|
|
374
379
|
)
|
|
375
380
|
_describe -t commands 'workspace command' sub
|
|
376
381
|
}
|
|
@@ -379,6 +384,7 @@ _postman_workspace_prepare() {
|
|
|
379
384
|
_arguments \
|
|
380
385
|
'--collections-dir[Path to the collections directory (default\: "postman/collections")]:path:_files -/' \
|
|
381
386
|
'--environments-dir[Path to the environments directory (default\: "postman/environments")]:path:_files -/' \
|
|
387
|
+
'--verbose[Show detailed logging]' \
|
|
382
388
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
383
389
|
}
|
|
384
390
|
|
|
@@ -388,6 +394,7 @@ _postman_workspace_push() {
|
|
|
388
394
|
'--environments-dir[Path to the environments directory (default\: "postman/environments")]:path:_files -/' \
|
|
389
395
|
'--no-prepare[Skip ID validation and auto-fix before pushing]' \
|
|
390
396
|
'(-y --yes)'{-y,--yes}'[Skip all confirmation prompts]' \
|
|
397
|
+
'--verbose[Show detailed logging]' \
|
|
391
398
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
392
399
|
}
|
|
393
400
|
|
|
@@ -422,11 +429,11 @@ _postman_performance_run() {
|
|
|
422
429
|
'--vu-count[Number of virtual users (default\: 20)]:count' \
|
|
423
430
|
'(-d --duration)'{-d,--duration}'[Duration of the performance test in minutes (default\: 10)]:minutes' \
|
|
424
431
|
'(-p --load-profile)'{-p,--load-profile}'[Load profile type\: fixed, ramp-up, spike, peak (default\: "ramp-up")]:profile' \
|
|
425
|
-
'--data-file[Path to a JSON or CSV data file to use with the collection]:path:_files -g "*.
|
|
432
|
+
'--data-file[Path to a JSON or CSV data file to use with the collection]:path:_files -g "*.json"' \
|
|
426
433
|
'--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' \
|
|
427
434
|
'--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' \
|
|
428
435
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
429
|
-
'*:collectionId:_files -g "*.
|
|
436
|
+
'*:collectionId:_files -g "*.json"'
|
|
430
437
|
}
|
|
431
438
|
|
|
432
439
|
_postman_flows() {
|
|
@@ -480,7 +487,7 @@ _postman_flows_list() {
|
|
|
480
487
|
_postman_flows_trigger() {
|
|
481
488
|
_arguments \
|
|
482
489
|
'(-i --input)'{-i,--input}'[Set key=value pairs in the trigger payload (e.g. --input foo=bar --input baz=qux) (default\: \[\])]:key=value:_files -g "*.(pem|crt|key)"' \
|
|
483
|
-
'(-f --input-file)'{-f,--input-file}'[Set payload values from JSON files (e.g. --input-file ./inputs.json --input-file ./config.json) (default\: \[\])]:path.json:_files -g "*.
|
|
490
|
+
'(-f --input-file)'{-f,--input-file}'[Set payload values from JSON files (e.g. --input-file ./inputs.json --input-file ./config.json) (default\: \[\])]:path.json:_files -g "*.json"' \
|
|
484
491
|
'(-q --query)'{-q,--query}'[Set query parameters as key=value pairs (e.g. --query foo=bar --query baz=qux) (default\: \[\])]:key=value:_files -g "*.(pem|crt|key)"' \
|
|
485
492
|
'--headers[Set custom headers as key=value pairs (e.g. --headers X-API-Key=12345 --headers User-Agent=MyApp) (default\: \[\])]:key=value:_files -g "*.(pem|crt|key)"' \
|
|
486
493
|
'(-n --dry-run)'{-n,--dry-run}'[Show the flow requestURL and payload that would be sent without making the actual request (default\: false)]' \
|
|
@@ -496,7 +503,7 @@ _postman_flows_trigger() {
|
|
|
496
503
|
|
|
497
504
|
_postman_flows_deploy() {
|
|
498
505
|
_arguments \
|
|
499
|
-
'(-p --path)'{-p,--path}'[Specify the URL path for the trigger]:path:_files -g "*.
|
|
506
|
+
'(-p --path)'{-p,--path}'[Specify the URL path for the trigger]:path:_files -g "*.json"' \
|
|
500
507
|
'(-t --timeout)'{-t,--timeout}'[Specify the HTTP session timeout (5000ms to 60000ms) (default\: "10000ms")]:timeout' \
|
|
501
508
|
'(-a --auth)'{-a,--auth}'[Enable authentication for the trigger (default\: false)]' \
|
|
502
509
|
'--verbose[Verbose output]' \
|
|
@@ -509,9 +516,9 @@ _postman_flows_deploy() {
|
|
|
509
516
|
_postman_flows_run() {
|
|
510
517
|
_arguments \
|
|
511
518
|
'(-i --input)'{-i,--input}'[Set flow inputs as key=value pairs (e.g. --input foo=bar --input baz=qux) (default\: \[\])]:key=value:_files -g "*.(pem|crt|key)"' \
|
|
512
|
-
'(-f --input-file)'{-f,--input-file}'[Set flow inputs from JSON files (e.g. --input-file ./inputs.json --input-file ./config.json) (default\: \[\])]:path.json:_files -g "*.
|
|
519
|
+
'(-f --input-file)'{-f,--input-file}'[Set flow inputs from JSON files (e.g. --input-file ./inputs.json --input-file ./config.json) (default\: \[\])]:path.json:_files -g "*.json"' \
|
|
513
520
|
'(-s --scenario)'{-s,--scenario}'[Use a pre-built scenario as flow inputs (by scenario name). Can be combined with --input and --input-file to override values.]:name' \
|
|
514
|
-
'(-e --environment)'{-e,--environment}'[Specify a path to a Postman Environment file (JSON or YAML)]:path:_files -g "*.
|
|
521
|
+
'(-e --environment)'{-e,--environment}'[Specify a path to a Postman Environment file (JSON or YAML)]:path:_files -g "*.json"' \
|
|
515
522
|
'--working-dir[Specify the path to the working directory]:path:_files -/' \
|
|
516
523
|
'--verbose[Show detailed information of flow run and each request (method, URL, assertions)]' \
|
|
517
524
|
'--no-truncate[Show full output without truncating long values]' \
|
|
@@ -523,7 +530,7 @@ _postman_flows_run() {
|
|
|
523
530
|
'--debug[Debug output]' \
|
|
524
531
|
'--json[JSON output]' \
|
|
525
532
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
526
|
-
'*:path:_files -g "*.
|
|
533
|
+
'*:path:_files -g "*.json"'
|
|
527
534
|
}
|
|
528
535
|
|
|
529
536
|
_postman_flows_update() {
|
|
@@ -564,7 +571,7 @@ _postman_request() {
|
|
|
564
571
|
'(-H --header)'{-H,--header}'[Add HTTP header in key\:value format. Can be used multiple times. Example\: -H "Content-Type\:application/json" -H "X-API-Key\:abc123" (default\: \[\])]:header' \
|
|
565
572
|
'(-d --body)'{-d,--body}'[Request body content. Supports\: inline string, @filepath for file content, or "-" for stdin. Example\: --body '\''{"name"\:"John"}'\'' or --body @data.json]:body' \
|
|
566
573
|
'(-f --form)'{-f,--form}'[Add multipart/form-data field in key=value format. Can be used multiple times. For file uploads use key=@filepath. Example\: -f "name=John" -f "avatar=@photo.jpg" (default\: \[\])]:field' \
|
|
567
|
-
'(-e --environment)'{-e,--environment}'[Load Postman Environment by UUID or file path. Variables in URL, headers, and body will be resolved. Example\: -e dev.postman_environment.json]:path:_files -g "*.
|
|
574
|
+
'(-e --environment)'{-e,--environment}'[Load Postman Environment by UUID or file path. Variables in URL, headers, and body will be resolved. Example\: -e dev.postman_environment.json]:path:_files -g "*.json"' \
|
|
568
575
|
'--timeout[Request timeout in milliseconds. Request will fail if no response within this time. (default\: 300000)]:n' \
|
|
569
576
|
'--redirects-ignore[Prevents Postman CLI from automatically following 3XX redirect responses. By default, redirects are followed.]' \
|
|
570
577
|
'--redirects-max[Maximum number of redirects to follow. Default is unlimited. Useful for preventing redirect loops.]:n' \
|
|
@@ -574,7 +581,8 @@ _postman_request() {
|
|
|
574
581
|
'--retry-delay[Delay between retry attempts in milliseconds. (default\: 1000)]:ms' \
|
|
575
582
|
'--script-pre-request[Add JavaScript script to run before the request. Can be inline JS or @filepath to load from file. Scripts have access to pm.* APIs. Example\: --script-pre-request "pm.environment.set('\''timestamp'\'', Date.now());" or --script-pre-request @setup.js]:script' \
|
|
576
583
|
'--script-post-request[Add JavaScript script to run after the request. Can be inline JS or @filepath to load from file. Scripts have access to pm.* APIs. Example\: --script-post-request "console.log(pm.response.json());" or --script-post-request @validate.js]:script' \
|
|
577
|
-
'
|
|
584
|
+
'--dataset[\[BETA\] Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to pre/post-request scripts as pm.datasets(<id>). (default\: \[\])]:pathOrDir:_files -g "*.json"' \
|
|
585
|
+
'(-o --output)'{-o,--output}'[Save complete response to JSON file.Useful for debugging or further processing.]:path:_files -g "*.json"' \
|
|
578
586
|
'--verbose[Show detailed request and response information including headers, body, and metadata.]' \
|
|
579
587
|
'--response-only[suppress all output except response body. Useful for piping to other commands.]' \
|
|
580
588
|
'--debug[Debug mode\: show detailed execution information including retry attempts, redirects, and timing breakdowns.]' \
|
|
@@ -660,7 +668,7 @@ _postman_sdk_generate() {
|
|
|
660
668
|
'(-o --output-dir)'{-o,--output-dir}'[Directory where the generated SDK will be saved (default\: "./sdks")]:path:_files -/' \
|
|
661
669
|
'--name[Name for the generated SDK package]:name' \
|
|
662
670
|
'--sdk-version[Version number for the generated SDK]:version' \
|
|
663
|
-
'--config[Path to SDK generation config file (JSON). If not specified, will look for .postman/config.json (sdk key).]:path:_files -g "*.
|
|
671
|
+
'--config[Path to SDK generation config file (JSON). If not specified, will look for .postman/config.json (sdk key).]:path:_files -g "*.json"' \
|
|
664
672
|
'(-y --yes)'{-y,--yes}'[Skip all confirmation prompts and overwrite existing files]' \
|
|
665
673
|
'--overwrite[Overwrite existing files without confirmation]' \
|
|
666
674
|
'--verbose[Show detailed generation progress and logs]' \
|
|
@@ -708,7 +716,7 @@ _postman_sdk_connect() {
|
|
|
708
716
|
'--repo-name[GitHub repository name]:name' \
|
|
709
717
|
'(-b --branch)'{-b,--branch}'[Target branch for SDK pull requests (default\: "main")]:branch' \
|
|
710
718
|
'--push-to-base[Push SDK updates directly to the base branch instead of opening a pull request (default\: false)]' \
|
|
711
|
-
'--
|
|
719
|
+
'--auto-update-pull-requests[Open auto-update pull requests when the SDK changes (true|false). Defaults to true server-side when omitted]:bool' \
|
|
712
720
|
'--auth-provider[OAuth provider used by the server when pushing (choices\: githubapp, github) (default\: "githubapp")]:provider' \
|
|
713
721
|
'--verbose[Show extra logging]' \
|
|
714
722
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
@@ -786,8 +794,8 @@ _postman_mock_commands() {
|
|
|
786
794
|
|
|
787
795
|
_postman_mock_run() {
|
|
788
796
|
_arguments \
|
|
789
|
-
'(-e --environment)'{-e,--environment}'[Path to an environment file (JSON or YAML) for pm.environment]:path:_files -g "*.
|
|
790
|
-
'(-g --globals)'{-g,--globals}'[Path to a globals file (JSON or YAML) for pm.globals]:path:_files -g "*.
|
|
797
|
+
'(-e --environment)'{-e,--environment}'[Path to an environment file (JSON or YAML) for pm.environment]:path:_files -g "*.json"' \
|
|
798
|
+
'(-g --globals)'{-g,--globals}'[Path to a globals file (JSON or YAML) for pm.globals]:path:_files -g "*.json"' \
|
|
791
799
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
792
800
|
'*:manifestPath:'
|
|
793
801
|
}
|
|
@@ -832,12 +840,12 @@ _postman_application_init() {
|
|
|
832
840
|
_postman_application_test() {
|
|
833
841
|
_arguments \
|
|
834
842
|
'--target[Select a target from postman.config.js targets block (default\: "default")]:name' \
|
|
835
|
-
'--target-collection[Collection override for the selected target (repeatable) (default\: \[\])]:path:_files -g "*.
|
|
836
|
-
'--target-environment[Environment override for the selected target (last value wins) (default\: \[\])]:path:_files -g "*.
|
|
843
|
+
'--target-collection[Collection override for the selected target (repeatable) (default\: \[\])]:path:_files -g "*.json"' \
|
|
844
|
+
'--target-environment[Environment override for the selected target (last value wins) (default\: \[\])]:path:_files -g "*.json"' \
|
|
837
845
|
'--command[Command to run first (primary task). Overrides config.]:cmd' \
|
|
838
|
-
'--network-log[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/.]:path:_files -g "*.
|
|
846
|
+
'--network-log[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/.]:path:_files -g "*.json"' \
|
|
839
847
|
'--capture-only[Skip collection matching and tests; capture traffic and save a V3 collection organised by host]' \
|
|
840
|
-
'--output[Output directory for captured collection (default\: pm-results/captured/; used with --capture-only)]:path:_files -g "*.
|
|
848
|
+
'--output[Output directory for captured collection (default\: pm-results/captured/; used with --capture-only)]:path:_files -g "*.json"' \
|
|
841
849
|
'--force[Overwrite the output directory if it exists and is not empty (used with --capture-only)]' \
|
|
842
850
|
'--report-events[Send application test run results and analytics to Postman]' \
|
|
843
851
|
'--verbose[Show detailed per-request matching, sandbox errors, and debug information]' \
|
|
@@ -871,7 +879,7 @@ _postman_simulate_commands() {
|
|
|
871
879
|
_postman_simulate_run() {
|
|
872
880
|
_arguments \
|
|
873
881
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
874
|
-
'*:filepath:_files -g "*.
|
|
882
|
+
'*:filepath:_files -g "*.json"'
|
|
875
883
|
}
|
|
876
884
|
|
|
877
885
|
_postman_context() {
|
|
@@ -1284,6 +1292,236 @@ _postman_webhook_forward() {
|
|
|
1284
1292
|
'*:port:'
|
|
1285
1293
|
}
|
|
1286
1294
|
|
|
1295
|
+
_postman_dataset() {
|
|
1296
|
+
local context state state_descr line
|
|
1297
|
+
typeset -A opt_args
|
|
1298
|
+
_arguments -C \
|
|
1299
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1300
|
+
'1: :_postman_dataset_commands' \
|
|
1301
|
+
'*::arg:->args'
|
|
1302
|
+
case $state in
|
|
1303
|
+
args)
|
|
1304
|
+
case $words[1] in
|
|
1305
|
+
list) _postman_dataset_list ;;
|
|
1306
|
+
get) _postman_dataset_get ;;
|
|
1307
|
+
query) _postman_dataset_query ;;
|
|
1308
|
+
create) _postman_dataset_create ;;
|
|
1309
|
+
delete) _postman_dataset_delete ;;
|
|
1310
|
+
source) _postman_dataset_source ;;
|
|
1311
|
+
view) _postman_dataset_view ;;
|
|
1312
|
+
esac
|
|
1313
|
+
;;
|
|
1314
|
+
esac
|
|
1315
|
+
}
|
|
1316
|
+
|
|
1317
|
+
_postman_dataset_commands() {
|
|
1318
|
+
local -a sub
|
|
1319
|
+
sub=(
|
|
1320
|
+
'list:\[BETA\] List dataset YAMLs under the given directory, or print summary for a single YAML file.'
|
|
1321
|
+
'get:\[BETA\] Print a dataset'\''s metadata and structure summary.'
|
|
1322
|
+
'query:\[BETA\] Run an ad-hoc SQL query against a dataset.'
|
|
1323
|
+
'create:\[BETA\] Scaffold a new empty .dataset.yaml file at <path>.'
|
|
1324
|
+
'delete:\[BETA\] Permanently remove a dataset'\''s .dataset.yaml file and its .resources/ directory.'
|
|
1325
|
+
'source:\[BETA\] Inspect and manage a dataset'\''s datasources.'
|
|
1326
|
+
'view:\[BETA\] Inspect and manage saved views on a dataset.'
|
|
1327
|
+
)
|
|
1328
|
+
_describe -t commands 'dataset command' sub
|
|
1329
|
+
}
|
|
1330
|
+
|
|
1331
|
+
_postman_dataset_list() {
|
|
1332
|
+
_arguments \
|
|
1333
|
+
'--json[Output as JSON instead of a table]' \
|
|
1334
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1335
|
+
'*:pathOrDir:_files -g "*.json"'
|
|
1336
|
+
}
|
|
1337
|
+
|
|
1338
|
+
_postman_dataset_get() {
|
|
1339
|
+
_arguments \
|
|
1340
|
+
'--json[Output the full parsed YAML as JSON]' \
|
|
1341
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1342
|
+
'*:path:_files -g "*.json"'
|
|
1343
|
+
}
|
|
1344
|
+
|
|
1345
|
+
_postman_dataset_query() {
|
|
1346
|
+
_arguments \
|
|
1347
|
+
'(-q --query)'{-q,--query}'[SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")]:sql' \
|
|
1348
|
+
'(-p --param)'{-p,--param}'[Positional parameter values for $1, $2, ... bindings; repeatable]:value...' \
|
|
1349
|
+
'--json[Output rows as JSON instead of a table]' \
|
|
1350
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1351
|
+
'*:path:_files -g "*.json"'
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1354
|
+
_postman_dataset_create() {
|
|
1355
|
+
_arguments \
|
|
1356
|
+
'(-n --name)'{-n,--name}'[Human-readable name for the dataset]:name' \
|
|
1357
|
+
'(-d --description)'{-d,--description}'[Optional description]:desc' \
|
|
1358
|
+
'--id[Override the generated dataset id (defaults to a random v4 UUID)]:uuid' \
|
|
1359
|
+
'--force[Overwrite an existing file at <path>]' \
|
|
1360
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1361
|
+
'*:path:_files -g "*.json"'
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1364
|
+
_postman_dataset_delete() {
|
|
1365
|
+
_arguments \
|
|
1366
|
+
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt]' \
|
|
1367
|
+
'--keep-resources[Delete only the YAML file; leave the .resources/ directory intact]' \
|
|
1368
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1369
|
+
'*:path:_files -g "*.json"'
|
|
1370
|
+
}
|
|
1371
|
+
|
|
1372
|
+
_postman_dataset_source() {
|
|
1373
|
+
local context state state_descr line
|
|
1374
|
+
typeset -A opt_args
|
|
1375
|
+
_arguments -C \
|
|
1376
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1377
|
+
'1: :_postman_dataset_source_commands' \
|
|
1378
|
+
'*::arg:->args'
|
|
1379
|
+
case $state in
|
|
1380
|
+
args)
|
|
1381
|
+
case $words[1] in
|
|
1382
|
+
list) _postman_dataset_source_list ;;
|
|
1383
|
+
add) _postman_dataset_source_add ;;
|
|
1384
|
+
remove) _postman_dataset_source_remove ;;
|
|
1385
|
+
update) _postman_dataset_source_update ;;
|
|
1386
|
+
esac
|
|
1387
|
+
;;
|
|
1388
|
+
esac
|
|
1389
|
+
}
|
|
1390
|
+
|
|
1391
|
+
_postman_dataset_source_commands() {
|
|
1392
|
+
local -a sub
|
|
1393
|
+
sub=(
|
|
1394
|
+
'list:\[BETA\] List the datasources defined on a dataset.'
|
|
1395
|
+
'add:\[BETA\] Add a datasource to a dataset.'
|
|
1396
|
+
'remove:\[BETA\] Remove a datasource from a dataset.'
|
|
1397
|
+
'update:\[BETA\] Update fields on an existing datasource. Only the flags you provide are changed.'
|
|
1398
|
+
)
|
|
1399
|
+
_describe -t commands 'source command' sub
|
|
1400
|
+
}
|
|
1401
|
+
|
|
1402
|
+
_postman_dataset_source_list() {
|
|
1403
|
+
_arguments \
|
|
1404
|
+
'--json[Output sources as JSON instead of a table]' \
|
|
1405
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1406
|
+
'*:path:_files -g "*.json"'
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
_postman_dataset_source_add() {
|
|
1410
|
+
_arguments \
|
|
1411
|
+
'(-n --name)'{-n,--name}'[Logical name for the source (becomes the SQL table name)]:name' \
|
|
1412
|
+
'--id[Override the generated source id]:uuid' \
|
|
1413
|
+
'--format[Override the inferred format]:csv|json|mysql|postgres' \
|
|
1414
|
+
'--type[Source kind; inferred from --file/--url when omitted]:local|remote-url|mysql|postgresql' \
|
|
1415
|
+
'--file[Path to a local CSV/JSON file (absolute or cwd-relative)]:path:_files -g "*.json"' \
|
|
1416
|
+
'--ref-only[Reference the file in place; do NOT copy into data_dir]' \
|
|
1417
|
+
'--force[When copying, overwrite an existing file at the destination]' \
|
|
1418
|
+
'--url[HTTP(S) URL to a remote CSV/JSON file]:url' \
|
|
1419
|
+
'--host[DB host (mysql/postgresql)]:host' \
|
|
1420
|
+
'--port[DB port]:port' \
|
|
1421
|
+
'--user[DB user (warning\: stored as plaintext in the YAML).]:user' \
|
|
1422
|
+
'--password[DB password (warning\: stored as plaintext in the YAML).]:password' \
|
|
1423
|
+
'--database[DB database name]:db' \
|
|
1424
|
+
'--table[DB table name (optional)]:table' \
|
|
1425
|
+
'--slug[Optional slug for the source]:slug' \
|
|
1426
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1427
|
+
'*:pathOrId:_files -g "*.json"'
|
|
1428
|
+
}
|
|
1429
|
+
|
|
1430
|
+
_postman_dataset_source_remove() {
|
|
1431
|
+
_arguments \
|
|
1432
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1433
|
+
'*:sourceNameOrId:'
|
|
1434
|
+
}
|
|
1435
|
+
|
|
1436
|
+
_postman_dataset_source_update() {
|
|
1437
|
+
_arguments \
|
|
1438
|
+
'(-n --name)'{-n,--name}'[Rename the source]:name' \
|
|
1439
|
+
'--format[Change the format]:csv|json|mysql|postgres' \
|
|
1440
|
+
'--file[Replace the source'\''s file (local-filesystem only)]:path:_files -g "*.json"' \
|
|
1441
|
+
'--ref-only[When using --file, reference in place instead of copying]' \
|
|
1442
|
+
'--force[When copying with --file, overwrite existing destination]' \
|
|
1443
|
+
'--url[Replace the remote URL (remote-url only)]:url' \
|
|
1444
|
+
'--host[Update DB host (mysql/postgresql)]:host' \
|
|
1445
|
+
'--port[Update DB port]:port' \
|
|
1446
|
+
'--user[Update DB user (warning\: stored as plaintext in the YAML).]:user' \
|
|
1447
|
+
'--password[Update DB password (warning\: stored as plaintext in the YAML).]:password' \
|
|
1448
|
+
'--database[Update DB database name]:db' \
|
|
1449
|
+
'--table[Update DB table name]:table' \
|
|
1450
|
+
'--slug[Update slug]:slug' \
|
|
1451
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1452
|
+
'*:sourceNameOrId:'
|
|
1453
|
+
}
|
|
1454
|
+
|
|
1455
|
+
_postman_dataset_view() {
|
|
1456
|
+
local context state state_descr line
|
|
1457
|
+
typeset -A opt_args
|
|
1458
|
+
_arguments -C \
|
|
1459
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1460
|
+
'1: :_postman_dataset_view_commands' \
|
|
1461
|
+
'*::arg:->args'
|
|
1462
|
+
case $state in
|
|
1463
|
+
args)
|
|
1464
|
+
case $words[1] in
|
|
1465
|
+
list) _postman_dataset_view_list ;;
|
|
1466
|
+
run) _postman_dataset_view_run ;;
|
|
1467
|
+
create) _postman_dataset_view_create ;;
|
|
1468
|
+
delete) _postman_dataset_view_delete ;;
|
|
1469
|
+
update) _postman_dataset_view_update ;;
|
|
1470
|
+
esac
|
|
1471
|
+
;;
|
|
1472
|
+
esac
|
|
1473
|
+
}
|
|
1474
|
+
|
|
1475
|
+
_postman_dataset_view_commands() {
|
|
1476
|
+
local -a sub
|
|
1477
|
+
sub=(
|
|
1478
|
+
'list:\[BETA\] List the saved views defined on a dataset.'
|
|
1479
|
+
'run:\[BETA\] Execute a saved view against a dataset and print the rows.'
|
|
1480
|
+
'create:\[BETA\] Add a saved view to a dataset.'
|
|
1481
|
+
'delete:\[BETA\] Remove a saved view from a dataset.'
|
|
1482
|
+
'update:\[BETA\] Update name and/or query on an existing view.'
|
|
1483
|
+
)
|
|
1484
|
+
_describe -t commands 'view command' sub
|
|
1485
|
+
}
|
|
1486
|
+
|
|
1487
|
+
_postman_dataset_view_list() {
|
|
1488
|
+
_arguments \
|
|
1489
|
+
'--json[Output views as JSON instead of a table]' \
|
|
1490
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1491
|
+
'*:path:_files -g "*.json"'
|
|
1492
|
+
}
|
|
1493
|
+
|
|
1494
|
+
_postman_dataset_view_run() {
|
|
1495
|
+
_arguments \
|
|
1496
|
+
'(-p --param)'{-p,--param}'[Positional parameter values for $1, $2, ... bindings; repeatable]:value...' \
|
|
1497
|
+
'--json[Output rows as JSON instead of a table]' \
|
|
1498
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1499
|
+
'*:viewNameOrId:'
|
|
1500
|
+
}
|
|
1501
|
+
|
|
1502
|
+
_postman_dataset_view_create() {
|
|
1503
|
+
_arguments \
|
|
1504
|
+
'(-n --name)'{-n,--name}'[View name]:name' \
|
|
1505
|
+
'(-q --query)'{-q,--query}'[SQL query the view executes]:sql' \
|
|
1506
|
+
'--id[Override the generated view id]:uuid' \
|
|
1507
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1508
|
+
'*:path:_files -g "*.json"'
|
|
1509
|
+
}
|
|
1510
|
+
|
|
1511
|
+
_postman_dataset_view_delete() {
|
|
1512
|
+
_arguments \
|
|
1513
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1514
|
+
'*:viewNameOrId:'
|
|
1515
|
+
}
|
|
1516
|
+
|
|
1517
|
+
_postman_dataset_view_update() {
|
|
1518
|
+
_arguments \
|
|
1519
|
+
'(-n --name)'{-n,--name}'[New view name]:name' \
|
|
1520
|
+
'(-q --query)'{-q,--query}'[New SQL query]:sql' \
|
|
1521
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1522
|
+
'*:viewNameOrId:'
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1287
1525
|
# When loaded via fpath + compinit, the file body becomes the function body of
|
|
1288
1526
|
# `_postman`. In that case `funcstack[1]` is `_postman` and we must actually
|
|
1289
1527
|
# invoke the completion. When sourced directly, this is a no-op — `_postman`
|