postman-cli-completion 1.51.0 → 1.54.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/completions/bash/postman.bash +93 -17
- package/completions/fish/postman.fish +99 -36
- package/completions/zsh/_postman +110 -32
- 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.54.1)
|
|
2
2
|
# Auto-generated by scripts/generate.mjs — DO NOT EDIT
|
|
3
3
|
# Source: spec/commands.json
|
|
4
4
|
# https://github.com/yokawasa/postman-cli-completion
|
|
@@ -22,7 +22,7 @@ _postman() {
|
|
|
22
22
|
cur="${COMP_WORDS[COMP_CWORD]}"
|
|
23
23
|
prev="${COMP_WORDS[COMP_CWORD-1]}"
|
|
24
24
|
|
|
25
|
-
local top_commands="login logout collection environment globals api runner spec monitor workspace ws performance flows fl request sdk mock application app simulate context search webhook dataset"
|
|
25
|
+
local top_commands="login logout init collection environment globals 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=""
|
|
@@ -48,6 +48,7 @@ _postman() {
|
|
|
48
48
|
case "$cmd" in
|
|
49
49
|
login) _postman_login ;;
|
|
50
50
|
logout) _postman_logout ;;
|
|
51
|
+
init) _postman_init ;;
|
|
51
52
|
collection) _postman_collection ;;
|
|
52
53
|
environment) _postman_environment ;;
|
|
53
54
|
globals) _postman_globals ;;
|
|
@@ -91,6 +92,19 @@ _postman_logout() {
|
|
|
91
92
|
esac
|
|
92
93
|
}
|
|
93
94
|
|
|
95
|
+
_postman_init() {
|
|
96
|
+
if [[ "$cur" == -* ]]; then
|
|
97
|
+
COMPREPLY=( $(compgen -W "--json --dry-run --no-seed --spec --visibility --no-cloud --report-events -h --help" -- "$cur") )
|
|
98
|
+
return 0
|
|
99
|
+
fi
|
|
100
|
+
case "$prev" in
|
|
101
|
+
--spec)
|
|
102
|
+
_postman_filematch '!*.@(yaml|yml|json)' "$cur"
|
|
103
|
+
return 0 ;;
|
|
104
|
+
esac
|
|
105
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
106
|
+
}
|
|
107
|
+
|
|
94
108
|
_postman_collection() {
|
|
95
109
|
if [[ -z "$subcmd" ]]; then
|
|
96
110
|
if [[ "$cur" == -* ]]; then
|
|
@@ -143,7 +157,7 @@ _postman_collection_ai_readiness() {
|
|
|
143
157
|
|
|
144
158
|
_postman_collection_run() {
|
|
145
159
|
if [[ "$cur" == -* ]]; then
|
|
146
|
-
COMPREPLY=( $(compgen -W "-e --environment -g --globals -r --reporters --output --reporter-json-structure -n --iteration-count -d --iteration-data --iteration-data-dataset --iteration-data-view --dataset -i --global-var --env-var --integration-id --postman-api-key --alias --bail --ignore-redirects -x --suppress-exit-code --silent --disable-unicode --delay-request --timeout --timeout-request --timeout-script --working-dir --no-insecure-file-read -k --insecure --ssl-client-cert-list --ssl-client-cert --ssl-client-key --ssl-client-passphrase --ssl-extra-ca-certs --cookie-jar --export-cookie-jar --verbose --mock --port --simulate --report-events -h --help --reporter-json-export --reporter-junit-export --reporter-html-export --reporter-json-omitRequestBodies --reporter-html-omitRequestBodies --reporter-json-omitResponseBodies --reporter-html-omitResponseBodies --reporter-json-omitHeaders --reporter-html-omitHeaders --reporter-json-omitAllHeadersAndBody --reporter-html-omitAllHeadersAndBody" -- "$cur") )
|
|
160
|
+
COMPREPLY=( $(compgen -W "-e --environment -g --globals -r --reporters --output --reporter-json-structure -n --iteration-count -d --iteration-data --iteration-data-dataset --iteration-data-view --dataset -i --global-var --env-var --integration-id --postman-api-key --alias --bail --ignore-redirects -x --suppress-exit-code --silent --disable-unicode --delay-request --timeout --timeout-request --timeout-script --working-dir --no-insecure-file-read -k --insecure --ssl-client-cert-list --ssl-client-cert --ssl-client-key --ssl-client-passphrase --ssl-extra-ca-certs --cookie-jar --export-cookie-jar --verbose --mock --port --use-mock --simulate --report-events --no-report-events -h --help --reporter-json-export --reporter-junit-export --reporter-html-export --reporter-json-omitRequestBodies --reporter-html-omitRequestBodies --reporter-json-omitResponseBodies --reporter-html-omitResponseBodies --reporter-json-omitHeaders --reporter-html-omitHeaders --reporter-json-omitAllHeadersAndBody --reporter-html-omitAllHeadersAndBody" -- "$cur") )
|
|
147
161
|
return 0
|
|
148
162
|
fi
|
|
149
163
|
case "$prev" in
|
|
@@ -308,7 +322,7 @@ _postman_runner() {
|
|
|
308
322
|
|
|
309
323
|
_postman_runner_start() {
|
|
310
324
|
if [[ "$cur" == -* ]]; then
|
|
311
|
-
COMPREPLY=( $(compgen -W "--id --key --region --proxy --egress-proxy --egress-proxy-authz-url --ssl-extra-ca-certs --metrics --metrics-port --report-events -h --help" -- "$cur") )
|
|
325
|
+
COMPREPLY=( $(compgen -W "--id --key --region --proxy --egress-proxy --egress-proxy-authz-url --ssl-extra-ca-certs --metrics --metrics-port --report-events --no-report-events -h --help" -- "$cur") )
|
|
312
326
|
return 0
|
|
313
327
|
fi
|
|
314
328
|
case "$prev" in
|
|
@@ -338,7 +352,7 @@ _postman_spec() {
|
|
|
338
352
|
|
|
339
353
|
_postman_spec_lint() {
|
|
340
354
|
if [[ "$cur" == -* ]]; then
|
|
341
|
-
COMPREPLY=( $(compgen -W "-f --fail-severity -o --output --workspace-id --report-events -h --help" -- "$cur") )
|
|
355
|
+
COMPREPLY=( $(compgen -W "-f --fail-severity -o --output --workspace-id --report-events --no-report-events -h --help" -- "$cur") )
|
|
342
356
|
return 0
|
|
343
357
|
fi
|
|
344
358
|
case "$prev" in
|
|
@@ -382,7 +396,7 @@ _postman_workspace() {
|
|
|
382
396
|
if [[ "$cur" == -* ]]; then
|
|
383
397
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
384
398
|
else
|
|
385
|
-
COMPREPLY=( $(compgen -W "list prepare push lint pull connect-git" -- "$cur") )
|
|
399
|
+
COMPREPLY=( $(compgen -W "list prepare push lint create pull connect-git" -- "$cur") )
|
|
386
400
|
fi
|
|
387
401
|
return 0
|
|
388
402
|
fi
|
|
@@ -391,6 +405,7 @@ _postman_workspace() {
|
|
|
391
405
|
prepare) _postman_workspace_prepare ;;
|
|
392
406
|
push) _postman_workspace_push ;;
|
|
393
407
|
lint) _postman_workspace_lint ;;
|
|
408
|
+
create) _postman_workspace_create ;;
|
|
394
409
|
pull) _postman_workspace_pull ;;
|
|
395
410
|
connect-git) _postman_workspace_connect_git ;;
|
|
396
411
|
esac
|
|
@@ -414,7 +429,7 @@ _postman_workspace_prepare() {
|
|
|
414
429
|
|
|
415
430
|
_postman_workspace_push() {
|
|
416
431
|
if [[ "$cur" == -* ]]; then
|
|
417
|
-
COMPREPLY=( $(compgen -W "--no-prepare -y --yes --push-strategy --verbose --report-events -h --help" -- "$cur") )
|
|
432
|
+
COMPREPLY=( $(compgen -W "--no-prepare -y --yes --push-strategy --verbose --report-events --no-report-events -h --help" -- "$cur") )
|
|
418
433
|
return 0
|
|
419
434
|
fi
|
|
420
435
|
case "$prev" in
|
|
@@ -430,6 +445,18 @@ _postman_workspace_lint() {
|
|
|
430
445
|
esac
|
|
431
446
|
}
|
|
432
447
|
|
|
448
|
+
_postman_workspace_create() {
|
|
449
|
+
if [[ "$cur" == -* ]]; then
|
|
450
|
+
COMPREPLY=( $(compgen -W "--visibility --name --summary --path --no-connect --force -h --help" -- "$cur") )
|
|
451
|
+
return 0
|
|
452
|
+
fi
|
|
453
|
+
case "$prev" in
|
|
454
|
+
--path)
|
|
455
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
456
|
+
return 0 ;;
|
|
457
|
+
esac
|
|
458
|
+
}
|
|
459
|
+
|
|
433
460
|
_postman_workspace_pull() {
|
|
434
461
|
if [[ "$cur" == -* ]]; then
|
|
435
462
|
COMPREPLY=( $(compgen -W "-y --yes --source-workspace --verbose -h --help" -- "$cur") )
|
|
@@ -463,7 +490,7 @@ _postman_performance() {
|
|
|
463
490
|
|
|
464
491
|
_postman_performance_run() {
|
|
465
492
|
if [[ "$cur" == -* ]]; then
|
|
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") )
|
|
493
|
+
COMPREPLY=( $(compgen -W "-e --environment -g --globals --setup-collection --teardown-collection --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") )
|
|
467
494
|
return 0
|
|
468
495
|
fi
|
|
469
496
|
case "$prev" in
|
|
@@ -538,7 +565,7 @@ _postman_flows_deploy() {
|
|
|
538
565
|
|
|
539
566
|
_postman_flows_run() {
|
|
540
567
|
if [[ "$cur" == -* ]]; then
|
|
541
|
-
COMPREPLY=( $(compgen -W "-i --input -f --input-file -s --scenario --iteration-data-dataset --iteration-data-view -m --map-column -e --environment --working-dir --no-insecure-file-read --verbose --no-truncate --output --reporters -x --suppress-exit-code --workspace --verbose --debug --json -h --help" -- "$cur") )
|
|
568
|
+
COMPREPLY=( $(compgen -W "-i --input -f --input-file -s --scenario --iteration-data-dataset --iteration-data-view -m --map-column -e --environment --working-dir --no-insecure-file-read --verbose --no-truncate --output --reporters -x --suppress-exit-code --workspace --report-events --no-report-events --verbose --debug --json -h --help" -- "$cur") )
|
|
542
569
|
return 0
|
|
543
570
|
fi
|
|
544
571
|
case "$prev" in
|
|
@@ -590,7 +617,7 @@ _postman_flows_get_run() {
|
|
|
590
617
|
|
|
591
618
|
_postman_request() {
|
|
592
619
|
if [[ "$cur" == -* ]]; then
|
|
593
|
-
COMPREPLY=( $(compgen -W "-H --header -d --body -f --form -e --environment --timeout --redirects-ignore --redirects-max --redirects-follow-method --redirects-remove-referrer --retry --retry-delay --script-pre-request --script-post-request --dataset -o --output --verbose --response-only --debug -h --help --auth-basic-username --auth-basic-password --auth-bearer-token --auth-digest-username --auth-digest-password --auth-oauth1-consumerKey --auth-oauth1-consumerSecret --auth-oauth1-token --auth-oauth1-tokenSecret --auth-oauth2-accessToken --auth-oauth2-tokenType --auth-hawk-authId --auth-hawk-authKey --auth-hawk-algorithm --auth-aws-accessKey --auth-aws-secretKey --auth-aws-region --auth-aws-service --auth-aws-sessionToken --auth-ntlm-username --auth-ntlm-password --auth-ntlm-domain --auth-ntlm-workstation --auth-apikey-key --auth-apikey-value --auth-apikey-in" -- "$cur") )
|
|
620
|
+
COMPREPLY=( $(compgen -W "-H --header -d --body -f --form -e --environment --timeout --redirects-ignore --redirects-max --redirects-follow-method --redirects-remove-referrer --retry --retry-delay --script-pre-request --script-post-request --dataset -o --output --verbose --response-only --debug --report-events --no-report-events -h --help --auth-basic-username --auth-basic-password --auth-bearer-token --auth-digest-username --auth-digest-password --auth-oauth1-consumerKey --auth-oauth1-consumerSecret --auth-oauth1-token --auth-oauth1-tokenSecret --auth-oauth2-accessToken --auth-oauth2-tokenType --auth-hawk-authId --auth-hawk-authKey --auth-hawk-algorithm --auth-aws-accessKey --auth-aws-secretKey --auth-aws-region --auth-aws-service --auth-aws-sessionToken --auth-ntlm-username --auth-ntlm-password --auth-ntlm-domain --auth-ntlm-workstation --auth-apikey-key --auth-apikey-value --auth-apikey-in" -- "$cur") )
|
|
594
621
|
return 0
|
|
595
622
|
fi
|
|
596
623
|
case "$prev" in
|
|
@@ -724,22 +751,24 @@ _postman_mock() {
|
|
|
724
751
|
if [[ "$cur" == -* ]]; then
|
|
725
752
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
726
753
|
else
|
|
727
|
-
COMPREPLY=( $(compgen -W "generate run get list delete" -- "$cur") )
|
|
754
|
+
COMPREPLY=( $(compgen -W "generate run deploy get list log delete" -- "$cur") )
|
|
728
755
|
fi
|
|
729
756
|
return 0
|
|
730
757
|
fi
|
|
731
758
|
case "$subcmd" in
|
|
732
759
|
generate) _postman_mock_generate ;;
|
|
733
760
|
run) _postman_mock_run ;;
|
|
761
|
+
deploy) _postman_mock_deploy ;;
|
|
734
762
|
get) _postman_mock_get ;;
|
|
735
763
|
list) _postman_mock_list ;;
|
|
764
|
+
log) _postman_mock_log ;;
|
|
736
765
|
delete) _postman_mock_delete ;;
|
|
737
766
|
esac
|
|
738
767
|
}
|
|
739
768
|
|
|
740
769
|
_postman_mock_generate() {
|
|
741
770
|
if [[ "$cur" == -* ]]; then
|
|
742
|
-
COMPREPLY=( $(compgen -W "-o --output -n --name --port --force -u --update -x --suppress-exit-code -h --help" -- "$cur") )
|
|
771
|
+
COMPREPLY=( $(compgen -W "-o --output -n --name --port --force -u --update -w --workspace --api-key -x --suppress-exit-code -h --help" -- "$cur") )
|
|
743
772
|
return 0
|
|
744
773
|
fi
|
|
745
774
|
case "$prev" in
|
|
@@ -749,12 +778,15 @@ _postman_mock_generate() {
|
|
|
749
778
|
-u|--update)
|
|
750
779
|
_postman_filematch '!*.@(json)' "$cur"
|
|
751
780
|
return 0 ;;
|
|
781
|
+
--api-key)
|
|
782
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
783
|
+
return 0 ;;
|
|
752
784
|
esac
|
|
753
785
|
}
|
|
754
786
|
|
|
755
787
|
_postman_mock_run() {
|
|
756
788
|
if [[ "$cur" == -* ]]; then
|
|
757
|
-
COMPREPLY=( $(compgen -W "-e --environment -g --globals -p --port -h --help" -- "$cur") )
|
|
789
|
+
COMPREPLY=( $(compgen -W "-e --environment -g --globals -p --port --api-key -h --help" -- "$cur") )
|
|
758
790
|
return 0
|
|
759
791
|
fi
|
|
760
792
|
case "$prev" in
|
|
@@ -764,31 +796,75 @@ _postman_mock_run() {
|
|
|
764
796
|
-g|--globals)
|
|
765
797
|
_postman_filematch '!*.@(json)' "$cur"
|
|
766
798
|
return 0 ;;
|
|
799
|
+
--api-key)
|
|
800
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
801
|
+
return 0 ;;
|
|
802
|
+
esac
|
|
803
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
_postman_mock_deploy() {
|
|
807
|
+
if [[ "$cur" == -* ]]; then
|
|
808
|
+
COMPREPLY=( $(compgen -W "-w --workspace -n --name -s --slug --public --auto-deploy -y --yes --api-key -h --help" -- "$cur") )
|
|
809
|
+
return 0
|
|
810
|
+
fi
|
|
811
|
+
case "$prev" in
|
|
812
|
+
--api-key)
|
|
813
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
814
|
+
return 0 ;;
|
|
767
815
|
esac
|
|
768
816
|
_postman_filematch '!*.@(json)' "$cur"
|
|
769
817
|
}
|
|
770
818
|
|
|
771
819
|
_postman_mock_get() {
|
|
772
820
|
if [[ "$cur" == -* ]]; then
|
|
773
|
-
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
821
|
+
COMPREPLY=( $(compgen -W "--api-key --json -h --help" -- "$cur") )
|
|
774
822
|
return 0
|
|
775
823
|
fi
|
|
824
|
+
case "$prev" in
|
|
825
|
+
--api-key)
|
|
826
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
827
|
+
return 0 ;;
|
|
828
|
+
esac
|
|
776
829
|
_postman_filematch '!*.@(json)' "$cur"
|
|
777
830
|
}
|
|
778
831
|
|
|
779
832
|
_postman_mock_list() {
|
|
780
833
|
if [[ "$cur" == -* ]]; then
|
|
781
|
-
COMPREPLY=( $(compgen -W "--json -h --help" -- "$cur") )
|
|
834
|
+
COMPREPLY=( $(compgen -W "-w --workspace --api-key --json -h --help" -- "$cur") )
|
|
782
835
|
return 0
|
|
783
836
|
fi
|
|
837
|
+
case "$prev" in
|
|
838
|
+
--api-key)
|
|
839
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
840
|
+
return 0 ;;
|
|
841
|
+
esac
|
|
842
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
843
|
+
}
|
|
844
|
+
|
|
845
|
+
_postman_mock_log() {
|
|
846
|
+
if [[ "$cur" == -* ]]; then
|
|
847
|
+
COMPREPLY=( $(compgen -W "--limit --method --status --path --since --until --api-key --json -h --help" -- "$cur") )
|
|
848
|
+
return 0
|
|
849
|
+
fi
|
|
850
|
+
case "$prev" in
|
|
851
|
+
--api-key)
|
|
852
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
853
|
+
return 0 ;;
|
|
854
|
+
esac
|
|
784
855
|
_postman_filematch '!*.@(json)' "$cur"
|
|
785
856
|
}
|
|
786
857
|
|
|
787
858
|
_postman_mock_delete() {
|
|
788
859
|
if [[ "$cur" == -* ]]; then
|
|
789
|
-
COMPREPLY=( $(compgen -W "-y --yes -h --help" -- "$cur") )
|
|
860
|
+
COMPREPLY=( $(compgen -W "-y --yes --api-key -h --help" -- "$cur") )
|
|
790
861
|
return 0
|
|
791
862
|
fi
|
|
863
|
+
case "$prev" in
|
|
864
|
+
--api-key)
|
|
865
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
866
|
+
return 0 ;;
|
|
867
|
+
esac
|
|
792
868
|
_postman_filematch '!*.@(json)' "$cur"
|
|
793
869
|
}
|
|
794
870
|
|
|
@@ -819,7 +895,7 @@ _postman_application_init() {
|
|
|
819
895
|
|
|
820
896
|
_postman_application_test() {
|
|
821
897
|
if [[ "$cur" == -* ]]; then
|
|
822
|
-
COMPREPLY=( $(compgen -W "--target --target-collection --target-environment --command --deployed-version --network-log --capture-only --output --force --report-events --verbose -h --help" -- "$cur") )
|
|
898
|
+
COMPREPLY=( $(compgen -W "--target --target-collection --target-environment --command --deployed-version --network-log --capture-only --output --force --report-events --no-report-events --verbose -h --help" -- "$cur") )
|
|
823
899
|
return 0
|
|
824
900
|
fi
|
|
825
901
|
case "$prev" in
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Fish completion for Postman CLI (postman v1.
|
|
1
|
+
# Fish completion for Postman CLI (postman v1.54.1)
|
|
2
2
|
# Auto-generated by scripts/generate.mjs — DO NOT EDIT
|
|
3
3
|
# Source: spec/commands.json
|
|
4
4
|
# https://github.com/yokawasa/postman-cli-completion
|
|
5
5
|
|
|
6
6
|
function __postman_no_subcommand
|
|
7
|
-
not __fish_seen_subcommand_from login logout collection environment globals api runner spec monitor workspace ws performance flows fl request sdk mock application app simulate context search webhook dataset
|
|
7
|
+
not __fish_seen_subcommand_from login logout init collection environment globals 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
|
|
@@ -23,6 +23,7 @@ complete -c postman -n __postman_no_subcommand -s h -l help -d 'display help for
|
|
|
23
23
|
# ---------- Top-level commands ----------
|
|
24
24
|
complete -c postman -n __postman_no_subcommand -a login -d 'Authenticate with Postman to access your resources.'
|
|
25
25
|
complete -c postman -n __postman_no_subcommand -a logout -d 'Delete the stored Postman API key.'
|
|
26
|
+
complete -c postman -n __postman_no_subcommand -a init -d 'Set up Postman artifacts and agent instructions in a repository.'
|
|
26
27
|
complete -c postman -n __postman_no_subcommand -a collection -d 'Run and test your Postman collections directly from the command line.'
|
|
27
28
|
complete -c postman -n __postman_no_subcommand -a environment -d 'Work with local Postman environments from the command line.'
|
|
28
29
|
complete -c postman -n __postman_no_subcommand -a globals -d 'Work with local Postman globals from the command line.'
|
|
@@ -37,14 +38,14 @@ complete -c postman -n __postman_no_subcommand -a flows -d 'Manage and interact
|
|
|
37
38
|
complete -c postman -n __postman_no_subcommand -a fl -d 'Alias for flows'
|
|
38
39
|
complete -c postman -n __postman_no_subcommand -a request -d 'Send HTTP requests from the command line with full Postman capabilities including authentication, environment variables, assertions, retries, and detailed output control.'
|
|
39
40
|
complete -c postman -n __postman_no_subcommand -a sdk -d 'Generate and manage your SDKs directly from the command line.'
|
|
40
|
-
complete -c postman -n __postman_no_subcommand -a mock -d 'Run and manage
|
|
41
|
+
complete -c postman -n __postman_no_subcommand -a mock -d 'Run and manage Postman mocks, locally and in the cloud.'
|
|
41
42
|
complete -c postman -n __postman_no_subcommand -a application -d 'Application-level commands: initialise config and run tests.'
|
|
42
43
|
complete -c postman -n __postman_no_subcommand -a app -d 'Alias for application'
|
|
43
44
|
complete -c postman -n __postman_no_subcommand -a simulate -d 'Start mock servers with simulated failure scenarios.'
|
|
44
45
|
complete -c postman -n __postman_no_subcommand -a context -d '[Beta] Get API context for AI coding agents directly from the command line.'
|
|
45
46
|
complete -c postman -n __postman_no_subcommand -a search -d 'Search for Postman element types (requests, collections, workspaces, and more).'
|
|
46
47
|
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 '
|
|
48
|
+
complete -c postman -n __postman_no_subcommand -a dataset -d 'Work with Postman datasets in local YAML files or the cloud.'
|
|
48
49
|
|
|
49
50
|
# ---------- login ----------
|
|
50
51
|
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
|
|
@@ -57,6 +58,17 @@ complete -c postman -n '__fish_seen_subcommand_from login' -s h -l help -d 'disp
|
|
|
57
58
|
complete -c postman -n '__fish_seen_subcommand_from logout' -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
|
|
58
59
|
complete -c postman -n '__fish_seen_subcommand_from logout' -s h -l help -d 'display help for command'
|
|
59
60
|
|
|
61
|
+
# ---------- init ----------
|
|
62
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -l json -d 'Emit machine-readable output for agents'
|
|
63
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -l dry-run -d 'Report what would happen without writing anything'
|
|
64
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -l no-seed -d 'Do not derive a spec from source'
|
|
65
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -l spec -d 'Which spec is authoritative, when more than one could be' -r
|
|
66
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -l visibility -d 'Create and bind a workspace non-interactively (personal or team)' -x
|
|
67
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -l no-cloud -d 'Skip the workspace step entirely'
|
|
68
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -l report-events -d 'Send init analytics to Postman (requires login)'
|
|
69
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -s h -l help -d 'display help for command'
|
|
70
|
+
complete -c postman -n '__fish_seen_subcommand_from init' -r -k -a '(__fish_complete_suffix .json)'
|
|
71
|
+
|
|
60
72
|
# ---------- collection ----------
|
|
61
73
|
complete -c postman -n '__postman_using_subcommand collection migrate lint ai-readiness run' -a migrate -d 'Migrate a v2.1 collection to the v3 format'
|
|
62
74
|
complete -c postman -n '__postman_using_subcommand collection migrate lint ai-readiness run' -a lint -d 'Run linting on a local v3 collection at the given file or directory path.'
|
|
@@ -116,8 +128,10 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
116
128
|
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'
|
|
117
129
|
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
|
|
118
130
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l port -d 'Port for the --mock server; pass "auto" for an OS-assigned ephemeral port (default: configured port, falls back to an ephemeral one if busy). Only valid with --mock.' -x
|
|
131
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l use-mock -d 'Redirect requests for a URL or {{variable}} to a mock during the run. Format: "<url> mock|mock-server:<path|id> [scenario]". Repeat the flag to redirect multiple URLs (one --use-mock per mock). Use "mock:<path>" for a local mock manifest (.json/.yaml/.yml), "mock:<id>" for a local mock by id (fetched from the cloud then run locally), or "mock-server:<id>" to redirect to a deployed mock server\'s URL. Id-based references require `postman login` (or --postman-api-key). The optional third field selects a scenario (defaults to "default"). (default: [])' -x
|
|
119
132
|
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
|
|
120
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l report-events -d '
|
|
133
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l report-events -d 'Upload results for git-native v3 collection runs. Analytics are sent by default'
|
|
134
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l no-report-events -d 'Do not send analytics to Postman'
|
|
121
135
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
122
136
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l reporter-json-export -d 'Path to save the report for the given reporter.' -r
|
|
123
137
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l reporter-junit-export -d 'Path to save the report for the given reporter.' -r
|
|
@@ -181,7 +195,8 @@ complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subc
|
|
|
181
195
|
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -l ssl-extra-ca-certs -d 'Additional trusted CA certificates (PEM file, can contain multiple certs)' -r
|
|
182
196
|
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -l metrics -d 'Enable the metrics server for health checks'
|
|
183
197
|
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -l metrics-port -d 'Port for the metrics server (default: "9090")' -x
|
|
184
|
-
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -l report-events -d '
|
|
198
|
+
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -l report-events -d 'Accepted for compatibility; analytics are sent by default'
|
|
199
|
+
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -l no-report-events -d 'Do not send analytics to Postman'
|
|
185
200
|
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -s h -l help -d 'display help for command'
|
|
186
201
|
|
|
187
202
|
# ---------- spec ----------
|
|
@@ -192,7 +207,8 @@ complete -c postman -n '__fish_seen_subcommand_from spec' -s h -l help -d 'displ
|
|
|
192
207
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -s f -l fail-severity -d 'Results of this level or above will trigger a failure exit code. [choices: "error", "warning", "info", "hint"] (default: "ERROR")' -x
|
|
193
208
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -s o -l output -d 'Output format for the results. [choices: "json", "csv"]' -x
|
|
194
209
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -l workspace-id -d 'The workspace ID to use for fetching governance rulesets.' -x
|
|
195
|
-
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -l report-events -d '
|
|
210
|
+
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -l report-events -d 'Accepted for compatibility; analytics are sent by default'
|
|
211
|
+
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -l no-report-events -d 'Do not send analytics to Postman'
|
|
196
212
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -s h -l help -d 'display help for command'
|
|
197
213
|
# ---------- spec ai-readiness ----------
|
|
198
214
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from ai-readiness' -s o -l output -d 'Output format for the results. [choices: "cli", "json", "html"]' -x
|
|
@@ -208,12 +224,13 @@ complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_sub
|
|
|
208
224
|
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
225
|
|
|
210
226
|
# ---------- workspace ----------
|
|
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
|
|
216
|
-
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint pull connect-git' -a
|
|
227
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint create pull connect-git' -a list -d 'List all available Postman Workspaces'
|
|
228
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint create pull connect-git' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
229
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint create pull connect-git' -a push -d 'Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
230
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint create 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.'
|
|
231
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint create pull connect-git' -a create -d 'Create a Postman workspace and bind it to this git repository.'
|
|
232
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint create pull connect-git' -a pull -d 'Pull workspace entities from a Postman workspace into the local git-native folder.'
|
|
233
|
+
complete -c postman -n '__postman_using_subcommand workspace list prepare push lint create pull connect-git' -a connect-git -d 'Connect a Postman workspace to a local git repository.'
|
|
217
234
|
complete -c postman -n '__fish_seen_subcommand_from workspace' -s h -l help -d 'display help for command'
|
|
218
235
|
# ---------- workspace list ----------
|
|
219
236
|
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
|
|
@@ -230,7 +247,8 @@ complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_s
|
|
|
230
247
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -s y -l yes -d 'Skip all confirmation prompts'
|
|
231
248
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l push-strategy -d 'Push strategy. "force-sync": mirror the whole workspace — also DELETE cloud entities that have no local counterpart (destructive). Defaults to "default" (create/update only).' -x
|
|
232
249
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l verbose -d 'Show detailed logging'
|
|
233
|
-
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l report-events -d '
|
|
250
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l report-events -d 'Accepted for compatibility; analytics are sent by default'
|
|
251
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l no-report-events -d 'Do not send analytics to Postman'
|
|
234
252
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -s h -l help -d 'display help for command'
|
|
235
253
|
# ---------- workspace lint ----------
|
|
236
254
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -s f -l fail-severity -d 'Exit with failure if diagnostics at this level or above are present. [choices: "error", "warning", "info", "hint"] (default: "error")' -x
|
|
@@ -239,6 +257,14 @@ complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_s
|
|
|
239
257
|
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
258
|
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.'
|
|
241
259
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -s h -l help -d 'display help for command'
|
|
260
|
+
# ---------- workspace create ----------
|
|
261
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from create' -l visibility -d 'Required. Workspace visibility, e.g. personal or team' -x
|
|
262
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from create' -l name -d 'Workspace name (defaults to owner/repo from the git remote)' -x
|
|
263
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from create' -l summary -d 'Optional workspace summary' -x
|
|
264
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from create' -l path -d 'Directory to bind (defaults to the current directory)' -r
|
|
265
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from create' -l no-connect -d 'Create the workspace without binding it to the repository'
|
|
266
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from create' -l force -d 'Create even when a workspace is already recorded for this repo'
|
|
267
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from create' -s h -l help -d 'display help for command'
|
|
242
268
|
# ---------- workspace pull ----------
|
|
243
269
|
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
270
|
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
|
|
@@ -255,6 +281,8 @@ complete -c postman -n '__fish_seen_subcommand_from performance' -s h -l help -d
|
|
|
255
281
|
# ---------- performance run ----------
|
|
256
282
|
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
|
|
257
283
|
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
|
|
284
|
+
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l setup-collection -d 'Collection UID to run before the Postman Cloud performance test' -x
|
|
285
|
+
complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l teardown-collection -d 'Collection UID to run after the Postman Cloud performance test' -x
|
|
258
286
|
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
|
|
259
287
|
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
|
|
260
288
|
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
|
|
@@ -323,6 +351,8 @@ complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subco
|
|
|
323
351
|
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l reporters -d 'Save a test results report to a file (supported: html)' -x
|
|
324
352
|
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -s x -l suppress-exit-code -d 'Specify whether or not to override the default exit code for the current run'
|
|
325
353
|
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l workspace -d 'Workspace ID required for flows that contain connector blocks. Find it in the Postman app URL: https://postman.com/workspace/<workspaceId>' -x
|
|
354
|
+
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l report-events -d 'Accepted for compatibility; analytics are sent by default'
|
|
355
|
+
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l no-report-events -d 'Do not send analytics to Postman'
|
|
326
356
|
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l verbose -d 'Verbose output'
|
|
327
357
|
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l debug -d 'Debug output'
|
|
328
358
|
complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l json -d 'JSON output'
|
|
@@ -371,6 +401,8 @@ complete -c postman -n '__fish_seen_subcommand_from request' -s o -l output -d '
|
|
|
371
401
|
complete -c postman -n '__fish_seen_subcommand_from request' -l verbose -d 'Show detailed request and response information including headers, body, and metadata.'
|
|
372
402
|
complete -c postman -n '__fish_seen_subcommand_from request' -l response-only -d 'suppress all output except response body. Useful for piping to other commands.'
|
|
373
403
|
complete -c postman -n '__fish_seen_subcommand_from request' -l debug -d 'Debug mode: show detailed execution information including retry attempts, redirects, and timing breakdowns.'
|
|
404
|
+
complete -c postman -n '__fish_seen_subcommand_from request' -l report-events -d 'Accepted for compatibility; analytics are sent by default'
|
|
405
|
+
complete -c postman -n '__fish_seen_subcommand_from request' -l no-report-events -d 'Do not send analytics to Postman'
|
|
374
406
|
complete -c postman -n '__fish_seen_subcommand_from request' -s h -l help -d 'display help for command'
|
|
375
407
|
complete -c postman -n '__fish_seen_subcommand_from request' -l auth-basic-username -d 'Supply authentication parameters dynamically.' -x
|
|
376
408
|
complete -c postman -n '__fish_seen_subcommand_from request' -l auth-basic-password -d 'Supply authentication parameters dynamically.' -x
|
|
@@ -474,11 +506,13 @@ complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcomm
|
|
|
474
506
|
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'
|
|
475
507
|
|
|
476
508
|
# ---------- mock ----------
|
|
477
|
-
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a generate -d 'Generate a
|
|
478
|
-
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a run -d 'Start a local mock server
|
|
479
|
-
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a
|
|
480
|
-
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a
|
|
481
|
-
complete -c postman -n '__postman_using_subcommand mock generate run get list delete' -a
|
|
509
|
+
complete -c postman -n '__postman_using_subcommand mock generate run deploy get list log delete' -a generate -d 'Generate a 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. Writes a local mock by default, or a cloud mock with --workspace.'
|
|
510
|
+
complete -c postman -n '__postman_using_subcommand mock generate run deploy get list log delete' -a run -d 'Start a local mock server from a cloud mock id (fetched and run locally), a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.'
|
|
511
|
+
complete -c postman -n '__postman_using_subcommand mock generate run deploy get list log delete' -a deploy -d 'Deploy a cloud mock into a mock server.'
|
|
512
|
+
complete -c postman -n '__postman_using_subcommand mock generate run deploy get list log delete' -a get -d 'Show a mock\'s details: a cloud mock by id, or a local mock by path.'
|
|
513
|
+
complete -c postman -n '__postman_using_subcommand mock generate run deploy get list log delete' -a list -d 'List a workspace\'s cloud mocks, or (with a path) local mocks under a directory.'
|
|
514
|
+
complete -c postman -n '__postman_using_subcommand mock generate run deploy get list log delete' -a log -d 'Browse a deployed mock server\'s request/response logs by its id (see `mock get`).'
|
|
515
|
+
complete -c postman -n '__postman_using_subcommand mock generate run deploy get list log delete' -a delete -d 'Permanently remove a mock: a cloud mock by id, or a local mock artifact by path.'
|
|
482
516
|
complete -c postman -n '__fish_seen_subcommand_from mock' -s h -l help -d 'display help for command'
|
|
483
517
|
# ---------- mock generate ----------
|
|
484
518
|
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
|
|
@@ -486,24 +520,52 @@ complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcom
|
|
|
486
520
|
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
|
|
487
521
|
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'
|
|
488
522
|
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
|
|
523
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -s w -l workspace -d 'Create a cloud mock in this Postman workspace instead of a local mock. Cannot be combined with --output/--force/--update.' -x
|
|
524
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -l api-key -d 'Postman API key for --workspace (defaults to the `postman login` session)' -r
|
|
489
525
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -s x -l suppress-exit-code -d 'Always exit with code 0, even on failure'
|
|
490
526
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -s h -l help -d 'display help for command'
|
|
491
527
|
# ---------- mock run ----------
|
|
492
528
|
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
|
|
493
529
|
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
|
|
494
530
|
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
|
|
531
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -l api-key -d 'Postman API key for cloud mock ids (defaults to the `postman login` session)' -r
|
|
495
532
|
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
533
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -r -k -a '(__fish_complete_suffix .json)'
|
|
534
|
+
# ---------- mock deploy ----------
|
|
535
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -s w -l workspace -d 'Workspace that will own the mock server (defaults to the workspace linked in .postman/resources.yaml)' -x
|
|
536
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -s n -l name -d 'Display name for the mock server (prompts when omitted)' -x
|
|
537
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -s s -l slug -d 'Slug for the deploy URL (prompts when omitted)' -x
|
|
538
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -l public -d 'Deploy as a public mock (default is private; requires an x-api-key header)'
|
|
539
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -l auto-deploy -d 'Re-deploy the mock automatically whenever it changes (default off)'
|
|
540
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -s y -l yes -d 'Accept defaults and skip all prompts (private, no auto-deploy)'
|
|
541
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
542
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -s h -l help -d 'display help for command'
|
|
543
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from deploy' -r -k -a '(__fish_complete_suffix .json)'
|
|
497
544
|
# ---------- mock get ----------
|
|
545
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from get' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
498
546
|
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
547
|
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
548
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from get' -r -k -a '(__fish_complete_suffix .json)'
|
|
501
549
|
# ---------- mock list ----------
|
|
550
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from list' -s w -l workspace -d 'Workspace whose cloud mocks to list (defaults to the workspace linked in .postman/resources.yaml)' -x
|
|
551
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from list' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
502
552
|
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
553
|
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
554
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from list' -r -k -a '(__fish_complete_suffix .json)'
|
|
555
|
+
# ---------- mock log ----------
|
|
556
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l limit -d 'Maximum number of log entries to show (default 50 for --json/non-interactive output)' -x
|
|
557
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l method -d 'Filter by HTTP method (e.g. GET, POST)' -x
|
|
558
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l status -d 'Filter by response status (e.g. 404 or 5xx)' -x
|
|
559
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l path -d 'Filter by request path (supports * and ? wildcards)' -x
|
|
560
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l since -d 'Show logs from this long ago onward (e.g. 2h = the last 2 hours)' -x
|
|
561
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l until -d 'Stop this long ago (e.g. 30m = exclude the most recent 30 minutes)' -x
|
|
562
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
563
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -l json -d 'Output logs as JSON instead of the interactive pager'
|
|
564
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -s h -l help -d 'display help for command'
|
|
565
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from log' -r -k -a '(__fish_complete_suffix .json)'
|
|
505
566
|
# ---------- mock delete ----------
|
|
506
567
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from delete' -s y -l yes -d 'Skip the confirmation prompt'
|
|
568
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from delete' -l api-key -d 'Postman API key for cloud mock ids (defaults to the `postman login` session)' -r
|
|
507
569
|
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
570
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from delete' -r -k -a '(__fish_complete_suffix .json)'
|
|
509
571
|
|
|
@@ -530,7 +592,8 @@ complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen
|
|
|
530
592
|
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l capture-only -d 'Skip collection matching and tests; capture traffic and save a V3 collection organised by host'
|
|
531
593
|
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l output -d 'Output directory for captured collection (default: pm-results/captured/; used with --capture-only)' -r
|
|
532
594
|
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l force -d 'Overwrite the output directory if it exists and is not empty (used with --capture-only)'
|
|
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
|
|
595
|
+
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l report-events -d 'Send application test run results to Postman (default: true)' -x
|
|
596
|
+
complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l no-report-events -d 'Do not send run results or analytics to Postman'
|
|
534
597
|
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'
|
|
535
598
|
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
599
|
# ---------- application setup-capture ----------
|
|
@@ -703,13 +766,13 @@ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_sub
|
|
|
703
766
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -s h -l help -d 'display help for command'
|
|
704
767
|
|
|
705
768
|
# ---------- dataset ----------
|
|
706
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a list -d '
|
|
707
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a get -d '
|
|
708
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a query -d '
|
|
709
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a create -d '
|
|
710
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a delete -d '
|
|
711
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a source -d '
|
|
712
|
-
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a view -d '
|
|
769
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a list -d 'List local dataset YAMLs under a path, or (no path) a workspace\'s cloud datasets.'
|
|
770
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a get -d 'Print a dataset\'s metadata and structure summary (local YAML path or cloud id).'
|
|
771
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a query -d 'Run an ad-hoc SQL query against a dataset (local YAML path or cloud id).'
|
|
772
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a create -d 'Scaffold a new .dataset.yaml at <path>, or (no path, with -w) create a cloud dataset.'
|
|
773
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a delete -d 'Permanently remove a dataset: a local .dataset.yaml or a cloud dataset id.'
|
|
774
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a source -d 'Inspect and manage a dataset\'s datasources.'
|
|
775
|
+
complete -c postman -n '__postman_using_subcommand dataset list get query create delete source view' -a view -d 'Inspect and manage saved views on a dataset.'
|
|
713
776
|
complete -c postman -n '__fish_seen_subcommand_from dataset' -s h -l help -d 'display help for command'
|
|
714
777
|
# ---------- dataset list ----------
|
|
715
778
|
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
|
|
@@ -744,10 +807,10 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
744
807
|
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
|
|
745
808
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from delete' -s h -l help -d 'display help for command'
|
|
746
809
|
# ---------- dataset source ----------
|
|
747
|
-
complete -c postman -n '__postman_using_subcommand source list add remove update' -a list -d '
|
|
748
|
-
complete -c postman -n '__postman_using_subcommand source list add remove update' -a add -d '
|
|
749
|
-
complete -c postman -n '__postman_using_subcommand source list add remove update' -a remove -d '
|
|
750
|
-
complete -c postman -n '__postman_using_subcommand source list add remove update' -a update -d '
|
|
810
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a list -d 'List the datasources defined on a dataset (local YAML path or cloud id).'
|
|
811
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a add -d 'Add a datasource to a dataset.'
|
|
812
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a remove -d 'Remove a datasource from a dataset (local YAML path or cloud id).'
|
|
813
|
+
complete -c postman -n '__postman_using_subcommand source list add remove update' -a update -d 'Update fields on an existing datasource. Only the flags you provide are changed.'
|
|
751
814
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source' -s h -l help -d 'display help for command'
|
|
752
815
|
# ---------- dataset source list ----------
|
|
753
816
|
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
|
|
@@ -820,11 +883,11 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
820
883
|
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
|
|
821
884
|
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'
|
|
822
885
|
# ---------- dataset view ----------
|
|
823
|
-
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a list -d '
|
|
824
|
-
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a run -d '
|
|
825
|
-
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a create -d '
|
|
826
|
-
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a delete -d '
|
|
827
|
-
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a update -d '
|
|
886
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a list -d 'List the saved views defined on a dataset (local YAML path or cloud id).'
|
|
887
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a run -d 'Execute a saved view against a dataset and print the rows.'
|
|
888
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a create -d 'Add a saved view to a dataset (local YAML path or cloud id).'
|
|
889
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a delete -d 'Remove a saved view from a dataset (local YAML path or cloud id).'
|
|
890
|
+
complete -c postman -n '__postman_using_subcommand view list run create delete update' -a update -d 'Update name and/or query on an existing view (local YAML path or cloud id).'
|
|
828
891
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from view' -s h -l help -d 'display help for command'
|
|
829
892
|
# ---------- dataset view list ----------
|
|
830
893
|
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
|
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.54.1)
|
|
4
4
|
# Auto-generated by scripts/generate.mjs — DO NOT EDIT
|
|
5
5
|
# Source: spec/commands.json
|
|
6
6
|
# https://github.com/yokawasa/postman-cli-completion
|
|
@@ -22,6 +22,7 @@ _postman() {
|
|
|
22
22
|
case $words[1] in
|
|
23
23
|
login) _postman_login ;;
|
|
24
24
|
logout) _postman_logout ;;
|
|
25
|
+
init) _postman_init ;;
|
|
25
26
|
collection) _postman_collection ;;
|
|
26
27
|
environment) _postman_environment ;;
|
|
27
28
|
globals) _postman_globals ;;
|
|
@@ -51,6 +52,7 @@ _postman_commands() {
|
|
|
51
52
|
commands=(
|
|
52
53
|
'login:Authenticate with Postman to access your resources.'
|
|
53
54
|
'logout:Delete the stored Postman API key.'
|
|
55
|
+
'init:Set up Postman artifacts and agent instructions in a repository.'
|
|
54
56
|
'collection:Run and test your Postman collections directly from the command line.'
|
|
55
57
|
'environment:Work with local Postman environments from the command line.'
|
|
56
58
|
'globals:Work with local Postman globals from the command line.'
|
|
@@ -65,14 +67,14 @@ _postman_commands() {
|
|
|
65
67
|
'fl:Alias for flows'
|
|
66
68
|
'request:Send HTTP requests from the command line with full Postman capabilities including authentication, environment variables, assertions, retries, and detailed output control.'
|
|
67
69
|
'sdk:Generate and manage your SDKs directly from the command line.'
|
|
68
|
-
'mock:Run and manage
|
|
70
|
+
'mock:Run and manage Postman mocks, locally and in the cloud.'
|
|
69
71
|
'application:Application-level commands\: initialise config and run tests.'
|
|
70
72
|
'app:Alias for application'
|
|
71
73
|
'simulate:Start mock servers with simulated failure scenarios.'
|
|
72
74
|
'context:\[Beta\] Get API context for AI coding agents directly from the command line.'
|
|
73
75
|
'search:Search for Postman element types (requests, collections, workspaces, and more).'
|
|
74
76
|
'webhook:Create and manage Postman webhooks.'
|
|
75
|
-
'dataset
|
|
77
|
+
'dataset:Work with Postman datasets in local YAML files or the cloud.'
|
|
76
78
|
)
|
|
77
79
|
_describe -t commands 'postman command' commands
|
|
78
80
|
}
|
|
@@ -92,6 +94,19 @@ _postman_logout() {
|
|
|
92
94
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
93
95
|
}
|
|
94
96
|
|
|
97
|
+
_postman_init() {
|
|
98
|
+
_arguments \
|
|
99
|
+
'--json[Emit machine-readable output for agents]' \
|
|
100
|
+
'--dry-run[Report what would happen without writing anything]' \
|
|
101
|
+
'--no-seed[Do not derive a spec from source]' \
|
|
102
|
+
'--spec[Which spec is authoritative, when more than one could be]:path:_files -g "*.(yaml|yml|json)"' \
|
|
103
|
+
'--visibility[Create and bind a workspace non-interactively (personal or team)]:status' \
|
|
104
|
+
'--no-cloud[Skip the workspace step entirely]' \
|
|
105
|
+
'--report-events[Send init analytics to Postman (requires login)]' \
|
|
106
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
107
|
+
'*:path:_files -g "*.json"'
|
|
108
|
+
}
|
|
109
|
+
|
|
95
110
|
_postman_collection() {
|
|
96
111
|
local context state state_descr line
|
|
97
112
|
typeset -A opt_args
|
|
@@ -185,8 +200,10 @@ _postman_collection_run() {
|
|
|
185
200
|
'--verbose[Show detailed information of collection run and each request sent]' \
|
|
186
201
|
'--mock[Start a mock server from manifest (.json, .yaml or .yml) file]:path:_files -g "*.json"' \
|
|
187
202
|
'--port[Port for the --mock server; pass "auto" for an OS-assigned ephemeral port (default\: configured port, falls back to an ephemeral one if busy). Only valid with --mock.]:port' \
|
|
203
|
+
'--use-mock[Redirect requests for a URL or {{variable}} to a mock during the run. Format\: "<url> mock|mock-server\:<path|id> \[scenario\]". Repeat the flag to redirect multiple URLs (one --use-mock per mock). Use "mock\:<path>" for a local mock manifest (.json/.yaml/.yml), "mock\:<id>" for a local mock by id (fetched from the cloud then run locally), or "mock-server\:<id>" to redirect to a deployed mock server'\''s URL. Id-based references require `postman login` (or --postman-api-key). The optional third field selects a scenario (defaults to "default"). (default\: \[\])]:mapping' \
|
|
188
204
|
'--simulate[Start mock servers with fault-injection scenarios from a .sim.yaml file]:path:_files -g "*.(sim.yaml|yaml|yml)"' \
|
|
189
|
-
'--report-events[
|
|
205
|
+
'--report-events[Upload results for git-native v3 collection runs. Analytics are sent by default]' \
|
|
206
|
+
'--no-report-events[Do not send analytics to Postman]' \
|
|
190
207
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
191
208
|
'--reporter-json-export[Path to save the report for the given reporter.]:value:_files -g "*.(json|xml|html)"' \
|
|
192
209
|
'--reporter-junit-export[Path to save the report for the given reporter.]:value:_files -g "*.(json|xml|html)"' \
|
|
@@ -348,7 +365,8 @@ _postman_runner_start() {
|
|
|
348
365
|
'--ssl-extra-ca-certs[Additional trusted CA certificates (PEM file, can contain multiple certs)]:path:_files -g "*.(pem|crt|key)"' \
|
|
349
366
|
'--metrics[Enable the metrics server for health checks]' \
|
|
350
367
|
'--metrics-port[Port for the metrics server (default\: "9090")]:port' \
|
|
351
|
-
'--report-events[
|
|
368
|
+
'--report-events[Accepted for compatibility; analytics are sent by default]' \
|
|
369
|
+
'--no-report-events[Do not send analytics to Postman]' \
|
|
352
370
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
353
371
|
}
|
|
354
372
|
|
|
@@ -383,7 +401,8 @@ _postman_spec_lint() {
|
|
|
383
401
|
'(-f --fail-severity)'{-f,--fail-severity}'[Results of this level or above will trigger a failure exit code. \[choices\: "error", "warning", "info", "hint"\] (default\: "ERROR")]:value' \
|
|
384
402
|
'(-o --output)'{-o,--output}'[Output format for the results. \[choices\: "json", "csv"\]]:value' \
|
|
385
403
|
'--workspace-id[The workspace ID to use for fetching governance rulesets.]:value' \
|
|
386
|
-
'--report-events[
|
|
404
|
+
'--report-events[Accepted for compatibility; analytics are sent by default]' \
|
|
405
|
+
'--no-report-events[Do not send analytics to Postman]' \
|
|
387
406
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
388
407
|
'*:spec:'
|
|
389
408
|
}
|
|
@@ -442,6 +461,7 @@ _postman_workspace() {
|
|
|
442
461
|
prepare) _postman_workspace_prepare ;;
|
|
443
462
|
push) _postman_workspace_push ;;
|
|
444
463
|
lint) _postman_workspace_lint ;;
|
|
464
|
+
create) _postman_workspace_create ;;
|
|
445
465
|
pull) _postman_workspace_pull ;;
|
|
446
466
|
connect-git) _postman_workspace_connect_git ;;
|
|
447
467
|
esac
|
|
@@ -456,6 +476,7 @@ _postman_workspace_commands() {
|
|
|
456
476
|
'prepare:Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
457
477
|
'push:Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
458
478
|
'lint:Lint the current local Postman workspace\: its configuration (.postman/resources.yaml) plus every discovered entity. Use --meta to lint only the configuration.'
|
|
479
|
+
'create:Create a Postman workspace and bind it to this git repository.'
|
|
459
480
|
'pull:Pull workspace entities from a Postman workspace into the local git-native folder.'
|
|
460
481
|
'connect-git:Connect a Postman workspace to a local git repository.'
|
|
461
482
|
)
|
|
@@ -484,7 +505,8 @@ _postman_workspace_push() {
|
|
|
484
505
|
'(-y --yes)'{-y,--yes}'[Skip all confirmation prompts]' \
|
|
485
506
|
'--push-strategy[Push strategy. "force-sync"\: mirror the whole workspace — also DELETE cloud entities that have no local counterpart (destructive). Defaults to "default" (create/update only).]:strategy' \
|
|
486
507
|
'--verbose[Show detailed logging]' \
|
|
487
|
-
'--report-events[
|
|
508
|
+
'--report-events[Accepted for compatibility; analytics are sent by default]' \
|
|
509
|
+
'--no-report-events[Do not send analytics to Postman]' \
|
|
488
510
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
489
511
|
}
|
|
490
512
|
|
|
@@ -498,6 +520,17 @@ _postman_workspace_lint() {
|
|
|
498
520
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
499
521
|
}
|
|
500
522
|
|
|
523
|
+
_postman_workspace_create() {
|
|
524
|
+
_arguments \
|
|
525
|
+
'--visibility[Required. Workspace visibility, e.g. personal or team]:status' \
|
|
526
|
+
'--name[Workspace name (defaults to owner/repo from the git remote)]:name' \
|
|
527
|
+
'--summary[Optional workspace summary]:text' \
|
|
528
|
+
'--path[Directory to bind (defaults to the current directory)]:dir:_files -g "*.json"' \
|
|
529
|
+
'--no-connect[Create the workspace without binding it to the repository]' \
|
|
530
|
+
'--force[Create even when a workspace is already recorded for this repo]' \
|
|
531
|
+
'(-h --help)'{-h,--help}'[display help for command]'
|
|
532
|
+
}
|
|
533
|
+
|
|
501
534
|
_postman_workspace_pull() {
|
|
502
535
|
_arguments \
|
|
503
536
|
'(-y --yes)'{-y,--yes}'[Skip all confirmation prompts]' \
|
|
@@ -542,6 +575,8 @@ _postman_performance_run() {
|
|
|
542
575
|
_arguments \
|
|
543
576
|
'(-e --environment)'{-e,--environment}'[Specify an Id to a Postman Environment]:id' \
|
|
544
577
|
'(-g --globals)'{-g,--globals}'[Specify an Id to a Postman Globals]:id' \
|
|
578
|
+
'--setup-collection[Collection UID to run before the Postman Cloud performance test]:id' \
|
|
579
|
+
'--teardown-collection[Collection UID to run after the Postman Cloud performance test]:id' \
|
|
545
580
|
'--vu-count[Number of virtual users (default\: 20)]:count' \
|
|
546
581
|
'(-d --duration)'{-d,--duration}'[Duration of the performance test in minutes (default\: 1)]:minutes' \
|
|
547
582
|
'(-p --load-profile)'{-p,--load-profile}'[Load profile type\: fixed, ramp-up, spike, peak (default\: "ramp-up")]:profile' \
|
|
@@ -650,6 +685,8 @@ _postman_flows_run() {
|
|
|
650
685
|
'--reporters[Save a test results report to a file (supported\: html)]:format' \
|
|
651
686
|
'(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[Specify whether or not to override the default exit code for the current run]' \
|
|
652
687
|
'--workspace[Workspace ID required for flows that contain connector blocks. Find it in the Postman app URL\: https\://postman.com/workspace/<workspaceId>]:workspaceId' \
|
|
688
|
+
'--report-events[Accepted for compatibility; analytics are sent by default]' \
|
|
689
|
+
'--no-report-events[Do not send analytics to Postman]' \
|
|
653
690
|
'--verbose[Verbose output]' \
|
|
654
691
|
'--debug[Debug output]' \
|
|
655
692
|
'--json[JSON output]' \
|
|
@@ -710,6 +747,8 @@ _postman_request() {
|
|
|
710
747
|
'--verbose[Show detailed request and response information including headers, body, and metadata.]' \
|
|
711
748
|
'--response-only[suppress all output except response body. Useful for piping to other commands.]' \
|
|
712
749
|
'--debug[Debug mode\: show detailed execution information including retry attempts, redirects, and timing breakdowns.]' \
|
|
750
|
+
'--report-events[Accepted for compatibility; analytics are sent by default]' \
|
|
751
|
+
'--no-report-events[Do not send analytics to Postman]' \
|
|
713
752
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
714
753
|
'--auth-basic-username[Supply authentication parameters dynamically.]:value' \
|
|
715
754
|
'--auth-basic-password[Supply authentication parameters dynamically.]:value' \
|
|
@@ -904,8 +943,10 @@ _postman_mock() {
|
|
|
904
943
|
case $words[1] in
|
|
905
944
|
generate) _postman_mock_generate ;;
|
|
906
945
|
run) _postman_mock_run ;;
|
|
946
|
+
deploy) _postman_mock_deploy ;;
|
|
907
947
|
get) _postman_mock_get ;;
|
|
908
948
|
list) _postman_mock_list ;;
|
|
949
|
+
log) _postman_mock_log ;;
|
|
909
950
|
delete) _postman_mock_delete ;;
|
|
910
951
|
esac
|
|
911
952
|
;;
|
|
@@ -915,11 +956,13 @@ _postman_mock() {
|
|
|
915
956
|
_postman_mock_commands() {
|
|
916
957
|
local -a sub
|
|
917
958
|
sub=(
|
|
918
|
-
'generate:Generate a
|
|
919
|
-
'run:Start a local mock server
|
|
920
|
-
'
|
|
921
|
-
'
|
|
922
|
-
'
|
|
959
|
+
'generate:Generate a 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. Writes a local mock by default, or a cloud mock with --workspace.'
|
|
960
|
+
'run:Start a local mock server from a cloud mock id (fetched and run locally), a manifest file (JSON or YAML), a mock directory (postman/mocks/<slug>), or a .js handler.'
|
|
961
|
+
'deploy:Deploy a cloud mock into a mock server.'
|
|
962
|
+
'get:Show a mock'\''s details\: a cloud mock by id, or a local mock by path.'
|
|
963
|
+
'list:List a workspace'\''s cloud mocks, or (with a path) local mocks under a directory.'
|
|
964
|
+
'log:Browse a deployed mock server'\''s request/response logs by its id (see `mock get`).'
|
|
965
|
+
'delete:Permanently remove a mock\: a cloud mock by id, or a local mock artifact by path.'
|
|
923
966
|
)
|
|
924
967
|
_describe -t commands 'mock command' sub
|
|
925
968
|
}
|
|
@@ -931,6 +974,8 @@ _postman_mock_generate() {
|
|
|
931
974
|
'--port[Port the mock server should listen on (default\: 4500)]:port' \
|
|
932
975
|
'--force[Overwrite the config.yaml/default.js in the output directory if it already exists]' \
|
|
933
976
|
'(-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"' \
|
|
977
|
+
'(-w --workspace)'{-w,--workspace}'[Create a cloud mock in this Postman workspace instead of a local mock. Cannot be combined with --output/--force/--update.]:id' \
|
|
978
|
+
'--api-key[Postman API key for --workspace (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
934
979
|
'(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[Always exit with code 0, even on failure]' \
|
|
935
980
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
936
981
|
'*:sourcePath:'
|
|
@@ -941,29 +986,61 @@ _postman_mock_run() {
|
|
|
941
986
|
'(-e --environment)'{-e,--environment}'[Path to an environment file (JSON or YAML) for pm.environment]:path:_files -g "*.json"' \
|
|
942
987
|
'(-g --globals)'{-g,--globals}'[Path to a globals file (JSON or YAML) for pm.globals]:path:_files -g "*.json"' \
|
|
943
988
|
'(-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' \
|
|
989
|
+
'--api-key[Postman API key for cloud mock ids (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
944
990
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
945
|
-
'*:
|
|
991
|
+
'*:mockIdOrPath:_files -g "*.json"'
|
|
992
|
+
}
|
|
993
|
+
|
|
994
|
+
_postman_mock_deploy() {
|
|
995
|
+
_arguments \
|
|
996
|
+
'(-w --workspace)'{-w,--workspace}'[Workspace that will own the mock server (defaults to the workspace linked in .postman/resources.yaml)]:id' \
|
|
997
|
+
'(-n --name)'{-n,--name}'[Display name for the mock server (prompts when omitted)]:name' \
|
|
998
|
+
'(-s --slug)'{-s,--slug}'[Slug for the deploy URL (prompts when omitted)]:slug' \
|
|
999
|
+
'--public[Deploy as a public mock (default is private; requires an x-api-key header)]' \
|
|
1000
|
+
'--auto-deploy[Re-deploy the mock automatically whenever it changes (default off)]' \
|
|
1001
|
+
'(-y --yes)'{-y,--yes}'[Accept defaults and skip all prompts (private, no auto-deploy)]' \
|
|
1002
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1003
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1004
|
+
'*:mockId:_files -g "*.json"'
|
|
946
1005
|
}
|
|
947
1006
|
|
|
948
1007
|
_postman_mock_get() {
|
|
949
1008
|
_arguments \
|
|
1009
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
950
1010
|
'--json[Output the mock details as JSON instead of a table]' \
|
|
951
1011
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
952
|
-
'*:
|
|
1012
|
+
'*:mockIdOrPath:_files -g "*.json"'
|
|
953
1013
|
}
|
|
954
1014
|
|
|
955
1015
|
_postman_mock_list() {
|
|
956
1016
|
_arguments \
|
|
1017
|
+
'(-w --workspace)'{-w,--workspace}'[Workspace whose cloud mocks to list (defaults to the workspace linked in .postman/resources.yaml)]:id' \
|
|
1018
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
957
1019
|
'--json[Output the mock list as JSON instead of a table]' \
|
|
958
1020
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
959
1021
|
'*:pathOrDir:_files -g "*.json"'
|
|
960
1022
|
}
|
|
961
1023
|
|
|
1024
|
+
_postman_mock_log() {
|
|
1025
|
+
_arguments \
|
|
1026
|
+
'--limit[Maximum number of log entries to show (default 50 for --json/non-interactive output)]:n' \
|
|
1027
|
+
'--method[Filter by HTTP method (e.g. GET, POST)]:method' \
|
|
1028
|
+
'--status[Filter by response status (e.g. 404 or 5xx)]:code|range' \
|
|
1029
|
+
'--path[Filter by request path (supports * and ? wildcards)]:pattern' \
|
|
1030
|
+
'--since[Show logs from this long ago onward (e.g. 2h = the last 2 hours)]:duration' \
|
|
1031
|
+
'--until[Stop this long ago (e.g. 30m = exclude the most recent 30 minutes)]:duration' \
|
|
1032
|
+
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1033
|
+
'--json[Output logs as JSON instead of the interactive pager]' \
|
|
1034
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1035
|
+
'*:mockServerId:_files -g "*.json"'
|
|
1036
|
+
}
|
|
1037
|
+
|
|
962
1038
|
_postman_mock_delete() {
|
|
963
1039
|
_arguments \
|
|
964
1040
|
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt]' \
|
|
1041
|
+
'--api-key[Postman API key for cloud mock ids (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
965
1042
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
966
|
-
'*:
|
|
1043
|
+
'*:mockIdOrPath:_files -g "*.json"'
|
|
967
1044
|
}
|
|
968
1045
|
|
|
969
1046
|
_postman_application() {
|
|
@@ -1016,7 +1093,8 @@ _postman_application_test() {
|
|
|
1016
1093
|
'--capture-only[Skip collection matching and tests; capture traffic and save a V3 collection organised by host]' \
|
|
1017
1094
|
'--output[Output directory for captured collection (default\: pm-results/captured/; used with --capture-only)]:path:_files -g "*.json"' \
|
|
1018
1095
|
'--force[Overwrite the output directory if it exists and is not empty (used with --capture-only)]' \
|
|
1019
|
-
'--report-events[Send application test run results
|
|
1096
|
+
'--report-events[Send application test run results to Postman (default\: true)]:boolean' \
|
|
1097
|
+
'--no-report-events[Do not send run results or analytics to Postman]' \
|
|
1020
1098
|
'--verbose[Show detailed per-request matching, sandbox errors, and debug information]' \
|
|
1021
1099
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1022
1100
|
}
|
|
@@ -1591,13 +1669,13 @@ _postman_dataset() {
|
|
|
1591
1669
|
_postman_dataset_commands() {
|
|
1592
1670
|
local -a sub
|
|
1593
1671
|
sub=(
|
|
1594
|
-
'list
|
|
1595
|
-
'get
|
|
1596
|
-
'query
|
|
1597
|
-
'create
|
|
1598
|
-
'delete
|
|
1599
|
-
'source
|
|
1600
|
-
'view
|
|
1672
|
+
'list:List local dataset YAMLs under a path, or (no path) a workspace'\''s cloud datasets.'
|
|
1673
|
+
'get:Print a dataset'\''s metadata and structure summary (local YAML path or cloud id).'
|
|
1674
|
+
'query:Run an ad-hoc SQL query against a dataset (local YAML path or cloud id).'
|
|
1675
|
+
'create:Scaffold a new .dataset.yaml at <path>, or (no path, with -w) create a cloud dataset.'
|
|
1676
|
+
'delete:Permanently remove a dataset\: a local .dataset.yaml or a cloud dataset id.'
|
|
1677
|
+
'source:Inspect and manage a dataset'\''s datasources.'
|
|
1678
|
+
'view:Inspect and manage saved views on a dataset.'
|
|
1601
1679
|
)
|
|
1602
1680
|
_describe -t commands 'dataset command' sub
|
|
1603
1681
|
}
|
|
@@ -1674,10 +1752,10 @@ _postman_dataset_source() {
|
|
|
1674
1752
|
_postman_dataset_source_commands() {
|
|
1675
1753
|
local -a sub
|
|
1676
1754
|
sub=(
|
|
1677
|
-
'list
|
|
1678
|
-
'add
|
|
1679
|
-
'remove
|
|
1680
|
-
'update
|
|
1755
|
+
'list:List the datasources defined on a dataset (local YAML path or cloud id).'
|
|
1756
|
+
'add:Add a datasource to a dataset.'
|
|
1757
|
+
'remove:Remove a datasource from a dataset (local YAML path or cloud id).'
|
|
1758
|
+
'update:Update fields on an existing datasource. Only the flags you provide are changed.'
|
|
1681
1759
|
)
|
|
1682
1760
|
_describe -t commands 'source command' sub
|
|
1683
1761
|
}
|
|
@@ -1790,11 +1868,11 @@ _postman_dataset_view() {
|
|
|
1790
1868
|
_postman_dataset_view_commands() {
|
|
1791
1869
|
local -a sub
|
|
1792
1870
|
sub=(
|
|
1793
|
-
'list
|
|
1794
|
-
'run
|
|
1795
|
-
'create
|
|
1796
|
-
'delete
|
|
1797
|
-
'update
|
|
1871
|
+
'list:List the saved views defined on a dataset (local YAML path or cloud id).'
|
|
1872
|
+
'run:Execute a saved view against a dataset and print the rows.'
|
|
1873
|
+
'create:Add a saved view to a dataset (local YAML path or cloud id).'
|
|
1874
|
+
'delete:Remove a saved view from a dataset (local YAML path or cloud id).'
|
|
1875
|
+
'update:Update name and/or query on an existing view (local YAML path or cloud id).'
|
|
1798
1876
|
)
|
|
1799
1877
|
_describe -t commands 'view command' sub
|
|
1800
1878
|
}
|