postman-cli-completion 1.49.0 → 1.51.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/README.md +2 -0
- package/completions/bash/postman.bash +83 -11
- package/completions/fish/postman.fish +90 -31
- package/completions/zsh/_postman +112 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Bash completion for Postman CLI (postman v1.
|
|
1
|
+
# Bash completion for Postman CLI (postman v1.51.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
|
|
@@ -382,7 +382,7 @@ _postman_workspace() {
|
|
|
382
382
|
if [[ "$cur" == -* ]]; then
|
|
383
383
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
384
384
|
else
|
|
385
|
-
COMPREPLY=( $(compgen -W "list prepare push lint" -- "$cur") )
|
|
385
|
+
COMPREPLY=( $(compgen -W "list prepare push lint pull connect-git" -- "$cur") )
|
|
386
386
|
fi
|
|
387
387
|
return 0
|
|
388
388
|
fi
|
|
@@ -391,6 +391,8 @@ _postman_workspace() {
|
|
|
391
391
|
prepare) _postman_workspace_prepare ;;
|
|
392
392
|
push) _postman_workspace_push ;;
|
|
393
393
|
lint) _postman_workspace_lint ;;
|
|
394
|
+
pull) _postman_workspace_pull ;;
|
|
395
|
+
connect-git) _postman_workspace_connect_git ;;
|
|
394
396
|
esac
|
|
395
397
|
}
|
|
396
398
|
|
|
@@ -421,13 +423,30 @@ _postman_workspace_push() {
|
|
|
421
423
|
|
|
422
424
|
_postman_workspace_lint() {
|
|
423
425
|
if [[ "$cur" == -* ]]; then
|
|
424
|
-
COMPREPLY=( $(compgen -W "-f --fail-severity -o --output --meta --workspace-id -h --help" -- "$cur") )
|
|
426
|
+
COMPREPLY=( $(compgen -W "-f --fail-severity -o --output --meta --workspace-id --fix -h --help" -- "$cur") )
|
|
425
427
|
return 0
|
|
426
428
|
fi
|
|
427
429
|
case "$prev" in
|
|
428
430
|
esac
|
|
429
431
|
}
|
|
430
432
|
|
|
433
|
+
_postman_workspace_pull() {
|
|
434
|
+
if [[ "$cur" == -* ]]; then
|
|
435
|
+
COMPREPLY=( $(compgen -W "-y --yes --source-workspace --verbose -h --help" -- "$cur") )
|
|
436
|
+
return 0
|
|
437
|
+
fi
|
|
438
|
+
case "$prev" in
|
|
439
|
+
esac
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
_postman_workspace_connect_git() {
|
|
443
|
+
if [[ "$cur" == -* ]]; then
|
|
444
|
+
COMPREPLY=( $(compgen -W "--verbose -h --help" -- "$cur") )
|
|
445
|
+
return 0
|
|
446
|
+
fi
|
|
447
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
448
|
+
}
|
|
449
|
+
|
|
431
450
|
_postman_performance() {
|
|
432
451
|
if [[ -z "$subcmd" ]]; then
|
|
433
452
|
if [[ "$cur" == -* ]]; then
|
|
@@ -444,7 +463,7 @@ _postman_performance() {
|
|
|
444
463
|
|
|
445
464
|
_postman_performance_run() {
|
|
446
465
|
if [[ "$cur" == -* ]]; then
|
|
447
|
-
COMPREPLY=( $(compgen -W "-e --environment -g --globals --vu-count -d --duration -p --load-profile --data-file --dataset-id --dataset-view-id --dataset-distribution --postman-api-key --pass-if -h --help" -- "$cur") )
|
|
466
|
+
COMPREPLY=( $(compgen -W "-e --environment -g --globals --vu-count -d --duration -p --load-profile --data-file --dataset-id --dataset-view-id --dataset-distribution --postman-api-key --runner --pass-if -h --help" -- "$cur") )
|
|
448
467
|
return 0
|
|
449
468
|
fi
|
|
450
469
|
case "$prev" in
|
|
@@ -705,19 +724,22 @@ _postman_mock() {
|
|
|
705
724
|
if [[ "$cur" == -* ]]; then
|
|
706
725
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
707
726
|
else
|
|
708
|
-
COMPREPLY=( $(compgen -W "generate run" -- "$cur") )
|
|
727
|
+
COMPREPLY=( $(compgen -W "generate run get list delete" -- "$cur") )
|
|
709
728
|
fi
|
|
710
729
|
return 0
|
|
711
730
|
fi
|
|
712
731
|
case "$subcmd" in
|
|
713
732
|
generate) _postman_mock_generate ;;
|
|
714
733
|
run) _postman_mock_run ;;
|
|
734
|
+
get) _postman_mock_get ;;
|
|
735
|
+
list) _postman_mock_list ;;
|
|
736
|
+
delete) _postman_mock_delete ;;
|
|
715
737
|
esac
|
|
716
738
|
}
|
|
717
739
|
|
|
718
740
|
_postman_mock_generate() {
|
|
719
741
|
if [[ "$cur" == -* ]]; then
|
|
720
|
-
COMPREPLY=( $(compgen -W "-o --output --name --port --force -u --update -x --suppress-exit-code -h --help" -- "$cur") )
|
|
742
|
+
COMPREPLY=( $(compgen -W "-o --output -n --name --port --force -u --update -x --suppress-exit-code -h --help" -- "$cur") )
|
|
721
743
|
return 0
|
|
722
744
|
fi
|
|
723
745
|
case "$prev" in
|
|
@@ -743,6 +765,31 @@ _postman_mock_run() {
|
|
|
743
765
|
_postman_filematch '!*.@(json)' "$cur"
|
|
744
766
|
return 0 ;;
|
|
745
767
|
esac
|
|
768
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
769
|
+
}
|
|
770
|
+
|
|
771
|
+
_postman_mock_get() {
|
|
772
|
+
if [[ "$cur" == -* ]]; then
|
|
773
|
+
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
774
|
+
return 0
|
|
775
|
+
fi
|
|
776
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
_postman_mock_list() {
|
|
780
|
+
if [[ "$cur" == -* ]]; then
|
|
781
|
+
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
782
|
+
return 0
|
|
783
|
+
fi
|
|
784
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
785
|
+
}
|
|
786
|
+
|
|
787
|
+
_postman_mock_delete() {
|
|
788
|
+
if [[ "$cur" == -* ]]; then
|
|
789
|
+
COMPREPLY=( $(compgen -W "-y --yes -h --help" -- "$cur") )
|
|
790
|
+
return 0
|
|
791
|
+
fi
|
|
792
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
746
793
|
}
|
|
747
794
|
|
|
748
795
|
_postman_application() {
|
|
@@ -750,13 +797,14 @@ _postman_application() {
|
|
|
750
797
|
if [[ "$cur" == -* ]]; then
|
|
751
798
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
752
799
|
else
|
|
753
|
-
COMPREPLY=( $(compgen -W "init test" -- "$cur") )
|
|
800
|
+
COMPREPLY=( $(compgen -W "init test setup-capture" -- "$cur") )
|
|
754
801
|
fi
|
|
755
802
|
return 0
|
|
756
803
|
fi
|
|
757
804
|
case "$subcmd" in
|
|
758
805
|
init) _postman_application_init ;;
|
|
759
806
|
test) _postman_application_test ;;
|
|
807
|
+
setup-capture) _postman_application_setup_capture ;;
|
|
760
808
|
esac
|
|
761
809
|
}
|
|
762
810
|
|
|
@@ -790,6 +838,18 @@ _postman_application_test() {
|
|
|
790
838
|
esac
|
|
791
839
|
}
|
|
792
840
|
|
|
841
|
+
_postman_application_setup_capture() {
|
|
842
|
+
if [[ "$cur" == -* ]]; then
|
|
843
|
+
COMPREPLY=( $(compgen -W "--config -h --help" -- "$cur") )
|
|
844
|
+
return 0
|
|
845
|
+
fi
|
|
846
|
+
case "$prev" in
|
|
847
|
+
--config)
|
|
848
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
849
|
+
return 0 ;;
|
|
850
|
+
esac
|
|
851
|
+
}
|
|
852
|
+
|
|
793
853
|
_postman_simulate() {
|
|
794
854
|
if [[ -z "$subcmd" ]]; then
|
|
795
855
|
if [[ "$cur" == -* ]]; then
|
|
@@ -1295,7 +1355,7 @@ _postman_dataset_get() {
|
|
|
1295
1355
|
|
|
1296
1356
|
_postman_dataset_query() {
|
|
1297
1357
|
if [[ "$cur" == -* ]]; then
|
|
1298
|
-
COMPREPLY=( $(compgen -W "-q --query -p --param --api-key --json -h --help" -- "$cur") )
|
|
1358
|
+
COMPREPLY=( $(compgen -W "-q --query -p --param --api-key --json --debug -h --help" -- "$cur") )
|
|
1299
1359
|
return 0
|
|
1300
1360
|
fi
|
|
1301
1361
|
case "$prev" in
|
|
@@ -1361,13 +1421,19 @@ _postman_dataset_source_list() {
|
|
|
1361
1421
|
|
|
1362
1422
|
_postman_dataset_source_add() {
|
|
1363
1423
|
if [[ "$cur" == -* ]]; then
|
|
1364
|
-
COMPREPLY=( $(compgen -W "-d --dataset -n --name --source-id --format --type --file --ref-only --force --upload --
|
|
1424
|
+
COMPREPLY=( $(compgen -W "-d --dataset -n --name --source-id --format --type --file --ref-only --force --upload --host --port --user --password --database --table --ssh-host --ssh-port --ssh-user --ssh-private-key --ssh-host-key --ssh-host-key-vault-id --ssh-host-key-secret-id --ssh-insecure-skip-host-key-verification --schema --encrypt --trust-server-certificate --tls-certificate --host-name-in-certificate --tls-min-version --api-key -h --help" -- "$cur") )
|
|
1365
1425
|
return 0
|
|
1366
1426
|
fi
|
|
1367
1427
|
case "$prev" in
|
|
1368
1428
|
--file)
|
|
1369
1429
|
_postman_filematch '!*.@(json)' "$cur"
|
|
1370
1430
|
return 0 ;;
|
|
1431
|
+
--ssh-private-key)
|
|
1432
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1433
|
+
return 0 ;;
|
|
1434
|
+
--tls-certificate)
|
|
1435
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1436
|
+
return 0 ;;
|
|
1371
1437
|
--api-key)
|
|
1372
1438
|
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1373
1439
|
return 0 ;;
|
|
@@ -1388,13 +1454,19 @@ _postman_dataset_source_remove() {
|
|
|
1388
1454
|
|
|
1389
1455
|
_postman_dataset_source_update() {
|
|
1390
1456
|
if [[ "$cur" == -* ]]; then
|
|
1391
|
-
COMPREPLY=( $(compgen -W "-d --dataset -n --name --format --file --ref-only --force --
|
|
1457
|
+
COMPREPLY=( $(compgen -W "-d --dataset -n --name --format --file --ref-only --force --host --port --user --password --database --table --ssh-host --ssh-port --ssh-user --ssh-private-key --ssh-host-key --ssh-host-key-vault-id --ssh-host-key-secret-id --ssh-insecure-skip-host-key-verification --schema --encrypt --trust-server-certificate --tls-certificate --host-name-in-certificate --tls-min-version --api-key -h --help" -- "$cur") )
|
|
1392
1458
|
return 0
|
|
1393
1459
|
fi
|
|
1394
1460
|
case "$prev" in
|
|
1395
1461
|
--file)
|
|
1396
1462
|
_postman_filematch '!*.@(json)' "$cur"
|
|
1397
1463
|
return 0 ;;
|
|
1464
|
+
--ssh-private-key)
|
|
1465
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1466
|
+
return 0 ;;
|
|
1467
|
+
--tls-certificate)
|
|
1468
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1469
|
+
return 0 ;;
|
|
1398
1470
|
--api-key)
|
|
1399
1471
|
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1400
1472
|
return 0 ;;
|
|
@@ -1433,7 +1505,7 @@ _postman_dataset_view_list() {
|
|
|
1433
1505
|
|
|
1434
1506
|
_postman_dataset_view_run() {
|
|
1435
1507
|
if [[ "$cur" == -* ]]; then
|
|
1436
|
-
COMPREPLY=( $(compgen -W "-d --dataset -p --param --api-key --json -h --help" -- "$cur") )
|
|
1508
|
+
COMPREPLY=( $(compgen -W "-d --dataset -p --param --api-key --json --debug -h --help" -- "$cur") )
|
|
1437
1509
|
return 0
|
|
1438
1510
|
fi
|
|
1439
1511
|
case "$prev" in
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Fish completion for Postman CLI (postman v1.
|
|
1
|
+
# Fish completion for Postman CLI (postman v1.51.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
|
|
@@ -44,7 +44,7 @@ complete -c postman -n __postman_no_subcommand -a simulate -d 'Start mock server
|
|
|
44
44
|
complete -c postman -n __postman_no_subcommand -a context -d '[Beta] Get API context for AI coding agents directly from the command line.'
|
|
45
45
|
complete -c postman -n __postman_no_subcommand -a search -d 'Search for Postman element types (requests, collections, workspaces, and more).'
|
|
46
46
|
complete -c postman -n __postman_no_subcommand -a webhook -d 'Create and manage Postman webhooks.'
|
|
47
|
-
complete -c postman -n __postman_no_subcommand -a dataset -d '[BETA] Work with Postman datasets
|
|
47
|
+
complete -c postman -n __postman_no_subcommand -a dataset -d '[BETA] Work with Postman datasets in local YAML files or the cloud.'
|
|
48
48
|
|
|
49
49
|
# ---------- login ----------
|
|
50
50
|
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
|
|
@@ -208,10 +208,12 @@ complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_sub
|
|
|
208
208
|
complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
209
209
|
|
|
210
210
|
# ---------- workspace ----------
|
|
211
|
-
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a list -d 'List all available Postman Workspaces'
|
|
212
|
-
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
213
|
-
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a push -d 'Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
214
|
-
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a lint -d 'Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use --meta to lint only the configuration.'
|
|
211
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint pull connect-git' -a list -d 'List all available Postman Workspaces'
|
|
212
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint pull connect-git' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
213
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint pull connect-git' -a push -d 'Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
214
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint pull connect-git' -a lint -d 'Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use --meta to lint only the configuration.'
|
|
215
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint pull connect-git' -a pull -d 'Pull workspace entities from a Postman workspace into the local git-native folder.'
|
|
216
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint pull connect-git' -a connect-git -d 'Connect a Postman workspace to a local git repository.'
|
|
215
217
|
complete -c postman -n '__fish_seen_subcommand_from workspace' -s h -l help -d 'display help for command'
|
|
216
218
|
# ---------- workspace list ----------
|
|
217
219
|
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
|
|
@@ -235,7 +237,17 @@ complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_s
|
|
|
235
237
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -s o -l output -d 'Output format: cli (human-readable), table, or json. (default: "cli")' -x
|
|
236
238
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -l meta -d 'Only lint the workspace configuration (.postman/resources.yaml); skip per-entity linting.'
|
|
237
239
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -l workspace-id -d 'The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.' -x
|
|
240
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -l fix -d 'Apply safe autofixes to repairable workspace lint issues.'
|
|
238
241
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -s h -l help -d 'display help for command'
|
|
242
|
+
# ---------- workspace pull ----------
|
|
243
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from pull' -s y -l yes -d 'Skip all confirmation prompts'
|
|
244
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from pull' -l source-workspace -d 'Pull from a different source workspace.' -x
|
|
245
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from pull' -l verbose -d 'Show detailed logging'
|
|
246
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from pull' -s h -l help -d 'display help for command'
|
|
247
|
+
# ---------- workspace connect-git ----------
|
|
248
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from connect-git' -l verbose -d 'Show detailed logging'
|
|
249
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from connect-git' -s h -l help -d 'display help for command'
|
|
250
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from connect-git' -r -k -a '(__fish_complete_suffix .json)'
|
|
239
251
|
|
|
240
252
|
# ---------- performance ----------
|
|
241
253
|
complete -c postman -n '__postman_using_subcommand performance run' -a run -d 'Run a performance test on a collection'
|
|
@@ -251,6 +263,7 @@ complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen
|
|
|
251
263
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l dataset-view-id -d 'Dataset view to execute for iteration data (requires --dataset-id)' -x
|
|
252
264
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l dataset-distribution -d 'How rows map to VUs: round-robin (default), fixed, random' -x
|
|
253
265
|
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
|
|
266
|
+
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l runner -d 'Runner to execute the performance test on (local or postman-cloud) (default: local)' -x
|
|
254
267
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l pass-if -d '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)' -x
|
|
255
268
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
256
269
|
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -r -k -a '(__fish_complete_suffix .json)'
|
|
@@ -461,12 +474,15 @@ complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcomm
|
|
|
461
474
|
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'
|
|
462
475
|
|
|
463
476
|
# ---------- mock ----------
|
|
464
|
-
complete -c postman -n '__postman_using_subcommand mock generate run' -a generate -d 'Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto-detected.'
|
|
465
|
-
complete -c postman -n '__postman_using_subcommand mock generate run' -a run -d 'Start a local mock server given a manifest file (JSON or YAML).'
|
|
477
|
+
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a generate -d 'Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto-detected. Omit the source to scaffold a sample mock with a GET /health endpoint.'
|
|
478
|
+
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a run -d 'Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.'
|
|
479
|
+
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a get -d 'Show a local mock\'s details and run status.'
|
|
480
|
+
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a list -d 'List local mocks found under a directory.'
|
|
481
|
+
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a delete -d 'Permanently remove a local mock artifact.'
|
|
466
482
|
complete -c postman -n '__fish_seen_subcommand_from mock' -s h -l help -d 'display help for command'
|
|
467
483
|
# ---------- mock generate ----------
|
|
468
484
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -s o -l output -d 'Output directory for the mock (default: postman/mocks/<slug>)' -r
|
|
469
|
-
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -l name -d 'Display name for the generated mock' -x
|
|
485
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -s n -l name -d 'Display name for the generated mock. Optional with a source (derived from it); required when generating without a source.' -x
|
|
470
486
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -l port -d 'Port the mock server should listen on (default: 4500)' -x
|
|
471
487
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -l force -d 'Overwrite the config.yaml/default.js in the output directory if it already exists'
|
|
472
488
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -s u -l update -d 'Update an existing mock in place from the source: path to its config.yaml (or the directory containing it). Regenerates the default scenario handler and preserves the existing name/port/scenarios. Cannot be combined with --output.' -r
|
|
@@ -477,10 +493,24 @@ complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcom
|
|
|
477
493
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -s g -l globals -d 'Path to a globals file (JSON or YAML) for pm.globals' -r
|
|
478
494
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -s p -l port -d 'Mock server port, or "auto" for an ephemeral one (default: configured port, falls back to an ephemeral one if busy).' -x
|
|
479
495
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
496
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -r -k -a '(__fish_complete_suffix .json)'
|
|
497
|
+
# ---------- mock get ----------
|
|
498
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from get' -l json -d 'Output the mock details as JSON instead of a table'
|
|
499
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from get' -s h -l help -d 'display help for command'
|
|
500
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from get' -r -k -a '(__fish_complete_suffix .json)'
|
|
501
|
+
# ---------- mock list ----------
|
|
502
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from list' -l json -d 'Output the mock list as JSON instead of a table'
|
|
503
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
504
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from list' -r -k -a '(__fish_complete_suffix .json)'
|
|
505
|
+
# ---------- mock delete ----------
|
|
506
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from delete' -s y -l yes -d 'Skip the confirmation prompt'
|
|
507
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from delete' -s h -l help -d 'display help for command'
|
|
508
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from delete' -r -k -a '(__fish_complete_suffix .json)'
|
|
480
509
|
|
|
481
510
|
# ---------- application ----------
|
|
482
|
-
complete -c postman -n '__postman_using_subcommand application init test' -a init -d 'Initialise a postman.config.cjs file with target collections, environment, and test command.'
|
|
483
|
-
complete -c postman -n '__postman_using_subcommand application init test' -a test -d 'Run a command first (primary task), then match captured traffic against Postman collections and run assertions.'
|
|
511
|
+
complete -c postman -n '__postman_using_subcommand application init test setup-capture' -a init -d '[DEPRECATED] Use `postman app test` instead. Initialise a postman.config.cjs file with target collections, environment, and test command.'
|
|
512
|
+
complete -c postman -n '__postman_using_subcommand application init test setup-capture' -a test -d 'Run a command first (primary task), then match captured traffic against Postman collections and run assertions.'
|
|
513
|
+
complete -c postman -n '__postman_using_subcommand application init test setup-capture' -a setup-capture -d 'Install postman-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().'
|
|
484
514
|
complete -c postman -n '__fish_seen_subcommand_from application' -s h -l help -d 'display help for command'
|
|
485
515
|
# ---------- application init ----------
|
|
486
516
|
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from init' -l target-collection -d 'Collection name or path for the default target (repeatable) (default: [])' -x
|
|
@@ -503,6 +533,9 @@ complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen
|
|
|
503
533
|
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l report-events -d 'Send application test run results and analytics to Postman'
|
|
504
534
|
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l verbose -d 'Show detailed per-request matching, sandbox errors, and debug information'
|
|
505
535
|
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -s h -l help -d 'display help for command'
|
|
536
|
+
# ---------- application setup-capture ----------
|
|
537
|
+
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from setup-capture' -l config -d 'Path to playwright.config.* to patch (default: auto-detect)' -r
|
|
538
|
+
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from setup-capture' -s h -l help -d 'display help for command'
|
|
506
539
|
|
|
507
540
|
# ---------- simulate ----------
|
|
508
541
|
complete -c postman -n '__postman_using_subcommand simulate run' -a run -d 'Start mocks with fault-injection scenarios defined in a .sim.yaml file'
|
|
@@ -674,7 +707,7 @@ complete -c postman -n '__postman_using_subcommand dataset list get query create
|
|
|
674
707
|
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).'
|
|
675
708
|
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).'
|
|
676
709
|
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.'
|
|
677
|
-
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
|
|
710
|
+
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 or a cloud dataset id.'
|
|
678
711
|
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.'
|
|
679
712
|
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.'
|
|
680
713
|
complete -c postman -n '__fish_seen_subcommand_from dataset' -s h -l help -d 'display help for command'
|
|
@@ -691,9 +724,10 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
691
724
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -s h -l help -d 'display help for command'
|
|
692
725
|
# ---------- dataset query ----------
|
|
693
726
|
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
|
|
694
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s p -l param -d '
|
|
727
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s p -l param -d 'Bind values to $1, $2, ... in order; pass multiple values after -p or repeat -p' -x
|
|
695
728
|
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
|
|
696
729
|
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'
|
|
730
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -l debug -d 'Include safe classified dataset diagnostics'
|
|
697
731
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s h -l help -d 'display help for command'
|
|
698
732
|
# ---------- dataset create ----------
|
|
699
733
|
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
|
|
@@ -706,7 +740,7 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
706
740
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from create' -r -k -a '(__fish_complete_suffix .json)'
|
|
707
741
|
# ---------- dataset delete ----------
|
|
708
742
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -s y -l yes -d 'Skip the confirmation prompt'
|
|
709
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -l keep-resources -d '
|
|
743
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -l keep-resources -d 'Preserve the local resource directory even when it is empty (local only)'
|
|
710
744
|
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
|
|
711
745
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -s h -l help -d 'display help for command'
|
|
712
746
|
# ---------- dataset source ----------
|
|
@@ -721,23 +755,35 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
721
755
|
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'
|
|
722
756
|
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'
|
|
723
757
|
# ---------- dataset source add ----------
|
|
724
|
-
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
|
|
758
|
+
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; positional target is also accepted for v1.45 compatibility' -x
|
|
725
759
|
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
|
|
726
|
-
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
|
|
727
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l format -d '
|
|
728
|
-
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
|
|
760
|
+
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 (local dataset only)' -x
|
|
761
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l format -d 'Use this format instead of extension/type inference; file contents are not sniffed' -x
|
|
762
|
+
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; local is inferred when --file is provided' -x
|
|
729
763
|
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
|
|
730
764
|
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)'
|
|
731
765
|
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)'
|
|
732
766
|
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.'
|
|
733
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l
|
|
734
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l
|
|
735
|
-
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
|
|
767
|
+
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/sqlserver)' -x
|
|
768
|
+
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 (defaults to 1433 for sqlserver)' -x
|
|
736
769
|
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
|
|
737
770
|
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
|
|
738
771
|
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
|
|
739
|
-
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 (
|
|
740
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l
|
|
772
|
+
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 (required for sqlserver)' -x
|
|
773
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-host -d 'SSH bastion host' -x
|
|
774
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-port -d 'SSH bastion port' -x
|
|
775
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-user -d 'SSH bastion user' -x
|
|
776
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-private-key -d 'Path to the SSH private key. WARNING: the path is visible in `ps` output and shell history; key contents are read locally at execution time and are not stored in the dataset config.' -r
|
|
777
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-host-key -d 'SSH bastion public host key' -x
|
|
778
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-host-key-vault-id -d 'Shared Vault ID containing the SSH public host key' -x
|
|
779
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-host-key-secret-id -d 'Shared Vault secret ID containing the SSH public host key' -x
|
|
780
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ssh-insecure-skip-host-key-verification -d 'WARNING: disable SSH host-key verification; use only for trusted local testing'
|
|
781
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l schema -d 'DB schema (postgresql/sqlserver; defaults to dbo for sqlserver)' -x
|
|
782
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l encrypt -d 'SQL Server TLS encryption (default: true)' -x
|
|
783
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l trust-server-certificate -d 'SQL Server: skip certificate verification (default: false; insecure)' -x
|
|
784
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l tls-certificate -d 'SQL Server CA/server certificate file path' -r
|
|
785
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l host-name-in-certificate -d 'SQL Server certificate hostname override' -x
|
|
786
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l tls-min-version -d 'SQL Server minimum TLS version (default: 1.2)' -x
|
|
741
787
|
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
|
|
742
788
|
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'
|
|
743
789
|
# ---------- dataset source remove ----------
|
|
@@ -747,18 +793,30 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
747
793
|
# ---------- dataset source update ----------
|
|
748
794
|
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
|
|
749
795
|
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
|
|
750
|
-
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
|
|
751
|
-
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
|
|
752
|
-
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 '
|
|
753
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l force -d '
|
|
754
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l
|
|
755
|
-
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
|
|
796
|
+
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 (local dataset only; cloud source formats are immutable)' -x
|
|
797
|
+
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 file (local dataset only; cloud file replacement is unsupported)' -r
|
|
798
|
+
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 'With --file, reference in place instead of copying (local dataset only)'
|
|
799
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l force -d 'With --file, overwrite the copied destination (local dataset only)'
|
|
800
|
+
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/sqlserver)' -x
|
|
756
801
|
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
|
|
757
802
|
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
|
|
758
803
|
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
|
|
759
804
|
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
|
|
760
805
|
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
|
|
761
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l
|
|
806
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-host -d 'Update SSH bastion host' -x
|
|
807
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-port -d 'Update SSH bastion port' -x
|
|
808
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-user -d 'Update SSH bastion user' -x
|
|
809
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-private-key -d 'Update the SSH private-key file path. WARNING: the path is visible in `ps` output and shell history; key contents are read locally and are not stored in the dataset config.' -r
|
|
810
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-host-key -d 'Update the SSH bastion public host key' -x
|
|
811
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-host-key-vault-id -d 'Update the Shared Vault ID containing the SSH public host key' -x
|
|
812
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-host-key-secret-id -d 'Update the Shared Vault secret ID containing the SSH public host key' -x
|
|
813
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ssh-insecure-skip-host-key-verification -d 'WARNING: disable SSH host-key verification; use only for trusted local testing'
|
|
814
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l schema -d 'Update DB schema (postgresql/sqlserver)' -x
|
|
815
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l encrypt -d 'Update SQL Server TLS encryption' -x
|
|
816
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l trust-server-certificate -d 'Update SQL Server certificate verification (true is insecure)' -x
|
|
817
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l tls-certificate -d 'Update SQL Server CA/server certificate file path' -r
|
|
818
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l host-name-in-certificate -d 'Update SQL Server certificate hostname override' -x
|
|
819
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l tls-min-version -d 'Update SQL Server minimum TLS version' -x
|
|
762
820
|
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
|
|
763
821
|
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'
|
|
764
822
|
# ---------- dataset view ----------
|
|
@@ -775,9 +833,10 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
775
833
|
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'
|
|
776
834
|
# ---------- dataset view run ----------
|
|
777
835
|
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
|
|
778
|
-
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 '
|
|
836
|
+
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 'Bind values to $1, $2, ... in order; pass multiple values after -p or repeat -p' -x
|
|
779
837
|
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
|
|
780
838
|
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'
|
|
839
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view; and __fish_seen_subcommand_from run' -l debug -d 'Include safe classified dataset diagnostics'
|
|
781
840
|
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'
|
|
782
841
|
# ---------- dataset view create ----------
|
|
783
842
|
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
|
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.51.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
|
|
@@ -72,7 +72,7 @@ _postman_commands() {
|
|
|
72
72
|
'context:\[Beta\] Get API context for AI coding agents directly from the command line.'
|
|
73
73
|
'search:Search for Postman element types (requests, collections, workspaces, and more).'
|
|
74
74
|
'webhook:Create and manage Postman webhooks.'
|
|
75
|
-
'dataset:\[BETA\] Work with Postman datasets
|
|
75
|
+
'dataset:\[BETA\] Work with Postman datasets in local YAML files or the cloud.'
|
|
76
76
|
)
|
|
77
77
|
_describe -t commands 'postman command' commands
|
|
78
78
|
}
|
|
@@ -442,6 +442,8 @@ _postman_workspace() {
|
|
|
442
442
|
prepare) _postman_workspace_prepare ;;
|
|
443
443
|
push) _postman_workspace_push ;;
|
|
444
444
|
lint) _postman_workspace_lint ;;
|
|
445
|
+
pull) _postman_workspace_pull ;;
|
|
446
|
+
connect-git) _postman_workspace_connect_git ;;
|
|
445
447
|
esac
|
|
446
448
|
;;
|
|
447
449
|
esac
|
|
@@ -454,6 +456,8 @@ _postman_workspace_commands() {
|
|
|
454
456
|
'prepare:Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
455
457
|
'push:Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
456
458
|
'lint:Lint the current local Postman workspace\: its configuration (.postman/resources.yaml) plus every discovered entity. Use --meta to lint only the configuration.'
|
|
459
|
+
'pull:Pull workspace entities from a Postman workspace into the local git-native folder.'
|
|
460
|
+
'connect-git:Connect a Postman workspace to a local git repository.'
|
|
457
461
|
)
|
|
458
462
|
_describe -t commands 'workspace command' sub
|
|
459
463
|
}
|
|
@@ -490,9 +494,26 @@ _postman_workspace_lint() {
|
|
|
490
494
|
'(-o --output)'{-o,--output}'[Output format\: cli (human-readable), table, or json. (default\: "cli")]:value' \
|
|
491
495
|
'--meta[Only lint the workspace configuration (.postman/resources.yaml); skip per-entity linting.]' \
|
|
492
496
|
'--workspace-id[The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.]:value' \
|
|
497
|
+
'--fix[Apply safe autofixes to repairable workspace lint issues.]' \
|
|
493
498
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
494
499
|
}
|
|
495
500
|
|
|
501
|
+
_postman_workspace_pull() {
|
|
502
|
+
_arguments \
|
|
503
|
+
'(-y --yes)'{-y,--yes}'[Skip all confirmation prompts]' \
|
|
504
|
+
'--source-workspace[Pull from a different source workspace.]:workspaceId' \
|
|
505
|
+
'--verbose[Show detailed logging]' \
|
|
506
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
507
|
+
'*:workspaceId:'
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
_postman_workspace_connect_git() {
|
|
511
|
+
_arguments \
|
|
512
|
+
'--verbose[Show detailed logging]' \
|
|
513
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
514
|
+
'*:path:_files -g "*.json"'
|
|
515
|
+
}
|
|
516
|
+
|
|
496
517
|
_postman_performance() {
|
|
497
518
|
local context state state_descr line
|
|
498
519
|
typeset -A opt_args
|
|
@@ -529,6 +550,7 @@ _postman_performance_run() {
|
|
|
529
550
|
'--dataset-view-id[Dataset view to execute for iteration data (requires --dataset-id)]:id' \
|
|
530
551
|
'--dataset-distribution[How rows map to VUs\: round-robin (default), fixed, random]:strategy' \
|
|
531
552
|
'--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' \
|
|
553
|
+
'--runner[Runner to execute the performance test on (local or postman-cloud) (default\: local)]:runner' \
|
|
532
554
|
'--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' \
|
|
533
555
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
534
556
|
'*:collectionId:_files -g "*.json"'
|
|
@@ -882,6 +904,9 @@ _postman_mock() {
|
|
|
882
904
|
case $words[1] in
|
|
883
905
|
generate) _postman_mock_generate ;;
|
|
884
906
|
run) _postman_mock_run ;;
|
|
907
|
+
get) _postman_mock_get ;;
|
|
908
|
+
list) _postman_mock_list ;;
|
|
909
|
+
delete) _postman_mock_delete ;;
|
|
885
910
|
esac
|
|
886
911
|
;;
|
|
887
912
|
esac
|
|
@@ -890,8 +915,11 @@ _postman_mock() {
|
|
|
890
915
|
_postman_mock_commands() {
|
|
891
916
|
local -a sub
|
|
892
917
|
sub=(
|
|
893
|
-
'generate:Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto-detected.'
|
|
894
|
-
'run:Start a local mock server given a manifest file (JSON or YAML).'
|
|
918
|
+
'generate:Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto-detected. Omit the source to scaffold a sample mock with a GET /health endpoint.'
|
|
919
|
+
'run:Start a local mock server given a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.'
|
|
920
|
+
'get:Show a local mock'\''s details and run status.'
|
|
921
|
+
'list:List local mocks found under a directory.'
|
|
922
|
+
'delete:Permanently remove a local mock artifact.'
|
|
895
923
|
)
|
|
896
924
|
_describe -t commands 'mock command' sub
|
|
897
925
|
}
|
|
@@ -899,7 +927,7 @@ _postman_mock_commands() {
|
|
|
899
927
|
_postman_mock_generate() {
|
|
900
928
|
_arguments \
|
|
901
929
|
'(-o --output)'{-o,--output}'[Output directory for the mock (default\: postman/mocks/<slug>)]:dir:_files -g "*.json"' \
|
|
902
|
-
'--name[Display name for the generated mock]:name' \
|
|
930
|
+
'(-n --name)'{-n,--name}'[Display name for the generated mock. Optional with a source (derived from it); required when generating without a source.]:name' \
|
|
903
931
|
'--port[Port the mock server should listen on (default\: 4500)]:port' \
|
|
904
932
|
'--force[Overwrite the config.yaml/default.js in the output directory if it already exists]' \
|
|
905
933
|
'(-u --update)'{-u,--update}'[Update an existing mock in place from the source\: path to its config.yaml (or the directory containing it). Regenerates the default scenario handler and preserves the existing name/port/scenarios. Cannot be combined with --output.]:mockPath:_files -g "*.json"' \
|
|
@@ -914,7 +942,28 @@ _postman_mock_run() {
|
|
|
914
942
|
'(-g --globals)'{-g,--globals}'[Path to a globals file (JSON or YAML) for pm.globals]:path:_files -g "*.json"' \
|
|
915
943
|
'(-p --port)'{-p,--port}'[Mock server port, or "auto" for an ephemeral one (default\: configured port, falls back to an ephemeral one if busy).]:port' \
|
|
916
944
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
917
|
-
'*:
|
|
945
|
+
'*:pathOrDir:_files -g "*.json"'
|
|
946
|
+
}
|
|
947
|
+
|
|
948
|
+
_postman_mock_get() {
|
|
949
|
+
_arguments \
|
|
950
|
+
'--json[Output the mock details as JSON instead of a table]' \
|
|
951
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
952
|
+
'*:pathOrDir:_files -g "*.json"'
|
|
953
|
+
}
|
|
954
|
+
|
|
955
|
+
_postman_mock_list() {
|
|
956
|
+
_arguments \
|
|
957
|
+
'--json[Output the mock list as JSON instead of a table]' \
|
|
958
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
959
|
+
'*:pathOrDir:_files -g "*.json"'
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
_postman_mock_delete() {
|
|
963
|
+
_arguments \
|
|
964
|
+
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt]' \
|
|
965
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
966
|
+
'*:pathOrDir:_files -g "*.json"'
|
|
918
967
|
}
|
|
919
968
|
|
|
920
969
|
_postman_application() {
|
|
@@ -929,6 +978,7 @@ _postman_application() {
|
|
|
929
978
|
case $words[1] in
|
|
930
979
|
init) _postman_application_init ;;
|
|
931
980
|
test) _postman_application_test ;;
|
|
981
|
+
setup-capture) _postman_application_setup_capture ;;
|
|
932
982
|
esac
|
|
933
983
|
;;
|
|
934
984
|
esac
|
|
@@ -937,8 +987,9 @@ _postman_application() {
|
|
|
937
987
|
_postman_application_commands() {
|
|
938
988
|
local -a sub
|
|
939
989
|
sub=(
|
|
940
|
-
'init
|
|
990
|
+
'init:\[DEPRECATED\] Use `postman app test` instead. Initialise a postman.config.cjs file with target collections, environment, and test command.'
|
|
941
991
|
'test:Run a command first (primary task), then match captured traffic against Postman collections and run assertions.'
|
|
992
|
+
'setup-capture:Install postman-playwright and patch playwright.config.* to capture network traffic automatically via withPostman().'
|
|
942
993
|
)
|
|
943
994
|
_describe -t commands 'application command' sub
|
|
944
995
|
}
|
|
@@ -970,6 +1021,12 @@ _postman_application_test() {
|
|
|
970
1021
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
971
1022
|
}
|
|
972
1023
|
|
|
1024
|
+
_postman_application_setup_capture() {
|
|
1025
|
+
_arguments \
|
|
1026
|
+
'--config[Path to playwright.config.* to patch (default\: auto-detect)]:path:_files -g "*.json"' \
|
|
1027
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1028
|
+
}
|
|
1029
|
+
|
|
973
1030
|
_postman_simulate() {
|
|
974
1031
|
local context state state_descr line
|
|
975
1032
|
typeset -A opt_args
|
|
@@ -1538,7 +1595,7 @@ _postman_dataset_commands() {
|
|
|
1538
1595
|
'get:\[BETA\] Print a dataset'\''s metadata and structure summary (local YAML path or cloud id).'
|
|
1539
1596
|
'query:\[BETA\] Run an ad-hoc SQL query against a dataset (local YAML path or cloud id).'
|
|
1540
1597
|
'create:\[BETA\] Scaffold a new .dataset.yaml at <path>, or (no path, with -w) create a cloud dataset.'
|
|
1541
|
-
'delete:\[BETA\] Permanently remove a dataset\: a local .dataset.yaml
|
|
1598
|
+
'delete:\[BETA\] Permanently remove a dataset\: a local .dataset.yaml or a cloud dataset id.'
|
|
1542
1599
|
'source:\[BETA\] Inspect and manage a dataset'\''s datasources.'
|
|
1543
1600
|
'view:\[BETA\] Inspect and manage saved views on a dataset.'
|
|
1544
1601
|
)
|
|
@@ -1566,9 +1623,10 @@ _postman_dataset_get() {
|
|
|
1566
1623
|
_postman_dataset_query() {
|
|
1567
1624
|
_arguments \
|
|
1568
1625
|
'(-q --query)'{-q,--query}'[SQL query to execute (e.g. "SELECT * FROM source_users LIMIT 10")]:sql' \
|
|
1569
|
-
'(-p --param)'{-p,--param}'[
|
|
1626
|
+
'(-p --param)'{-p,--param}'[Bind values to $1, $2, ... in order; pass multiple values after -p or repeat -p]:value...' \
|
|
1570
1627
|
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1571
1628
|
'--json[Output rows as JSON instead of a table]' \
|
|
1629
|
+
'--debug[Include safe classified dataset diagnostics]' \
|
|
1572
1630
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1573
1631
|
'*:datasetPathOrId:'
|
|
1574
1632
|
}
|
|
@@ -1588,7 +1646,7 @@ _postman_dataset_create() {
|
|
|
1588
1646
|
_postman_dataset_delete() {
|
|
1589
1647
|
_arguments \
|
|
1590
1648
|
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt]' \
|
|
1591
|
-
'--keep-resources[
|
|
1649
|
+
'--keep-resources[Preserve the local resource directory even when it is empty (local only)]' \
|
|
1592
1650
|
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1593
1651
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1594
1652
|
'*:datasetPathOrId:'
|
|
@@ -1634,25 +1692,38 @@ _postman_dataset_source_list() {
|
|
|
1634
1692
|
|
|
1635
1693
|
_postman_dataset_source_add() {
|
|
1636
1694
|
_arguments \
|
|
1637
|
-
'(-d --dataset)'{-d,--dataset}'[Dataset to add the source to
|
|
1695
|
+
'(-d --dataset)'{-d,--dataset}'[Dataset to add the source to; positional target is also accepted for v1.45 compatibility]:datasetPathOrId' \
|
|
1638
1696
|
'(-n --name)'{-n,--name}'[Logical name for the source (becomes the SQL table name)]:name' \
|
|
1639
|
-
'--source-id[Override the generated source id]:uuid' \
|
|
1640
|
-
'--format[
|
|
1641
|
-
'--type[Source kind; inferred
|
|
1697
|
+
'--source-id[Override the generated source id (local dataset only)]:uuid' \
|
|
1698
|
+
'--format[Use this format instead of extension/type inference; file contents are not sniffed]:csv|json|mysql|postgres|sqlserver' \
|
|
1699
|
+
'--type[Source kind; local is inferred when --file is provided]:local|mysql|postgresql|sqlserver' \
|
|
1642
1700
|
'--file[Path to a local CSV/JSON file (absolute or cwd-relative)]:path:_files -g "*.json"' \
|
|
1643
1701
|
'--ref-only[Reference the file in place; do NOT copy into data_dir (local dataset)]' \
|
|
1644
1702
|
'--force[When copying, overwrite an existing file at the destination (local dataset)]' \
|
|
1645
1703
|
'--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.]' \
|
|
1646
|
-
'--
|
|
1647
|
-
'--
|
|
1648
|
-
'--port[DB port]:port' \
|
|
1704
|
+
'--host[DB host (mysql/postgresql/sqlserver)]:host' \
|
|
1705
|
+
'--port[DB port (defaults to 1433 for sqlserver)]:port' \
|
|
1649
1706
|
'--user[DB user (warning\: stored as plaintext in the YAML).]:user' \
|
|
1650
1707
|
'--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' \
|
|
1651
1708
|
'--database[DB database name]:db' \
|
|
1652
|
-
'--table[DB table name (
|
|
1653
|
-
'--
|
|
1709
|
+
'--table[DB table name (required for sqlserver)]:table' \
|
|
1710
|
+
'--ssh-host[SSH bastion host]:host' \
|
|
1711
|
+
'--ssh-port[SSH bastion port]:port' \
|
|
1712
|
+
'--ssh-user[SSH bastion user]:user' \
|
|
1713
|
+
'--ssh-private-key[Path to the SSH private key. WARNING\: the path is visible in `ps` output and shell history; key contents are read locally at execution time and are not stored in the dataset config.]:filepath:_files -g "*.(pem|crt|key)"' \
|
|
1714
|
+
'--ssh-host-key[SSH bastion public host key]:publicKey' \
|
|
1715
|
+
'--ssh-host-key-vault-id[Shared Vault ID containing the SSH public host key]:id' \
|
|
1716
|
+
'--ssh-host-key-secret-id[Shared Vault secret ID containing the SSH public host key]:id' \
|
|
1717
|
+
'--ssh-insecure-skip-host-key-verification[WARNING\: disable SSH host-key verification; use only for trusted local testing]' \
|
|
1718
|
+
'--schema[DB schema (postgresql/sqlserver; defaults to dbo for sqlserver)]:schema' \
|
|
1719
|
+
'--encrypt[SQL Server TLS encryption (default\: true)]:true|false' \
|
|
1720
|
+
'--trust-server-certificate[SQL Server\: skip certificate verification (default\: false; insecure)]:true|false' \
|
|
1721
|
+
'--tls-certificate[SQL Server CA/server certificate file path]:path:_files -g "*.(pem|crt|key)"' \
|
|
1722
|
+
'--host-name-in-certificate[SQL Server certificate hostname override]:hostname' \
|
|
1723
|
+
'--tls-min-version[SQL Server minimum TLS version (default\: 1.2)]:1.2|1.3' \
|
|
1654
1724
|
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1655
|
-
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1725
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1726
|
+
'*:datasetPathOrId:'
|
|
1656
1727
|
}
|
|
1657
1728
|
|
|
1658
1729
|
_postman_dataset_source_remove() {
|
|
@@ -1667,18 +1738,30 @@ _postman_dataset_source_update() {
|
|
|
1667
1738
|
_arguments \
|
|
1668
1739
|
'(-d --dataset)'{-d,--dataset}'[Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1669
1740
|
'(-n --name)'{-n,--name}'[Rename the source]:name' \
|
|
1670
|
-
'--format[Change the format]:csv|json|mysql|postgres' \
|
|
1671
|
-
'--file[Replace the source
|
|
1672
|
-
'--ref-only[
|
|
1673
|
-
'--force[
|
|
1674
|
-
'--
|
|
1675
|
-
'--host[Update DB host (mysql/postgresql)]:host' \
|
|
1741
|
+
'--format[Change the format (local dataset only; cloud source formats are immutable)]:csv|json|mysql|postgres|sqlserver' \
|
|
1742
|
+
'--file[Replace the source file (local dataset only; cloud file replacement is unsupported)]:path:_files -g "*.json"' \
|
|
1743
|
+
'--ref-only[With --file, reference in place instead of copying (local dataset only)]' \
|
|
1744
|
+
'--force[With --file, overwrite the copied destination (local dataset only)]' \
|
|
1745
|
+
'--host[Update DB host (mysql/postgresql/sqlserver)]:host' \
|
|
1676
1746
|
'--port[Update DB port]:port' \
|
|
1677
1747
|
'--user[Update DB user (warning\: stored as plaintext in the YAML).]:user' \
|
|
1678
1748
|
'--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' \
|
|
1679
1749
|
'--database[Update DB database name]:db' \
|
|
1680
1750
|
'--table[Update DB table name]:table' \
|
|
1681
|
-
'--
|
|
1751
|
+
'--ssh-host[Update SSH bastion host]:host' \
|
|
1752
|
+
'--ssh-port[Update SSH bastion port]:port' \
|
|
1753
|
+
'--ssh-user[Update SSH bastion user]:user' \
|
|
1754
|
+
'--ssh-private-key[Update the SSH private-key file path. WARNING\: the path is visible in `ps` output and shell history; key contents are read locally and are not stored in the dataset config.]:filepath:_files -g "*.(pem|crt|key)"' \
|
|
1755
|
+
'--ssh-host-key[Update the SSH bastion public host key]:publicKey' \
|
|
1756
|
+
'--ssh-host-key-vault-id[Update the Shared Vault ID containing the SSH public host key]:id' \
|
|
1757
|
+
'--ssh-host-key-secret-id[Update the Shared Vault secret ID containing the SSH public host key]:id' \
|
|
1758
|
+
'--ssh-insecure-skip-host-key-verification[WARNING\: disable SSH host-key verification; use only for trusted local testing]' \
|
|
1759
|
+
'--schema[Update DB schema (postgresql/sqlserver)]:schema' \
|
|
1760
|
+
'--encrypt[Update SQL Server TLS encryption]:true|false' \
|
|
1761
|
+
'--trust-server-certificate[Update SQL Server certificate verification (true is insecure)]:true|false' \
|
|
1762
|
+
'--tls-certificate[Update SQL Server CA/server certificate file path]:path:_files -g "*.(pem|crt|key)"' \
|
|
1763
|
+
'--host-name-in-certificate[Update SQL Server certificate hostname override]:hostname' \
|
|
1764
|
+
'--tls-min-version[Update SQL Server minimum TLS version]:1.2|1.3' \
|
|
1682
1765
|
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1683
1766
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1684
1767
|
'*:sourceNameOrId:'
|
|
@@ -1727,9 +1810,10 @@ _postman_dataset_view_list() {
|
|
|
1727
1810
|
_postman_dataset_view_run() {
|
|
1728
1811
|
_arguments \
|
|
1729
1812
|
'(-d --dataset)'{-d,--dataset}'[Dataset the view belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
1730
|
-
'(-p --param)'{-p,--param}'[
|
|
1813
|
+
'(-p --param)'{-p,--param}'[Bind values to $1, $2, ... in order; pass multiple values after -p or repeat -p]:value...' \
|
|
1731
1814
|
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1732
1815
|
'--json[Output rows as JSON instead of a table]' \
|
|
1816
|
+
'--debug[Include safe classified dataset diagnostics]' \
|
|
1733
1817
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1734
1818
|
'*:viewNameOrId:'
|
|
1735
1819
|
}
|