postman-cli-completion 1.41.2 → 1.44.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/completions/bash/postman.bash +60 -21
- package/completions/fish/postman.fish +34 -13
- package/completions/zsh/_postman +63 -6
- 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.44.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
|
|
@@ -141,7 +141,7 @@ _postman_collection_ai_readiness() {
|
|
|
141
141
|
|
|
142
142
|
_postman_collection_run() {
|
|
143
143
|
if [[ "$cur" == -* ]]; then
|
|
144
|
-
COMPREPLY=( $(compgen -W "-e --environment -g --globals -r --reporters --reporter-json-structure -n --iteration-count -d --iteration-data --iteration-data-dataset --iteration-data-view --dataset -i --global-var --env-var --integration-id --postman-api-key --alias --bail --ignore-redirects -x --suppress-exit-code --silent --disable-unicode --delay-request --timeout --timeout-request --timeout-script --working-dir --no-insecure-file-read -k --insecure --ssl-client-cert-list --ssl-client-cert --ssl-client-key --ssl-client-passphrase --ssl-extra-ca-certs --cookie-jar --export-cookie-jar --verbose --mock --simulate -h --help --reporter-json-export --reporter-junit-export --reporter-html-export --reporter-json-omitRequestBodies --reporter-html-omitRequestBodies --reporter-json-omitResponseBodies --reporter-html-omitResponseBodies --reporter-json-omitHeaders --reporter-html-omitHeaders --reporter-json-omitAllHeadersAndBody --reporter-html-omitAllHeadersAndBody" -- "$cur") )
|
|
144
|
+
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 --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") )
|
|
145
145
|
return 0
|
|
146
146
|
fi
|
|
147
147
|
case "$prev" in
|
|
@@ -258,7 +258,7 @@ _postman_runner() {
|
|
|
258
258
|
|
|
259
259
|
_postman_runner_start() {
|
|
260
260
|
if [[ "$cur" == -* ]]; then
|
|
261
|
-
COMPREPLY=( $(compgen -W "--id --key --region --proxy --egress-proxy --egress-proxy-authz-url --ssl-extra-ca-certs --metrics --metrics-port -h --help" -- "$cur") )
|
|
261
|
+
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") )
|
|
262
262
|
return 0
|
|
263
263
|
fi
|
|
264
264
|
case "$prev" in
|
|
@@ -288,7 +288,7 @@ _postman_spec() {
|
|
|
288
288
|
|
|
289
289
|
_postman_spec_lint() {
|
|
290
290
|
if [[ "$cur" == -* ]]; then
|
|
291
|
-
COMPREPLY=( $(compgen -W "-f --fail-severity -o --output --workspace-id -h --help" -- "$cur") )
|
|
291
|
+
COMPREPLY=( $(compgen -W "-f --fail-severity -o --output --workspace-id --report-events -h --help" -- "$cur") )
|
|
292
292
|
return 0
|
|
293
293
|
fi
|
|
294
294
|
case "$prev" in
|
|
@@ -344,31 +344,17 @@ _postman_workspace() {
|
|
|
344
344
|
|
|
345
345
|
_postman_workspace_prepare() {
|
|
346
346
|
if [[ "$cur" == -* ]]; then
|
|
347
|
-
COMPREPLY=( $(compgen -W "--
|
|
347
|
+
COMPREPLY=( $(compgen -W "--verbose -h --help" -- "$cur") )
|
|
348
348
|
return 0
|
|
349
349
|
fi
|
|
350
|
-
case "$prev" in
|
|
351
|
-
--collections-dir)
|
|
352
|
-
COMPREPLY=( $(compgen -d -- "$cur") )
|
|
353
|
-
return 0 ;;
|
|
354
|
-
--environments-dir)
|
|
355
|
-
COMPREPLY=( $(compgen -d -- "$cur") )
|
|
356
|
-
return 0 ;;
|
|
357
|
-
esac
|
|
358
350
|
}
|
|
359
351
|
|
|
360
352
|
_postman_workspace_push() {
|
|
361
353
|
if [[ "$cur" == -* ]]; then
|
|
362
|
-
COMPREPLY=( $(compgen -W "--
|
|
354
|
+
COMPREPLY=( $(compgen -W "--no-prepare -y --yes --push-strategy --verbose --report-events -h --help" -- "$cur") )
|
|
363
355
|
return 0
|
|
364
356
|
fi
|
|
365
357
|
case "$prev" in
|
|
366
|
-
--collections-dir)
|
|
367
|
-
COMPREPLY=( $(compgen -d -- "$cur") )
|
|
368
|
-
return 0 ;;
|
|
369
|
-
--environments-dir)
|
|
370
|
-
COMPREPLY=( $(compgen -d -- "$cur") )
|
|
371
|
-
return 0 ;;
|
|
372
358
|
esac
|
|
373
359
|
}
|
|
374
360
|
|
|
@@ -986,7 +972,7 @@ _postman_webhook() {
|
|
|
986
972
|
if [[ "$cur" == -* ]]; then
|
|
987
973
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
988
974
|
else
|
|
989
|
-
COMPREPLY=( $(compgen -W "create start pause list delete status forward" -- "$cur") )
|
|
975
|
+
COMPREPLY=( $(compgen -W "create start pause list delete status requests forward" -- "$cur") )
|
|
990
976
|
fi
|
|
991
977
|
return 0
|
|
992
978
|
fi
|
|
@@ -997,6 +983,7 @@ _postman_webhook() {
|
|
|
997
983
|
list) _postman_webhook_list ;;
|
|
998
984
|
delete) _postman_webhook_delete ;;
|
|
999
985
|
status) _postman_webhook_status ;;
|
|
986
|
+
requests) _postman_webhook_requests ;;
|
|
1000
987
|
forward) _postman_webhook_forward ;;
|
|
1001
988
|
esac
|
|
1002
989
|
}
|
|
@@ -1073,6 +1060,58 @@ _postman_webhook_status() {
|
|
|
1073
1060
|
esac
|
|
1074
1061
|
}
|
|
1075
1062
|
|
|
1063
|
+
_postman_webhook_requests() {
|
|
1064
|
+
if [[ -z "$subcmd" ]]; then
|
|
1065
|
+
if [[ "$cur" == -* ]]; then
|
|
1066
|
+
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
1067
|
+
else
|
|
1068
|
+
COMPREPLY=( $(compgen -W "list describe replay" -- "$cur") )
|
|
1069
|
+
fi
|
|
1070
|
+
return 0
|
|
1071
|
+
fi
|
|
1072
|
+
case "$subcmd" in
|
|
1073
|
+
list) _postman_webhook_requests_list ;;
|
|
1074
|
+
describe) _postman_webhook_requests_describe ;;
|
|
1075
|
+
replay) _postman_webhook_requests_replay ;;
|
|
1076
|
+
esac
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1079
|
+
_postman_webhook_requests_list() {
|
|
1080
|
+
if [[ "$cur" == -* ]]; then
|
|
1081
|
+
COMPREPLY=( $(compgen -W "-w --workspace --cursor --api-key -h --help" -- "$cur") )
|
|
1082
|
+
return 0
|
|
1083
|
+
fi
|
|
1084
|
+
case "$prev" in
|
|
1085
|
+
--api-key)
|
|
1086
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1087
|
+
return 0 ;;
|
|
1088
|
+
esac
|
|
1089
|
+
}
|
|
1090
|
+
|
|
1091
|
+
_postman_webhook_requests_describe() {
|
|
1092
|
+
if [[ "$cur" == -* ]]; then
|
|
1093
|
+
COMPREPLY=( $(compgen -W "-w --workspace --api-key -h --help" -- "$cur") )
|
|
1094
|
+
return 0
|
|
1095
|
+
fi
|
|
1096
|
+
case "$prev" in
|
|
1097
|
+
--api-key)
|
|
1098
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1099
|
+
return 0 ;;
|
|
1100
|
+
esac
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
_postman_webhook_requests_replay() {
|
|
1104
|
+
if [[ "$cur" == -* ]]; then
|
|
1105
|
+
COMPREPLY=( $(compgen -W "-w --workspace --api-key -h --help" -- "$cur") )
|
|
1106
|
+
return 0
|
|
1107
|
+
fi
|
|
1108
|
+
case "$prev" in
|
|
1109
|
+
--api-key)
|
|
1110
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
1111
|
+
return 0 ;;
|
|
1112
|
+
esac
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1076
1115
|
_postman_webhook_forward() {
|
|
1077
1116
|
if [[ "$cur" == -* ]]; then
|
|
1078
1117
|
COMPREPLY=( $(compgen -W "-w --workspace --api-key -h --help" -- "$cur") )
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Fish completion for Postman CLI (postman v1.
|
|
1
|
+
# Fish completion for Postman CLI (postman v1.44.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
|
|
@@ -78,6 +78,7 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
78
78
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s e -l environment -d 'Specify an Id or path to a Postman Environment' -r
|
|
79
79
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s g -l globals -d 'Specify an Id or path to a file containing Postman Globals' -r
|
|
80
80
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s r -l reporters -d 'Specify the reporters to use for the run: cli,json,junit,html. For multiple reporters, provide their names as a comma-separated list (E.g., -r cli,json) (default: ["cli"])' -x -a 'cli json junit html'
|
|
81
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l output -d 'Write a YAML-based run report to the given folder. Creates a paired `<prefix>.collection-run-summary.yaml` (refreshed during the run) and streaming `<prefix>.collection-run-executions.yaml`, where prefix defaults to `<collection-slug>-<timestamp>`. Gotcha: --output streams run data to file and cannot be combined with the built-in reporters (-r/--reporter-*); doing so exits with an error. This keeps large runs from buffering an entire report in memory.' -x
|
|
81
82
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l reporter-json-structure -d '[Optional] Generate JSON report using the Newman schema. By default, JSON reports use the native structure of Postman CLI.'
|
|
82
83
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s n -l iteration-count -d 'Define the number of iterations to run' -x
|
|
83
84
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s d -l iteration-data -d 'Specify a data file to use for iterations (either JSON or CSV)' -r
|
|
@@ -112,6 +113,7 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
112
113
|
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'
|
|
113
114
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l mock -d 'Start a mock server from manifest (.json) file' -r
|
|
114
115
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l simulate -d 'Start mock servers with fault-injection scenarios from a .sim.yaml file' -r
|
|
116
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l report-events -d 'Send run results and analytics to Postman'
|
|
115
117
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
116
118
|
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
|
|
117
119
|
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
|
|
@@ -157,6 +159,7 @@ complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subc
|
|
|
157
159
|
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
|
|
158
160
|
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'
|
|
159
161
|
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
|
|
162
|
+
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -l report-events -d 'Send run events and analytics to Postman'
|
|
160
163
|
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from start' -s h -l help -d 'display help for command'
|
|
161
164
|
|
|
162
165
|
# ---------- spec ----------
|
|
@@ -167,6 +170,7 @@ complete -c postman -n '__fish_seen_subcommand_from spec' -s h -l help -d 'displ
|
|
|
167
170
|
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
|
|
168
171
|
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
|
|
169
172
|
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
|
|
173
|
+
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -l report-events -d 'Send lint results and analytics to Postman'
|
|
170
174
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -s h -l help -d 'display help for command'
|
|
171
175
|
# ---------- spec ai-readiness ----------
|
|
172
176
|
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
|
|
@@ -183,19 +187,17 @@ complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_sub
|
|
|
183
187
|
|
|
184
188
|
# ---------- workspace ----------
|
|
185
189
|
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
186
|
-
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a push -d 'Push local
|
|
190
|
+
complete -c postman -n '__postman_using_subcommand workspace prepare push' -a push -d 'Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
187
191
|
complete -c postman -n '__fish_seen_subcommand_from workspace' -s h -l help -d 'display help for command'
|
|
188
192
|
# ---------- workspace prepare ----------
|
|
189
|
-
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -l collections-dir -d 'Path to the collections directory (default: "postman/collections")' -x
|
|
190
|
-
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -l environments-dir -d 'Path to the environments directory (default: "postman/environments")' -x
|
|
191
193
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -l verbose -d 'Show detailed logging'
|
|
192
194
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from prepare' -s h -l help -d 'display help for command'
|
|
193
195
|
# ---------- workspace push ----------
|
|
194
|
-
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l collections-dir -d 'Path to the collections directory (default: "postman/collections")' -x
|
|
195
|
-
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l environments-dir -d 'Path to the environments directory (default: "postman/environments")' -x
|
|
196
196
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l no-prepare -d 'Skip ID validation and auto-fix before pushing'
|
|
197
197
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -s y -l yes -d 'Skip all confirmation prompts'
|
|
198
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l 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
|
|
198
199
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l verbose -d 'Show detailed logging'
|
|
200
|
+
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l report-events -d 'Send workspace push events to Postman'
|
|
199
201
|
complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -s h -l help -d 'display help for command'
|
|
200
202
|
|
|
201
203
|
# ---------- performance ----------
|
|
@@ -542,13 +544,14 @@ complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subc
|
|
|
542
544
|
complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subcommand_from environments' -s h -l help -d 'display help for command'
|
|
543
545
|
|
|
544
546
|
# ---------- webhook ----------
|
|
545
|
-
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status forward' -a create -d 'Create a new webhook and print its public URL.'
|
|
546
|
-
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status forward' -a start -d 'Activate a webhook so it can receive requests.'
|
|
547
|
-
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status forward' -a pause -d 'Pause a webhook so it no longer accepts requests.'
|
|
548
|
-
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status forward' -a list -d 'List all webhooks in a workspace.'
|
|
549
|
-
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status forward' -a delete -d 'Permanently delete a webhook.'
|
|
550
|
-
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status forward' -a status -d 'Show details for a webhook.'
|
|
551
|
-
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status forward' -a
|
|
547
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a create -d 'Create a new webhook and print its public URL.'
|
|
548
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a start -d 'Activate a webhook so it can receive requests.'
|
|
549
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a pause -d 'Pause a webhook so it no longer accepts requests.'
|
|
550
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a list -d 'List all webhooks in a workspace.'
|
|
551
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a delete -d 'Permanently delete a webhook.'
|
|
552
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a status -d 'Show details for a webhook.'
|
|
553
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a requests -d 'List, inspect, and replay requests received by a webhook.'
|
|
554
|
+
complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a forward -d 'Forward incoming webhook requests to a local port.'
|
|
552
555
|
complete -c postman -n '__fish_seen_subcommand_from webhook' -s h -l help -d 'display help for command'
|
|
553
556
|
# ---------- webhook create ----------
|
|
554
557
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from create' -s t -l title -d 'Name for the webhook (default: "CLI Webhook")' -x
|
|
@@ -575,6 +578,24 @@ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_sub
|
|
|
575
578
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from status' -s w -l workspace -d 'Postman workspace ID' -x
|
|
576
579
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from status' -l api-key -d 'Postman API key' -r
|
|
577
580
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from status' -s h -l help -d 'display help for command'
|
|
581
|
+
# ---------- webhook requests ----------
|
|
582
|
+
complete -c postman -n '__postman_using_subcommand requests list describe replay' -a list -d 'List recent requests received by a webhook.'
|
|
583
|
+
complete -c postman -n '__postman_using_subcommand requests list describe replay' -a describe -d 'Show details for a request received by a webhook.'
|
|
584
|
+
complete -c postman -n '__postman_using_subcommand requests list describe replay' -a replay -d 'Replay a request received by a webhook.'
|
|
585
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests' -s h -l help -d 'display help for command'
|
|
586
|
+
# ---------- webhook requests list ----------
|
|
587
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from list' -s w -l workspace -d 'Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)' -x
|
|
588
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from list' -l cursor -d 'Pagination cursor returned by a previous request list response' -x
|
|
589
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from list' -l api-key -d 'Postman API key' -r
|
|
590
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
591
|
+
# ---------- webhook requests describe ----------
|
|
592
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from describe' -s w -l workspace -d 'Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)' -x
|
|
593
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from describe' -l api-key -d 'Postman API key' -r
|
|
594
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from describe' -s h -l help -d 'display help for command'
|
|
595
|
+
# ---------- webhook requests replay ----------
|
|
596
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from replay' -s w -l workspace -d 'Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)' -x
|
|
597
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from replay' -l api-key -d 'Postman API key' -r
|
|
598
|
+
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from replay' -s h -l help -d 'display help for command'
|
|
578
599
|
# ---------- webhook forward ----------
|
|
579
600
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -s w -l workspace -d 'Postman workspace ID' -x
|
|
580
601
|
complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -l api-key -d 'Postman API key' -r
|
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.44.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
|
|
@@ -145,6 +145,7 @@ _postman_collection_run() {
|
|
|
145
145
|
'(-e --environment)'{-e,--environment}'[Specify an Id or path to a Postman Environment]:path:_files -g "*.json"' \
|
|
146
146
|
'(-g --globals)'{-g,--globals}'[Specify an Id or path to a file containing Postman Globals]:path:_files -g "*.json"' \
|
|
147
147
|
'(-r --reporters)'{-r,--reporters}'[Specify the reporters to use for the run\: cli,json,junit,html. For multiple reporters, provide their names as a comma-separated list (E.g., -r cli,json) (default\: \["cli"\])]:reporter:(cli json junit html)' \
|
|
148
|
+
'--output[Write a YAML-based run report to the given folder. Creates a paired `<prefix>.collection-run-summary.yaml` (refreshed during the run) and streaming `<prefix>.collection-run-executions.yaml`, where prefix defaults to `<collection-slug>-<timestamp>`. Gotcha\: --output streams run data to file and cannot be combined with the built-in reporters (-r/--reporter-*); doing so exits with an error. This keeps large runs from buffering an entire report in memory.]:folder' \
|
|
148
149
|
'--reporter-json-structure[\[Optional\] Generate JSON report using the Newman schema. By default, JSON reports use the native structure of Postman CLI.]' \
|
|
149
150
|
'(-n --iteration-count)'{-n,--iteration-count}'[Define the number of iterations to run]:n' \
|
|
150
151
|
'(-d --iteration-data)'{-d,--iteration-data}'[Specify a data file to use for iterations (either JSON or CSV)]:path:_files -g "*.(json|csv)"' \
|
|
@@ -179,6 +180,7 @@ _postman_collection_run() {
|
|
|
179
180
|
'--verbose[Show detailed information of collection run and each request sent]' \
|
|
180
181
|
'--mock[Start a mock server from manifest (.json) file]:path:_files -g "*.json"' \
|
|
181
182
|
'--simulate[Start mock servers with fault-injection scenarios from a .sim.yaml file]:path:_files -g "*.(sim.yaml|yaml|yml)"' \
|
|
183
|
+
'--report-events[Send run results and analytics to Postman]' \
|
|
182
184
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
183
185
|
'--reporter-json-export[Path to save the report for the given reporter.]:value:_files -g "*.(json|xml|html)"' \
|
|
184
186
|
'--reporter-junit-export[Path to save the report for the given reporter.]:value:_files -g "*.(json|xml|html)"' \
|
|
@@ -276,6 +278,7 @@ _postman_runner_start() {
|
|
|
276
278
|
'--ssl-extra-ca-certs[Additional trusted CA certificates (PEM file, can contain multiple certs)]:path:_files -g "*.(pem|crt|key)"' \
|
|
277
279
|
'--metrics[Enable the metrics server for health checks]' \
|
|
278
280
|
'--metrics-port[Port for the metrics server (default\: "9090")]:port' \
|
|
281
|
+
'--report-events[Send run events and analytics to Postman]' \
|
|
279
282
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
280
283
|
}
|
|
281
284
|
|
|
@@ -310,6 +313,7 @@ _postman_spec_lint() {
|
|
|
310
313
|
'(-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' \
|
|
311
314
|
'(-o --output)'{-o,--output}'[Output format for the results. \[choices\: "json", "csv"\]]:value' \
|
|
312
315
|
'--workspace-id[The workspace ID to use for fetching governance rulesets.]:value' \
|
|
316
|
+
'--report-events[Send lint results and analytics to Postman]' \
|
|
313
317
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
314
318
|
'*:spec:'
|
|
315
319
|
}
|
|
@@ -375,26 +379,24 @@ _postman_workspace_commands() {
|
|
|
375
379
|
local -a sub
|
|
376
380
|
sub=(
|
|
377
381
|
'prepare:Prepare local collections and environments for push by validating and regenerating IDs if needed.'
|
|
378
|
-
'push:Push local
|
|
382
|
+
'push:Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
|
|
379
383
|
)
|
|
380
384
|
_describe -t commands 'workspace command' sub
|
|
381
385
|
}
|
|
382
386
|
|
|
383
387
|
_postman_workspace_prepare() {
|
|
384
388
|
_arguments \
|
|
385
|
-
'--collections-dir[Path to the collections directory (default\: "postman/collections")]:path:_files -/' \
|
|
386
|
-
'--environments-dir[Path to the environments directory (default\: "postman/environments")]:path:_files -/' \
|
|
387
389
|
'--verbose[Show detailed logging]' \
|
|
388
390
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
389
391
|
}
|
|
390
392
|
|
|
391
393
|
_postman_workspace_push() {
|
|
392
394
|
_arguments \
|
|
393
|
-
'--collections-dir[Path to the collections directory (default\: "postman/collections")]:path:_files -/' \
|
|
394
|
-
'--environments-dir[Path to the environments directory (default\: "postman/environments")]:path:_files -/' \
|
|
395
395
|
'--no-prepare[Skip ID validation and auto-fix before pushing]' \
|
|
396
396
|
'(-y --yes)'{-y,--yes}'[Skip all confirmation prompts]' \
|
|
397
|
+
'--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' \
|
|
397
398
|
'--verbose[Show detailed logging]' \
|
|
399
|
+
'--report-events[Send workspace push events to Postman]' \
|
|
398
400
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
399
401
|
}
|
|
400
402
|
|
|
@@ -1217,6 +1219,7 @@ _postman_webhook() {
|
|
|
1217
1219
|
list) _postman_webhook_list ;;
|
|
1218
1220
|
delete) _postman_webhook_delete ;;
|
|
1219
1221
|
status) _postman_webhook_status ;;
|
|
1222
|
+
requests) _postman_webhook_requests ;;
|
|
1220
1223
|
forward) _postman_webhook_forward ;;
|
|
1221
1224
|
esac
|
|
1222
1225
|
;;
|
|
@@ -1232,6 +1235,7 @@ _postman_webhook_commands() {
|
|
|
1232
1235
|
'list:List all webhooks in a workspace.'
|
|
1233
1236
|
'delete:Permanently delete a webhook.'
|
|
1234
1237
|
'status:Show details for a webhook.'
|
|
1238
|
+
'requests:List, inspect, and replay requests received by a webhook.'
|
|
1235
1239
|
'forward:Forward incoming webhook requests to a local port.'
|
|
1236
1240
|
)
|
|
1237
1241
|
_describe -t commands 'webhook command' sub
|
|
@@ -1284,6 +1288,59 @@ _postman_webhook_status() {
|
|
|
1284
1288
|
'*:webhookId:'
|
|
1285
1289
|
}
|
|
1286
1290
|
|
|
1291
|
+
_postman_webhook_requests() {
|
|
1292
|
+
local context state state_descr line
|
|
1293
|
+
typeset -A opt_args
|
|
1294
|
+
_arguments -C \
|
|
1295
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1296
|
+
'1: :_postman_webhook_requests_commands' \
|
|
1297
|
+
'*::arg:->args'
|
|
1298
|
+
case $state in
|
|
1299
|
+
args)
|
|
1300
|
+
case $words[1] in
|
|
1301
|
+
list) _postman_webhook_requests_list ;;
|
|
1302
|
+
describe) _postman_webhook_requests_describe ;;
|
|
1303
|
+
replay) _postman_webhook_requests_replay ;;
|
|
1304
|
+
esac
|
|
1305
|
+
;;
|
|
1306
|
+
esac
|
|
1307
|
+
}
|
|
1308
|
+
|
|
1309
|
+
_postman_webhook_requests_commands() {
|
|
1310
|
+
local -a sub
|
|
1311
|
+
sub=(
|
|
1312
|
+
'list:List recent requests received by a webhook.'
|
|
1313
|
+
'describe:Show details for a request received by a webhook.'
|
|
1314
|
+
'replay:Replay a request received by a webhook.'
|
|
1315
|
+
)
|
|
1316
|
+
_describe -t commands 'requests command' sub
|
|
1317
|
+
}
|
|
1318
|
+
|
|
1319
|
+
_postman_webhook_requests_list() {
|
|
1320
|
+
_arguments \
|
|
1321
|
+
'(-w --workspace)'{-w,--workspace}'[Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)]:workspaceId' \
|
|
1322
|
+
'--cursor[Pagination cursor returned by a previous request list response]:cursor' \
|
|
1323
|
+
'--api-key[Postman API key]:key:_files -g "*.(pem|crt|key)"' \
|
|
1324
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1325
|
+
'*:webhookId:'
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
_postman_webhook_requests_describe() {
|
|
1329
|
+
_arguments \
|
|
1330
|
+
'(-w --workspace)'{-w,--workspace}'[Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)]:workspaceId' \
|
|
1331
|
+
'--api-key[Postman API key]:key:_files -g "*.(pem|crt|key)"' \
|
|
1332
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1333
|
+
'*:requestId:'
|
|
1334
|
+
}
|
|
1335
|
+
|
|
1336
|
+
_postman_webhook_requests_replay() {
|
|
1337
|
+
_arguments \
|
|
1338
|
+
'(-w --workspace)'{-w,--workspace}'[Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)]:workspaceId' \
|
|
1339
|
+
'--api-key[Postman API key]:key:_files -g "*.(pem|crt|key)"' \
|
|
1340
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1341
|
+
'*:requestId:'
|
|
1342
|
+
}
|
|
1343
|
+
|
|
1287
1344
|
_postman_webhook_forward() {
|
|
1288
1345
|
_arguments \
|
|
1289
1346
|
'(-w --workspace)'{-w,--workspace}'[Postman workspace ID]:workspaceId' \
|