postman-cli-completion 1.44.0 → 1.46.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 +93 -26
- package/completions/fish/postman.fish +76 -44
- package/completions/zsh/_postman +83 -39
- 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.46.0)
|
|
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 dataset"
|
|
25
|
+
local top_commands="login logout collection api runner spec monitor workspace ws 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=""
|
|
@@ -53,7 +53,7 @@ _postman() {
|
|
|
53
53
|
runner) _postman_runner ;;
|
|
54
54
|
spec) _postman_spec ;;
|
|
55
55
|
monitor) _postman_monitor ;;
|
|
56
|
-
workspace) _postman_workspace ;;
|
|
56
|
+
workspace|ws) _postman_workspace ;;
|
|
57
57
|
performance) _postman_performance ;;
|
|
58
58
|
flows|fl) _postman_flows ;;
|
|
59
59
|
request) _postman_request ;;
|
|
@@ -332,16 +332,26 @@ _postman_workspace() {
|
|
|
332
332
|
if [[ "$cur" == -* ]]; then
|
|
333
333
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
334
334
|
else
|
|
335
|
-
COMPREPLY=( $(compgen -W "prepare push" -- "$cur") )
|
|
335
|
+
COMPREPLY=( $(compgen -W "list prepare push" -- "$cur") )
|
|
336
336
|
fi
|
|
337
337
|
return 0
|
|
338
338
|
fi
|
|
339
339
|
case "$subcmd" in
|
|
340
|
+
list) _postman_workspace_list ;;
|
|
340
341
|
prepare) _postman_workspace_prepare ;;
|
|
341
342
|
push) _postman_workspace_push ;;
|
|
342
343
|
esac
|
|
343
344
|
}
|
|
344
345
|
|
|
346
|
+
_postman_workspace_list() {
|
|
347
|
+
if [[ "$cur" == -* ]]; then
|
|
348
|
+
COMPREPLY=( $(compgen -W "-f --filter -t --type --verbose --debug --json -h --help" -- "$cur") )
|
|
349
|
+
return 0
|
|
350
|
+
fi
|
|
351
|
+
case "$prev" in
|
|
352
|
+
esac
|
|
353
|
+
}
|
|
354
|
+
|
|
345
355
|
_postman_workspace_prepare() {
|
|
346
356
|
if [[ "$cur" == -* ]]; then
|
|
347
357
|
COMPREPLY=( $(compgen -W "--verbose -h --help" -- "$cur") )
|
|
@@ -903,7 +913,7 @@ _postman_search() {
|
|
|
903
913
|
if [[ "$cur" == -* ]]; then
|
|
904
914
|
COMPREPLY=( $(compgen -W "--ownership -n --limit --cursor -o --output --filter --filter-json -h --help" -- "$cur") )
|
|
905
915
|
else
|
|
906
|
-
COMPREPLY=( $(compgen -W "requests collections workspaces flows specs mocks environments" -- "$cur") )
|
|
916
|
+
COMPREPLY=( $(compgen -W "requests collections workspaces flows specs mocks environments documents" -- "$cur") )
|
|
907
917
|
fi
|
|
908
918
|
return 0
|
|
909
919
|
fi
|
|
@@ -915,6 +925,7 @@ _postman_search() {
|
|
|
915
925
|
specs) _postman_search_specs ;;
|
|
916
926
|
mocks) _postman_search_mocks ;;
|
|
917
927
|
environments) _postman_search_environments ;;
|
|
928
|
+
documents) _postman_search_documents ;;
|
|
918
929
|
esac
|
|
919
930
|
}
|
|
920
931
|
|
|
@@ -967,6 +978,13 @@ _postman_search_environments() {
|
|
|
967
978
|
fi
|
|
968
979
|
}
|
|
969
980
|
|
|
981
|
+
_postman_search_documents() {
|
|
982
|
+
if [[ "$cur" == -* ]]; then
|
|
983
|
+
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
984
|
+
return 0
|
|
985
|
+
fi
|
|
986
|
+
}
|
|
987
|
+
|
|
970
988
|
_postman_webhook() {
|
|
971
989
|
if [[ -z "$subcmd" ]]; then
|
|
972
990
|
if [[ "$cur" == -* ]]; then
|
|
@@ -1146,46 +1164,64 @@ _postman_dataset() {
|
|
|
1146
1164
|
|
|
1147
1165
|
_postman_dataset_list() {
|
|
1148
1166
|
if [[ "$cur" == -* ]]; then
|
|
1149
|
-
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1167
|
+
COMPREPLY=( $(compgen -W "-w --workspace --api-key --json -h --help" -- "$cur") )
|
|
1150
1168
|
return 0
|
|
1151
1169
|
fi
|
|
1170
|
+
case "$prev" in
|
|
1171
|
+
--api-key)
|
|
1172
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1173
|
+
return 0 ;;
|
|
1174
|
+
esac
|
|
1152
1175
|
_postman_filematch '!*.@(json)' "$cur"
|
|
1153
1176
|
}
|
|
1154
1177
|
|
|
1155
1178
|
_postman_dataset_get() {
|
|
1156
1179
|
if [[ "$cur" == -* ]]; then
|
|
1157
|
-
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1180
|
+
COMPREPLY=( $(compgen -W "--api-key --no-populate --json -h --help" -- "$cur") )
|
|
1158
1181
|
return 0
|
|
1159
1182
|
fi
|
|
1160
|
-
|
|
1183
|
+
case "$prev" in
|
|
1184
|
+
--api-key)
|
|
1185
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1186
|
+
return 0 ;;
|
|
1187
|
+
esac
|
|
1161
1188
|
}
|
|
1162
1189
|
|
|
1163
1190
|
_postman_dataset_query() {
|
|
1164
1191
|
if [[ "$cur" == -* ]]; then
|
|
1165
|
-
COMPREPLY=( $(compgen -W "-q --query -p --param --json -h --help" -- "$cur") )
|
|
1192
|
+
COMPREPLY=( $(compgen -W "-q --query -p --param --api-key --json -h --help" -- "$cur") )
|
|
1166
1193
|
return 0
|
|
1167
1194
|
fi
|
|
1168
1195
|
case "$prev" in
|
|
1196
|
+
--api-key)
|
|
1197
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1198
|
+
return 0 ;;
|
|
1169
1199
|
esac
|
|
1170
|
-
_postman_filematch '!*.@(json)' "$cur"
|
|
1171
1200
|
}
|
|
1172
1201
|
|
|
1173
1202
|
_postman_dataset_create() {
|
|
1174
1203
|
if [[ "$cur" == -* ]]; then
|
|
1175
|
-
COMPREPLY=( $(compgen -W "-n --name -d --description --id --force -h --help" -- "$cur") )
|
|
1204
|
+
COMPREPLY=( $(compgen -W "-n --name -d --description --dataset-id --force -w --workspace --api-key -h --help" -- "$cur") )
|
|
1176
1205
|
return 0
|
|
1177
1206
|
fi
|
|
1178
1207
|
case "$prev" in
|
|
1208
|
+
--api-key)
|
|
1209
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1210
|
+
return 0 ;;
|
|
1179
1211
|
esac
|
|
1180
1212
|
_postman_filematch '!*.@(json)' "$cur"
|
|
1181
1213
|
}
|
|
1182
1214
|
|
|
1183
1215
|
_postman_dataset_delete() {
|
|
1184
1216
|
if [[ "$cur" == -* ]]; then
|
|
1185
|
-
COMPREPLY=( $(compgen -W "-y --yes --keep-resources -h --help" -- "$cur") )
|
|
1217
|
+
COMPREPLY=( $(compgen -W "-y --yes --keep-resources --api-key -h --help" -- "$cur") )
|
|
1186
1218
|
return 0
|
|
1187
1219
|
fi
|
|
1188
|
-
|
|
1220
|
+
case "$prev" in
|
|
1221
|
+
--api-key)
|
|
1222
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1223
|
+
return 0 ;;
|
|
1224
|
+
esac
|
|
1189
1225
|
}
|
|
1190
1226
|
|
|
1191
1227
|
_postman_dataset_source() {
|
|
@@ -1207,41 +1243,55 @@ _postman_dataset_source() {
|
|
|
1207
1243
|
|
|
1208
1244
|
_postman_dataset_source_list() {
|
|
1209
1245
|
if [[ "$cur" == -* ]]; then
|
|
1210
|
-
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1246
|
+
COMPREPLY=( $(compgen -W "-d --dataset --api-key --json -h --help" -- "$cur") )
|
|
1211
1247
|
return 0
|
|
1212
1248
|
fi
|
|
1213
|
-
|
|
1249
|
+
case "$prev" in
|
|
1250
|
+
--api-key)
|
|
1251
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1252
|
+
return 0 ;;
|
|
1253
|
+
esac
|
|
1214
1254
|
}
|
|
1215
1255
|
|
|
1216
1256
|
_postman_dataset_source_add() {
|
|
1217
1257
|
if [[ "$cur" == -* ]]; then
|
|
1218
|
-
COMPREPLY=( $(compgen -W "-n --name --id --format --type --file --ref-only --force --url --host --port --user --password --database --table --slug -h --help" -- "$cur") )
|
|
1258
|
+
COMPREPLY=( $(compgen -W "-d --dataset -n --name --source-id --format --type --file --ref-only --force --upload --url --host --port --user --password --database --table --slug --api-key -h --help" -- "$cur") )
|
|
1219
1259
|
return 0
|
|
1220
1260
|
fi
|
|
1221
1261
|
case "$prev" in
|
|
1222
1262
|
--file)
|
|
1223
1263
|
_postman_filematch '!*.@(json)' "$cur"
|
|
1224
1264
|
return 0 ;;
|
|
1265
|
+
--api-key)
|
|
1266
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1267
|
+
return 0 ;;
|
|
1225
1268
|
esac
|
|
1226
|
-
_postman_filematch '!*.@(json)' "$cur"
|
|
1227
1269
|
}
|
|
1228
1270
|
|
|
1229
1271
|
_postman_dataset_source_remove() {
|
|
1230
1272
|
if [[ "$cur" == -* ]]; then
|
|
1231
|
-
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1273
|
+
COMPREPLY=( $(compgen -W "-d --dataset --api-key -h --help" -- "$cur") )
|
|
1232
1274
|
return 0
|
|
1233
1275
|
fi
|
|
1276
|
+
case "$prev" in
|
|
1277
|
+
--api-key)
|
|
1278
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1279
|
+
return 0 ;;
|
|
1280
|
+
esac
|
|
1234
1281
|
}
|
|
1235
1282
|
|
|
1236
1283
|
_postman_dataset_source_update() {
|
|
1237
1284
|
if [[ "$cur" == -* ]]; then
|
|
1238
|
-
COMPREPLY=( $(compgen -W "-n --name --format --file --ref-only --force --url --host --port --user --password --database --table --slug -h --help" -- "$cur") )
|
|
1285
|
+
COMPREPLY=( $(compgen -W "-d --dataset -n --name --format --file --ref-only --force --url --host --port --user --password --database --table --slug --api-key -h --help" -- "$cur") )
|
|
1239
1286
|
return 0
|
|
1240
1287
|
fi
|
|
1241
1288
|
case "$prev" in
|
|
1242
1289
|
--file)
|
|
1243
1290
|
_postman_filematch '!*.@(json)' "$cur"
|
|
1244
1291
|
return 0 ;;
|
|
1292
|
+
--api-key)
|
|
1293
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1294
|
+
return 0 ;;
|
|
1245
1295
|
esac
|
|
1246
1296
|
}
|
|
1247
1297
|
|
|
@@ -1265,44 +1315,61 @@ _postman_dataset_view() {
|
|
|
1265
1315
|
|
|
1266
1316
|
_postman_dataset_view_list() {
|
|
1267
1317
|
if [[ "$cur" == -* ]]; then
|
|
1268
|
-
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
1318
|
+
COMPREPLY=( $(compgen -W "-d --dataset --api-key --json -h --help" -- "$cur") )
|
|
1269
1319
|
return 0
|
|
1270
1320
|
fi
|
|
1271
|
-
|
|
1321
|
+
case "$prev" in
|
|
1322
|
+
--api-key)
|
|
1323
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1324
|
+
return 0 ;;
|
|
1325
|
+
esac
|
|
1272
1326
|
}
|
|
1273
1327
|
|
|
1274
1328
|
_postman_dataset_view_run() {
|
|
1275
1329
|
if [[ "$cur" == -* ]]; then
|
|
1276
|
-
COMPREPLY=( $(compgen -W "-p --param --json -h --help" -- "$cur") )
|
|
1330
|
+
COMPREPLY=( $(compgen -W "-d --dataset -p --param --api-key --json -h --help" -- "$cur") )
|
|
1277
1331
|
return 0
|
|
1278
1332
|
fi
|
|
1279
1333
|
case "$prev" in
|
|
1334
|
+
--api-key)
|
|
1335
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1336
|
+
return 0 ;;
|
|
1280
1337
|
esac
|
|
1281
1338
|
}
|
|
1282
1339
|
|
|
1283
1340
|
_postman_dataset_view_create() {
|
|
1284
1341
|
if [[ "$cur" == -* ]]; then
|
|
1285
|
-
COMPREPLY=( $(compgen -W "-n --name -q --query --id -h --help" -- "$cur") )
|
|
1342
|
+
COMPREPLY=( $(compgen -W "-d --dataset -n --name -q --query --view-id --api-key -h --help" -- "$cur") )
|
|
1286
1343
|
return 0
|
|
1287
1344
|
fi
|
|
1288
1345
|
case "$prev" in
|
|
1346
|
+
--api-key)
|
|
1347
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1348
|
+
return 0 ;;
|
|
1289
1349
|
esac
|
|
1290
|
-
_postman_filematch '!*.@(json)' "$cur"
|
|
1291
1350
|
}
|
|
1292
1351
|
|
|
1293
1352
|
_postman_dataset_view_delete() {
|
|
1294
1353
|
if [[ "$cur" == -* ]]; then
|
|
1295
|
-
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1354
|
+
COMPREPLY=( $(compgen -W "-d --dataset --api-key -h --help" -- "$cur") )
|
|
1296
1355
|
return 0
|
|
1297
1356
|
fi
|
|
1357
|
+
case "$prev" in
|
|
1358
|
+
--api-key)
|
|
1359
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1360
|
+
return 0 ;;
|
|
1361
|
+
esac
|
|
1298
1362
|
}
|
|
1299
1363
|
|
|
1300
1364
|
_postman_dataset_view_update() {
|
|
1301
1365
|
if [[ "$cur" == -* ]]; then
|
|
1302
|
-
COMPREPLY=( $(compgen -W "-n --name -q --query -h --help" -- "$cur") )
|
|
1366
|
+
COMPREPLY=( $(compgen -W "-d --dataset -n --name -q --query --api-key -h --help" -- "$cur") )
|
|
1303
1367
|
return 0
|
|
1304
1368
|
fi
|
|
1305
1369
|
case "$prev" in
|
|
1370
|
+
--api-key)
|
|
1371
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1372
|
+
return 0 ;;
|
|
1306
1373
|
esac
|
|
1307
1374
|
}
|
|
1308
1375
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Fish completion for Postman CLI (postman v1.
|
|
1
|
+
# Fish completion for Postman CLI (postman v1.46.0)
|
|
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 dataset
|
|
7
|
+
not __fish_seen_subcommand_from login logout collection api runner spec monitor workspace ws performance flows fl request sdk mock application app simulate context search webhook dataset
|
|
8
8
|
end
|
|
9
9
|
|
|
10
10
|
function __postman_using_subcommand
|
|
@@ -29,6 +29,7 @@ complete -c postman -n __postman_no_subcommand -a runner -d 'Run runners on your
|
|
|
29
29
|
complete -c postman -n __postman_no_subcommand -a spec -d 'Lint and validate Specifications from the command line'
|
|
30
30
|
complete -c postman -n __postman_no_subcommand -a monitor -d 'Invoke a monitor run and display results'
|
|
31
31
|
complete -c postman -n __postman_no_subcommand -a workspace -d 'Manage workspace resources.'
|
|
32
|
+
complete -c postman -n __postman_no_subcommand -a ws -d 'Alias for workspace'
|
|
32
33
|
complete -c postman -n __postman_no_subcommand -a performance -d 'Manage performance tests on your collections.'
|
|
33
34
|
complete -c postman -n __postman_no_subcommand -a flows -d 'Manage and interact with flows.'
|
|
34
35
|
complete -c postman -n __postman_no_subcommand -a fl -d 'Alias for flows'
|
|
@@ -82,9 +83,9 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
82
83
|
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.'
|
|
83
84
|
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
|
|
84
85
|
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
|
|
85
|
-
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
|
|
86
|
+
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 (local collection) or a cloud dataset id (cloud collection) whose view drives the iteration data. Mutually exclusive with --iteration-data. Requires --iteration-data-view.' -r
|
|
86
87
|
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
|
|
87
|
-
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
|
|
88
|
+
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. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged-in cloud session. (default: [])' -r
|
|
88
89
|
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
|
|
89
90
|
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
|
|
90
91
|
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
|
|
@@ -111,7 +112,7 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
111
112
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l cookie-jar -d 'Specify the path to a custom cookie jar (serialized tough-cookie JSON)' -r
|
|
112
113
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l export-cookie-jar -d 'Exports the cookie jar to a file after completing the run' -r
|
|
113
114
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l verbose -d 'Show detailed information of collection run and each request sent'
|
|
114
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l mock -d 'Start a mock server from manifest (.json) file' -r
|
|
115
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l mock -d 'Start a mock server from manifest (.json, .yaml or .yml) file' -r
|
|
115
116
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l simulate -d 'Start mock servers with fault-injection scenarios from a .sim.yaml file' -r
|
|
116
117
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l report-events -d 'Send run results and analytics to Postman'
|
|
117
118
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
@@ -186,9 +187,17 @@ complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_sub
|
|
|
186
187
|
complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
187
188
|
|
|
188
189
|
# ---------- workspace ----------
|
|
189
|
-
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a
|
|
190
|
-
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a
|
|
190
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push' -a list -d 'List all available Postman Workspaces'
|
|
191
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
192
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push' -a push -d 'Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
191
193
|
complete -c postman -n '__fish_seen_subcommand_from workspace' -s h -l help -d 'display help for command'
|
|
194
|
+
# ---------- workspace list ----------
|
|
195
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from list' -s f -l filter -d 'Filter workspaces by name.' -x
|
|
196
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from list' -s t -l type -d 'Filter workspaces by visibility type: team, public, private, personal.' -x
|
|
197
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from list' -l verbose -d 'Verbose output'
|
|
198
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from list' -l debug -d 'Debug output'
|
|
199
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from list' -l json -d 'JSON output'
|
|
200
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
192
201
|
# ---------- workspace prepare ----------
|
|
193
202
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -l verbose -d 'Show detailed logging'
|
|
194
203
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -s h -l help -d 'display help for command'
|
|
@@ -207,7 +216,7 @@ complete -c postman -n '__fish_seen_subcommand_from performance' -s h -l help -d
|
|
|
207
216
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s e -l environment -d 'Specify an Id to a Postman Environment' -x
|
|
208
217
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s g -l globals -d 'Specify an Id to a Postman Globals' -x
|
|
209
218
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l vu-count -d 'Number of virtual users (default: 20)' -x
|
|
210
|
-
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s d -l duration -d 'Duration of the performance test in minutes (default:
|
|
219
|
+
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s d -l duration -d 'Duration of the performance test in minutes (default: 1)' -x
|
|
211
220
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s p -l load-profile -d 'Load profile type: fixed, ramp-up, spike, peak (default: "ramp-up")' -x
|
|
212
221
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l data-file -d 'Path to a JSON or CSV data file to use with the collection' -r
|
|
213
222
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l postman-api-key -d 'API Key used to load the resources from the Postman API (Only supported in the US region, use \'postman login --region\' to authenticate instead)' -x
|
|
@@ -344,7 +353,7 @@ complete -c postman -n '__fish_seen_subcommand_from request' -l auth-apikey-in -
|
|
|
344
353
|
|
|
345
354
|
# ---------- sdk ----------
|
|
346
355
|
complete -c postman -n '__postman_using_subcommand sdk init generate build track list ls fetch get connect connections' -a init -d 'Create or update .postman/config.json with an SDK configuration stub.'
|
|
347
|
-
complete -c postman -n '__postman_using_subcommand sdk init generate build track list ls fetch get connect connections' -a generate -d 'Generate a new SDK from a Postman collection or specification.'
|
|
356
|
+
complete -c postman -n '__postman_using_subcommand sdk init generate build track list ls fetch get connect connections' -a generate -d 'Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).'
|
|
348
357
|
complete -c postman -n '__postman_using_subcommand sdk init generate build track list ls fetch get connect connections' -a build -d 'Alias for generate'
|
|
349
358
|
complete -c postman -n '__postman_using_subcommand sdk init generate build track list ls fetch get connect connections' -a track -d 'Enable change tracking for a generated SDK. Adds file hashes to .manifest.json so that the next `sdk generate` can detect your edits and preserve them via 3-way merge.'
|
|
350
359
|
complete -c postman -n '__postman_using_subcommand sdk init generate build track list ls fetch get connect connections' -a list -d 'List SDK builds for a collection, extensible collection, or specification.'
|
|
@@ -417,7 +426,7 @@ complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcomm
|
|
|
417
426
|
complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcommand_from connections; and __fish_seen_subcommand_from delete' -s h -l help -d 'display help for command'
|
|
418
427
|
|
|
419
428
|
# ---------- mock ----------
|
|
420
|
-
complete -c postman -n '__postman_using_subcommand mock run' -a run -d 'Start a local mock server given a manifest file.'
|
|
429
|
+
complete -c postman -n '__postman_using_subcommand mock run' -a run -d 'Start a local mock server given a manifest file (JSON or YAML).'
|
|
421
430
|
complete -c postman -n '__fish_seen_subcommand_from mock' -s h -l help -d 'display help for command'
|
|
422
431
|
# ---------- mock run ----------
|
|
423
432
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -s e -l environment -d 'Path to an environment file (JSON or YAML) for pm.environment' -r
|
|
@@ -514,13 +523,14 @@ complete -c postman -n '__fish_seen_subcommand_from context; and __fish_seen_sub
|
|
|
514
523
|
complete -c postman -n '__fish_seen_subcommand_from context; and __fish_seen_subcommand_from environment; and __fish_seen_subcommand_from get' -s h -l help -d 'display help for command'
|
|
515
524
|
|
|
516
525
|
# ---------- search ----------
|
|
517
|
-
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments' -a requests -d 'Search for requests by name or keyword.'
|
|
518
|
-
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments' -a collections -d 'Search for collections by name or keyword.'
|
|
519
|
-
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments' -a workspaces -d 'Search for workspaces by name or keyword.'
|
|
520
|
-
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments' -a flows -d 'Search for flows by name or keyword.'
|
|
521
|
-
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments' -a specs -d 'Search for API specs by name or keyword.'
|
|
522
|
-
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments' -a mocks -d 'Search for mocks by name or keyword.'
|
|
523
|
-
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments' -a environments -d 'Search for environments by name or keyword.'
|
|
526
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a requests -d 'Search for requests by name or keyword.'
|
|
527
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a collections -d 'Search for collections by name or keyword.'
|
|
528
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a workspaces -d 'Search for workspaces by name or keyword.'
|
|
529
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a flows -d 'Search for flows by name or keyword.'
|
|
530
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a specs -d 'Search for API specs by name or keyword.'
|
|
531
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a mocks -d 'Search for mocks by name or keyword.'
|
|
532
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a environments -d 'Search for environments by name or keyword.'
|
|
533
|
+
complete -c postman -n '__postman_using_subcommand search requests collections workspaces flows specs mocks environments documents' -a documents -d 'Search for documents by name or keyword.'
|
|
524
534
|
complete -c postman -n '__fish_seen_subcommand_from search' -l ownership -d 'Ownership: organization (or org), external, all (default: "organization")' -x
|
|
525
535
|
complete -c postman -n '__fish_seen_subcommand_from search' -s n -l limit -d 'Max results per page. Max allowed limit: 25 (default: 10)' -x
|
|
526
536
|
complete -c postman -n '__fish_seen_subcommand_from search' -l cursor -d 'Cursor for pagination' -x
|
|
@@ -542,6 +552,8 @@ complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subc
|
|
|
542
552
|
complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subcommand_from mocks' -s h -l help -d 'display help for command'
|
|
543
553
|
# ---------- search environments ----------
|
|
544
554
|
complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subcommand_from environments' -s h -l help -d 'display help for command'
|
|
555
|
+
# ---------- search documents ----------
|
|
556
|
+
complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subcommand_from documents' -s h -l help -d 'display help for command'
|
|
545
557
|
|
|
546
558
|
# ---------- webhook ----------
|
|
547
559
|
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a create -d 'Create a new webhook and print its public URL.'
|
|
@@ -602,71 +614,82 @@ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_sub
|
|
|
602
614
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -s h -l help -d 'display help for command'
|
|
603
615
|
|
|
604
616
|
# ---------- dataset ----------
|
|
605
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a list -d '[BETA] List dataset YAMLs under
|
|
606
|
-
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.'
|
|
607
|
-
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.'
|
|
608
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a create -d '[BETA] Scaffold a new
|
|
609
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a delete -d '[BETA] Permanently remove a dataset
|
|
617
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a list -d '[BETA] List local dataset YAMLs under a path, or (no path) a workspace\'s cloud datasets.'
|
|
618
|
+
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 (local YAML path or cloud id).'
|
|
619
|
+
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 (local YAML path or cloud id).'
|
|
620
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a create -d '[BETA] Scaffold a new .dataset.yaml at <path>, or (no path, with -w) create a cloud dataset.'
|
|
621
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a delete -d '[BETA] Permanently remove a dataset: a local .dataset.yaml (+ .resources/) or a cloud dataset id.'
|
|
610
622
|
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.'
|
|
611
623
|
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.'
|
|
612
624
|
complete -c postman -n '__fish_seen_subcommand_from dataset' -s h -l help -d 'display help for command'
|
|
613
625
|
# ---------- dataset list ----------
|
|
626
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from list' -s w -l workspace -d 'Postman workspace ID (cloud list)' -x
|
|
627
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from list' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
614
628
|
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'
|
|
615
629
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
616
630
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from list' -r -k -a '(__fish_complete_suffix .json)'
|
|
617
631
|
# ---------- dataset get ----------
|
|
618
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -l
|
|
632
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
633
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -l no-populate -d 'Skip fetching datasources/views for a cloud dataset'
|
|
634
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -l json -d 'Output the full dataset as JSON'
|
|
619
635
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -s h -l help -d 'display help for command'
|
|
620
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -r -k -a '(__fish_complete_suffix .json)'
|
|
621
636
|
# ---------- dataset query ----------
|
|
622
637
|
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
|
|
623
638
|
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
|
|
639
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
624
640
|
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'
|
|
625
641
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s h -l help -d 'display help for command'
|
|
626
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -r -k -a '(__fish_complete_suffix .json)'
|
|
627
642
|
# ---------- dataset create ----------
|
|
628
643
|
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
|
|
629
644
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -s d -l description -d 'Optional description' -x
|
|
630
|
-
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
|
|
645
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -l dataset-id -d 'Override the generated dataset id (local only; defaults to a random v4 UUID)' -x
|
|
631
646
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -l force -d 'Overwrite an existing file at <path>'
|
|
647
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -s w -l workspace -d 'Postman workspace ID (create a cloud dataset)' -x
|
|
648
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
632
649
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -s h -l help -d 'display help for command'
|
|
633
650
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -r -k -a '(__fish_complete_suffix .json)'
|
|
634
651
|
# ---------- dataset delete ----------
|
|
635
652
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -s y -l yes -d 'Skip the confirmation prompt'
|
|
636
|
-
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'
|
|
653
|
+
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 (local only)'
|
|
654
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
637
655
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -s h -l help -d 'display help for command'
|
|
638
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -r -k -a '(__fish_complete_suffix .json)'
|
|
639
656
|
# ---------- dataset source ----------
|
|
640
|
-
complete -c postman -n '__postman_using_subcommand source list add remove update' -a list -d '[BETA] List the datasources defined on a dataset.'
|
|
657
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a list -d '[BETA] List the datasources defined on a dataset (local YAML path or cloud id).'
|
|
641
658
|
complete -c postman -n '__postman_using_subcommand source list add remove update' -a add -d '[BETA] Add a datasource to a dataset.'
|
|
642
|
-
complete -c postman -n '__postman_using_subcommand source list add remove update' -a remove -d '[BETA] Remove a datasource from a dataset.'
|
|
659
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a remove -d '[BETA] Remove a datasource from a dataset (local YAML path or cloud id).'
|
|
643
660
|
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.'
|
|
644
661
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source' -s h -l help -d 'display help for command'
|
|
645
662
|
# ---------- dataset source list ----------
|
|
663
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from list' -s d -l dataset -d 'Dataset whose sources to list — a local .dataset.yaml path or a cloud dataset id' -x
|
|
664
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from list' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
646
665
|
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'
|
|
647
666
|
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'
|
|
648
|
-
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)'
|
|
649
667
|
# ---------- dataset source add ----------
|
|
668
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -s d -l dataset -d 'Dataset to add the source to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
650
669
|
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
|
|
651
|
-
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
|
|
670
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l source-id -d 'Override the generated source id' -x
|
|
652
671
|
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
|
|
653
672
|
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
|
|
654
673
|
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
|
|
655
|
-
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'
|
|
656
|
-
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'
|
|
674
|
+
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 (local dataset)'
|
|
675
|
+
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 (local dataset)'
|
|
676
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l upload -d 'Cloud dataset only: upload --file as a postmancloudfile source (runs via /exec). Without --upload, --file is registered as a local_filesystem csv/json source read by the local engine.'
|
|
657
677
|
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
|
|
658
678
|
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
|
|
659
679
|
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
|
|
660
680
|
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
|
|
661
|
-
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
|
|
681
|
+
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: passing it here exposes it in `ps` output and shell history, and it is stored as plaintext in the dataset YAML (local) or sent in the request body (cloud). Prefer a restricted DB user; secure input (prompt / stdin / env) is planned.' -x
|
|
662
682
|
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
|
|
663
683
|
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
|
|
664
684
|
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
|
|
685
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
665
686
|
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'
|
|
666
|
-
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)'
|
|
667
687
|
# ---------- dataset source remove ----------
|
|
688
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from remove' -s d -l dataset -d 'Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
689
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from remove' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
668
690
|
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'
|
|
669
691
|
# ---------- dataset source update ----------
|
|
692
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -s d -l dataset -d 'Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
670
693
|
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
|
|
671
694
|
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
|
|
672
695
|
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
|
|
@@ -676,35 +699,44 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
676
699
|
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
|
|
677
700
|
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
|
|
678
701
|
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
|
|
679
|
-
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
|
|
702
|
+
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: passing it here exposes it in `ps` output and shell history, and it is stored as plaintext in the dataset YAML (local) or sent in the request body (cloud). Prefer a restricted DB user; secure input (prompt / stdin / env) is planned.' -x
|
|
680
703
|
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
|
|
681
704
|
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
|
|
682
705
|
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
|
|
706
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
683
707
|
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'
|
|
684
708
|
# ---------- dataset view ----------
|
|
685
|
-
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.'
|
|
709
|
+
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 (local YAML path or cloud id).'
|
|
686
710
|
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.'
|
|
687
|
-
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a create -d '[BETA] Add a saved view to a dataset.'
|
|
688
|
-
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a delete -d '[BETA] Remove a saved view from a dataset.'
|
|
689
|
-
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.'
|
|
711
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a create -d '[BETA] Add a saved view to a dataset (local YAML path or cloud id).'
|
|
712
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a delete -d '[BETA] Remove a saved view from a dataset (local YAML path or cloud id).'
|
|
713
|
+
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 (local YAML path or cloud id).'
|
|
690
714
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view' -s h -l help -d 'display help for command'
|
|
691
715
|
# ---------- dataset view list ----------
|
|
716
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from list' -s d -l dataset -d 'Dataset whose views to list — a local .dataset.yaml path or a cloud dataset id' -x
|
|
717
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from list' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
692
718
|
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'
|
|
693
719
|
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'
|
|
694
|
-
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)'
|
|
695
720
|
# ---------- dataset view run ----------
|
|
721
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from run' -s d -l dataset -d 'Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
696
722
|
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
|
|
723
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from run' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
697
724
|
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'
|
|
698
725
|
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'
|
|
699
726
|
# ---------- dataset view create ----------
|
|
727
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -s d -l dataset -d 'Dataset to add the view to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
700
728
|
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
|
|
701
729
|
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
|
|
702
|
-
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
|
|
730
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -l view-id -d 'Override the generated view id (local only; cloud assigns its own)' -x
|
|
731
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from create' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
703
732
|
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'
|
|
704
|
-
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)'
|
|
705
733
|
# ---------- dataset view delete ----------
|
|
734
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from delete' -s d -l dataset -d 'Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
735
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from delete' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
706
736
|
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'
|
|
707
737
|
# ---------- dataset view update ----------
|
|
738
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from update' -s d -l dataset -d 'Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
708
739
|
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
|
|
709
740
|
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
|
|
741
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from update' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
710
742
|
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.46.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
|
|
@@ -27,7 +27,7 @@ _postman() {
|
|
|
27
27
|
runner) _postman_runner ;;
|
|
28
28
|
spec) _postman_spec ;;
|
|
29
29
|
monitor) _postman_monitor ;;
|
|
30
|
-
workspace) _postman_workspace ;;
|
|
30
|
+
workspace|ws) _postman_workspace ;;
|
|
31
31
|
performance) _postman_performance ;;
|
|
32
32
|
flows|fl) _postman_flows ;;
|
|
33
33
|
request) _postman_request ;;
|
|
@@ -55,6 +55,7 @@ _postman_commands() {
|
|
|
55
55
|
'spec:Lint and validate Specifications from the command line'
|
|
56
56
|
'monitor:Invoke a monitor run and display results'
|
|
57
57
|
'workspace:Manage workspace resources.'
|
|
58
|
+
'ws:Alias for workspace'
|
|
58
59
|
'performance:Manage performance tests on your collections.'
|
|
59
60
|
'flows:Manage and interact with flows.'
|
|
60
61
|
'fl:Alias for flows'
|
|
@@ -149,9 +150,9 @@ _postman_collection_run() {
|
|
|
149
150
|
'--reporter-json-structure[\[Optional\] Generate JSON report using the Newman schema. By default, JSON reports use the native structure of Postman CLI.]' \
|
|
150
151
|
'(-n --iteration-count)'{-n,--iteration-count}'[Define the number of iterations to run]:n' \
|
|
151
152
|
'(-d --iteration-data)'{-d,--iteration-data}'[Specify a data file to use for iterations (either JSON or CSV)]:path:_files -g "*.(json|csv)"' \
|
|
152
|
-
'--iteration-data-dataset[\[BETA\] Path to a .dataset.yaml whose view drives the iteration data. Mutually exclusive with --iteration-data. Requires --iteration-data-view.]:
|
|
153
|
+
'--iteration-data-dataset[\[BETA\] Path to a .dataset.yaml (local collection) or a cloud dataset id (cloud collection) whose view drives the iteration data. Mutually exclusive with --iteration-data. Requires --iteration-data-view.]:pathOrId:_files -g "*.(json|csv)"' \
|
|
153
154
|
'--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' \
|
|
154
|
-
'--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"' \
|
|
155
|
+
'--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. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY\: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged-in cloud session. (default\: \[\])]:pathOrDir:_files -g "*.json"' \
|
|
155
156
|
'-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' \
|
|
156
157
|
'--global-var[Allows the specification of global variables via the command line, in a key=value format]:value' \
|
|
157
158
|
'--env-var[Allows the specification of environment variables via the command line, in a key=value format (default\: \[\])]:value' \
|
|
@@ -178,7 +179,7 @@ _postman_collection_run() {
|
|
|
178
179
|
'--cookie-jar[Specify the path to a custom cookie jar (serialized tough-cookie JSON)]:path:_files -g "*.json"' \
|
|
179
180
|
'--export-cookie-jar[Exports the cookie jar to a file after completing the run]:path:_files -g "*.json"' \
|
|
180
181
|
'--verbose[Show detailed information of collection run and each request sent]' \
|
|
181
|
-
'--mock[Start a mock server from manifest (.json) file]:path:_files -g "*.json"' \
|
|
182
|
+
'--mock[Start a mock server from manifest (.json, .yaml or .yml) file]:path:_files -g "*.json"' \
|
|
182
183
|
'--simulate[Start mock servers with fault-injection scenarios from a .sim.yaml file]:path:_files -g "*.(sim.yaml|yaml|yml)"' \
|
|
183
184
|
'--report-events[Send run results and analytics to Postman]' \
|
|
184
185
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
@@ -368,6 +369,7 @@ _postman_workspace() {
|
|
|
368
369
|
case $state in
|
|
369
370
|
args)
|
|
370
371
|
case $words[1] in
|
|
372
|
+
list) _postman_workspace_list ;;
|
|
371
373
|
prepare) _postman_workspace_prepare ;;
|
|
372
374
|
push) _postman_workspace_push ;;
|
|
373
375
|
esac
|
|
@@ -378,12 +380,23 @@ _postman_workspace() {
|
|
|
378
380
|
_postman_workspace_commands() {
|
|
379
381
|
local -a sub
|
|
380
382
|
sub=(
|
|
383
|
+
'list:List all available Postman Workspaces'
|
|
381
384
|
'prepare:Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
382
385
|
'push:Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
383
386
|
)
|
|
384
387
|
_describe -t commands 'workspace command' sub
|
|
385
388
|
}
|
|
386
389
|
|
|
390
|
+
_postman_workspace_list() {
|
|
391
|
+
_arguments \
|
|
392
|
+
'(-f --filter)'{-f,--filter}'[Filter workspaces by name.]:name' \
|
|
393
|
+
'(-t --type)'{-t,--type}'[Filter workspaces by visibility type\: team, public, private, personal.]:type' \
|
|
394
|
+
'--verbose[Verbose output]' \
|
|
395
|
+
'--debug[Debug output]' \
|
|
396
|
+
'--json[JSON output]' \
|
|
397
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
398
|
+
}
|
|
399
|
+
|
|
387
400
|
_postman_workspace_prepare() {
|
|
388
401
|
_arguments \
|
|
389
402
|
'--verbose[Show detailed logging]' \
|
|
@@ -429,7 +442,7 @@ _postman_performance_run() {
|
|
|
429
442
|
'(-e --environment)'{-e,--environment}'[Specify an Id to a Postman Environment]:id' \
|
|
430
443
|
'(-g --globals)'{-g,--globals}'[Specify an Id to a Postman Globals]:id' \
|
|
431
444
|
'--vu-count[Number of virtual users (default\: 20)]:count' \
|
|
432
|
-
'(-d --duration)'{-d,--duration}'[Duration of the performance test in minutes (default\:
|
|
445
|
+
'(-d --duration)'{-d,--duration}'[Duration of the performance test in minutes (default\: 1)]:minutes' \
|
|
433
446
|
'(-p --load-profile)'{-p,--load-profile}'[Load profile type\: fixed, ramp-up, spike, peak (default\: "ramp-up")]:profile' \
|
|
434
447
|
'--data-file[Path to a JSON or CSV data file to use with the collection]:path:_files -g "*.json"' \
|
|
435
448
|
'--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' \
|
|
@@ -644,7 +657,7 @@ _postman_sdk_commands() {
|
|
|
644
657
|
local -a sub
|
|
645
658
|
sub=(
|
|
646
659
|
'init:Create or update .postman/config.json with an SDK configuration stub.'
|
|
647
|
-
'generate:Generate a new SDK from a Postman collection or specification.'
|
|
660
|
+
'generate:Generate a new SDK from a Postman collection or specification (OpenAPI or AsyncAPI).'
|
|
648
661
|
'build:Alias for generate'
|
|
649
662
|
'track:Enable change tracking for a generated SDK. Adds file hashes to .manifest.json so that the next `sdk generate` can detect your edits and preserve them via 3-way merge.'
|
|
650
663
|
'list:List SDK builds for a collection, extensible collection, or specification.'
|
|
@@ -789,7 +802,7 @@ _postman_mock() {
|
|
|
789
802
|
_postman_mock_commands() {
|
|
790
803
|
local -a sub
|
|
791
804
|
sub=(
|
|
792
|
-
'run:Start a local mock server given a manifest file.'
|
|
805
|
+
'run:Start a local mock server given a manifest file (JSON or YAML).'
|
|
793
806
|
)
|
|
794
807
|
_describe -t commands 'mock command' sub
|
|
795
808
|
}
|
|
@@ -1142,6 +1155,7 @@ _postman_search() {
|
|
|
1142
1155
|
specs) _postman_search_specs ;;
|
|
1143
1156
|
mocks) _postman_search_mocks ;;
|
|
1144
1157
|
environments) _postman_search_environments ;;
|
|
1158
|
+
documents) _postman_search_documents ;;
|
|
1145
1159
|
esac
|
|
1146
1160
|
;;
|
|
1147
1161
|
esac
|
|
@@ -1157,6 +1171,7 @@ _postman_search_commands() {
|
|
|
1157
1171
|
'specs:Search for API specs by name or keyword.'
|
|
1158
1172
|
'mocks:Search for mocks by name or keyword.'
|
|
1159
1173
|
'environments:Search for environments by name or keyword.'
|
|
1174
|
+
'documents:Search for documents by name or keyword.'
|
|
1160
1175
|
)
|
|
1161
1176
|
_describe -t commands 'search command' sub
|
|
1162
1177
|
}
|
|
@@ -1203,6 +1218,12 @@ _postman_search_environments() {
|
|
|
1203
1218
|
'*:query:'
|
|
1204
1219
|
}
|
|
1205
1220
|
|
|
1221
|
+
_postman_search_documents() {
|
|
1222
|
+
_arguments \
|
|
1223
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1224
|
+
'*:query:'
|
|
1225
|
+
}
|
|
1226
|
+
|
|
1206
1227
|
_postman_webhook() {
|
|
1207
1228
|
local context state state_descr line
|
|
1208
1229
|
typeset -A opt_args
|
|
@@ -1374,11 +1395,11 @@ _postman_dataset() {
|
|
|
1374
1395
|
_postman_dataset_commands() {
|
|
1375
1396
|
local -a sub
|
|
1376
1397
|
sub=(
|
|
1377
|
-
'list:\[BETA\] List dataset YAMLs under
|
|
1378
|
-
'get:\[BETA\] Print a dataset'\''s metadata and structure summary.'
|
|
1379
|
-
'query:\[BETA\] Run an ad-hoc SQL query against a dataset.'
|
|
1380
|
-
'create:\[BETA\] Scaffold a new
|
|
1381
|
-
'delete:\[BETA\] Permanently remove a dataset
|
|
1398
|
+
'list:\[BETA\] List local dataset YAMLs under a path, or (no path) a workspace'\''s cloud datasets.'
|
|
1399
|
+
'get:\[BETA\] Print a dataset'\''s metadata and structure summary (local YAML path or cloud id).'
|
|
1400
|
+
'query:\[BETA\] Run an ad-hoc SQL query against a dataset (local YAML path or cloud id).'
|
|
1401
|
+
'create:\[BETA\] Scaffold a new .dataset.yaml at <path>, or (no path, with -w) create a cloud dataset.'
|
|
1402
|
+
'delete:\[BETA\] Permanently remove a dataset\: a local .dataset.yaml (+ .resources/) or a cloud dataset id.'
|
|
1382
1403
|
'source:\[BETA\] Inspect and manage a dataset'\''s datasources.'
|
|
1383
1404
|
'view:\[BETA\] Inspect and manage saved views on a dataset.'
|
|
1384
1405
|
)
|
|
@@ -1387,6 +1408,8 @@ _postman_dataset_commands() {
|
|
|
1387
1408
|
|
|
1388
1409
|
_postman_dataset_list() {
|
|
1389
1410
|
_arguments \
|
|
1411
|
+
'(-w --workspace)'{-w,--workspace}'[Postman workspace ID (cloud list)]:id' \
|
|
1412
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1390
1413
|
'--json[Output as JSON instead of a table]' \
|
|
1391
1414
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1392
1415
|
'*:pathOrDir:_files -g "*.json"'
|
|
@@ -1394,26 +1417,31 @@ _postman_dataset_list() {
|
|
|
1394
1417
|
|
|
1395
1418
|
_postman_dataset_get() {
|
|
1396
1419
|
_arguments \
|
|
1397
|
-
'--
|
|
1420
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1421
|
+
'--no-populate[Skip fetching datasources/views for a cloud dataset]' \
|
|
1422
|
+
'--json[Output the full dataset as JSON]' \
|
|
1398
1423
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1399
|
-
'*:
|
|
1424
|
+
'*:datasetPathOrId:'
|
|
1400
1425
|
}
|
|
1401
1426
|
|
|
1402
1427
|
_postman_dataset_query() {
|
|
1403
1428
|
_arguments \
|
|
1404
1429
|
'(-q --query)'{-q,--query}'[SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")]:sql' \
|
|
1405
1430
|
'(-p --param)'{-p,--param}'[Positional parameter values for $1, $2, ... bindings; repeatable]:value...' \
|
|
1431
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1406
1432
|
'--json[Output rows as JSON instead of a table]' \
|
|
1407
1433
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1408
|
-
'*:
|
|
1434
|
+
'*:datasetPathOrId:'
|
|
1409
1435
|
}
|
|
1410
1436
|
|
|
1411
1437
|
_postman_dataset_create() {
|
|
1412
1438
|
_arguments \
|
|
1413
1439
|
'(-n --name)'{-n,--name}'[Human-readable name for the dataset]:name' \
|
|
1414
1440
|
'(-d --description)'{-d,--description}'[Optional description]:desc' \
|
|
1415
|
-
'--id[Override the generated dataset id (defaults to a random v4 UUID)]:uuid' \
|
|
1441
|
+
'--dataset-id[Override the generated dataset id (local only; defaults to a random v4 UUID)]:uuid' \
|
|
1416
1442
|
'--force[Overwrite an existing file at <path>]' \
|
|
1443
|
+
'(-w --workspace)'{-w,--workspace}'[Postman workspace ID (create a cloud dataset)]:id' \
|
|
1444
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1417
1445
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1418
1446
|
'*:path:_files -g "*.json"'
|
|
1419
1447
|
}
|
|
@@ -1421,9 +1449,10 @@ _postman_dataset_create() {
|
|
|
1421
1449
|
_postman_dataset_delete() {
|
|
1422
1450
|
_arguments \
|
|
1423
1451
|
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt]' \
|
|
1424
|
-
'--keep-resources[Delete only the YAML file; leave the .resources/ directory intact]' \
|
|
1452
|
+
'--keep-resources[Delete only the YAML file; leave the .resources/ directory intact (local only)]' \
|
|
1453
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1425
1454
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1426
|
-
'*:
|
|
1455
|
+
'*:datasetPathOrId:'
|
|
1427
1456
|
}
|
|
1428
1457
|
|
|
1429
1458
|
_postman_dataset_source() {
|
|
@@ -1448,9 +1477,9 @@ _postman_dataset_source() {
|
|
|
1448
1477
|
_postman_dataset_source_commands() {
|
|
1449
1478
|
local -a sub
|
|
1450
1479
|
sub=(
|
|
1451
|
-
'list:\[BETA\] List the datasources defined on a dataset.'
|
|
1480
|
+
'list:\[BETA\] List the datasources defined on a dataset (local YAML path or cloud id).'
|
|
1452
1481
|
'add:\[BETA\] Add a datasource to a dataset.'
|
|
1453
|
-
'remove:\[BETA\] Remove a datasource from a dataset.'
|
|
1482
|
+
'remove:\[BETA\] Remove a datasource from a dataset (local YAML path or cloud id).'
|
|
1454
1483
|
'update:\[BETA\] Update fields on an existing datasource. Only the flags you provide are changed.'
|
|
1455
1484
|
)
|
|
1456
1485
|
_describe -t commands 'source command' sub
|
|
@@ -1458,40 +1487,46 @@ _postman_dataset_source_commands() {
|
|
|
1458
1487
|
|
|
1459
1488
|
_postman_dataset_source_list() {
|
|
1460
1489
|
_arguments \
|
|
1490
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset whose sources to list — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1491
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1461
1492
|
'--json[Output sources as JSON instead of a table]' \
|
|
1462
|
-
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1463
|
-
'*:path:_files -g "*.json"'
|
|
1493
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1464
1494
|
}
|
|
1465
1495
|
|
|
1466
1496
|
_postman_dataset_source_add() {
|
|
1467
1497
|
_arguments \
|
|
1498
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset to add the source to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1468
1499
|
'(-n --name)'{-n,--name}'[Logical name for the source (becomes the SQL table name)]:name' \
|
|
1469
|
-
'--id[Override the generated source id]:uuid' \
|
|
1500
|
+
'--source-id[Override the generated source id]:uuid' \
|
|
1470
1501
|
'--format[Override the inferred format]:csv|json|mysql|postgres' \
|
|
1471
1502
|
'--type[Source kind; inferred from --file/--url when omitted]:local|remote-url|mysql|postgresql' \
|
|
1472
1503
|
'--file[Path to a local CSV/JSON file (absolute or cwd-relative)]:path:_files -g "*.json"' \
|
|
1473
|
-
'--ref-only[Reference the file in place; do NOT copy into data_dir]' \
|
|
1474
|
-
'--force[When copying, overwrite an existing file at the destination]' \
|
|
1504
|
+
'--ref-only[Reference the file in place; do NOT copy into data_dir (local dataset)]' \
|
|
1505
|
+
'--force[When copying, overwrite an existing file at the destination (local dataset)]' \
|
|
1506
|
+
'--upload[Cloud dataset only\: upload --file as a postmancloudfile source (runs via /exec). Without --upload, --file is registered as a local_filesystem csv/json source read by the local engine.]' \
|
|
1475
1507
|
'--url[HTTP(S) URL to a remote CSV/JSON file]:url' \
|
|
1476
1508
|
'--host[DB host (mysql/postgresql)]:host' \
|
|
1477
1509
|
'--port[DB port]:port' \
|
|
1478
1510
|
'--user[DB user (warning\: stored as plaintext in the YAML).]:user' \
|
|
1479
|
-
'--password[DB password
|
|
1511
|
+
'--password[DB password. WARNING\: passing it here exposes it in `ps` output and shell history, and it is stored as plaintext in the dataset YAML (local) or sent in the request body (cloud). Prefer a restricted DB user; secure input (prompt / stdin / env) is planned.]:password' \
|
|
1480
1512
|
'--database[DB database name]:db' \
|
|
1481
1513
|
'--table[DB table name (optional)]:table' \
|
|
1482
1514
|
'--slug[Optional slug for the source]:slug' \
|
|
1483
|
-
'
|
|
1484
|
-
'
|
|
1515
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1516
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1485
1517
|
}
|
|
1486
1518
|
|
|
1487
1519
|
_postman_dataset_source_remove() {
|
|
1488
1520
|
_arguments \
|
|
1521
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1522
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1489
1523
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1490
1524
|
'*:sourceNameOrId:'
|
|
1491
1525
|
}
|
|
1492
1526
|
|
|
1493
1527
|
_postman_dataset_source_update() {
|
|
1494
1528
|
_arguments \
|
|
1529
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1495
1530
|
'(-n --name)'{-n,--name}'[Rename the source]:name' \
|
|
1496
1531
|
'--format[Change the format]:csv|json|mysql|postgres' \
|
|
1497
1532
|
'--file[Replace the source'\''s file (local-filesystem only)]:path:_files -g "*.json"' \
|
|
@@ -1501,10 +1536,11 @@ _postman_dataset_source_update() {
|
|
|
1501
1536
|
'--host[Update DB host (mysql/postgresql)]:host' \
|
|
1502
1537
|
'--port[Update DB port]:port' \
|
|
1503
1538
|
'--user[Update DB user (warning\: stored as plaintext in the YAML).]:user' \
|
|
1504
|
-
'--password[Update DB password
|
|
1539
|
+
'--password[Update DB password. WARNING\: passing it here exposes it in `ps` output and shell history, and it is stored as plaintext in the dataset YAML (local) or sent in the request body (cloud). Prefer a restricted DB user; secure input (prompt / stdin / env) is planned.]:password' \
|
|
1505
1540
|
'--database[Update DB database name]:db' \
|
|
1506
1541
|
'--table[Update DB table name]:table' \
|
|
1507
1542
|
'--slug[Update slug]:slug' \
|
|
1543
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1508
1544
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1509
1545
|
'*:sourceNameOrId:'
|
|
1510
1546
|
}
|
|
@@ -1532,25 +1568,28 @@ _postman_dataset_view() {
|
|
|
1532
1568
|
_postman_dataset_view_commands() {
|
|
1533
1569
|
local -a sub
|
|
1534
1570
|
sub=(
|
|
1535
|
-
'list:\[BETA\] List the saved views defined on a dataset.'
|
|
1571
|
+
'list:\[BETA\] List the saved views defined on a dataset (local YAML path or cloud id).'
|
|
1536
1572
|
'run:\[BETA\] Execute a saved view against a dataset and print the rows.'
|
|
1537
|
-
'create:\[BETA\] Add a saved view to a dataset.'
|
|
1538
|
-
'delete:\[BETA\] Remove a saved view from a dataset.'
|
|
1539
|
-
'update:\[BETA\] Update name and/or query on an existing view.'
|
|
1573
|
+
'create:\[BETA\] Add a saved view to a dataset (local YAML path or cloud id).'
|
|
1574
|
+
'delete:\[BETA\] Remove a saved view from a dataset (local YAML path or cloud id).'
|
|
1575
|
+
'update:\[BETA\] Update name and/or query on an existing view (local YAML path or cloud id).'
|
|
1540
1576
|
)
|
|
1541
1577
|
_describe -t commands 'view command' sub
|
|
1542
1578
|
}
|
|
1543
1579
|
|
|
1544
1580
|
_postman_dataset_view_list() {
|
|
1545
1581
|
_arguments \
|
|
1582
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset whose views to list — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1583
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1546
1584
|
'--json[Output views as JSON instead of a table]' \
|
|
1547
|
-
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1548
|
-
'*:path:_files -g "*.json"'
|
|
1585
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1549
1586
|
}
|
|
1550
1587
|
|
|
1551
1588
|
_postman_dataset_view_run() {
|
|
1552
1589
|
_arguments \
|
|
1590
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1553
1591
|
'(-p --param)'{-p,--param}'[Positional parameter values for $1, $2, ... bindings; repeatable]:value...' \
|
|
1592
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1554
1593
|
'--json[Output rows as JSON instead of a table]' \
|
|
1555
1594
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1556
1595
|
'*:viewNameOrId:'
|
|
@@ -1558,23 +1597,28 @@ _postman_dataset_view_run() {
|
|
|
1558
1597
|
|
|
1559
1598
|
_postman_dataset_view_create() {
|
|
1560
1599
|
_arguments \
|
|
1600
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset to add the view to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1561
1601
|
'(-n --name)'{-n,--name}'[View name]:name' \
|
|
1562
1602
|
'(-q --query)'{-q,--query}'[SQL query the view executes]:sql' \
|
|
1563
|
-
'--id[Override the generated view id]:uuid' \
|
|
1564
|
-
'
|
|
1565
|
-
'
|
|
1603
|
+
'--view-id[Override the generated view id (local only; cloud assigns its own)]:uuid' \
|
|
1604
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1605
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1566
1606
|
}
|
|
1567
1607
|
|
|
1568
1608
|
_postman_dataset_view_delete() {
|
|
1569
1609
|
_arguments \
|
|
1610
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1611
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1570
1612
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1571
1613
|
'*:viewNameOrId:'
|
|
1572
1614
|
}
|
|
1573
1615
|
|
|
1574
1616
|
_postman_dataset_view_update() {
|
|
1575
1617
|
_arguments \
|
|
1618
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1576
1619
|
'(-n --name)'{-n,--name}'[New view name]:name' \
|
|
1577
1620
|
'(-q --query)'{-q,--query}'[New SQL query]:sql' \
|
|
1621
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1578
1622
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1579
1623
|
'*:viewNameOrId:'
|
|
1580
1624
|
}
|