postman-cli-completion 1.46.1 → 1.48.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.
@@ -1,4 +1,4 @@
1
- # Bash completion for Postman CLI (postman v1.46.1)
1
+ # Bash completion for Postman CLI (postman v1.48.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
@@ -143,7 +143,7 @@ _postman_collection_ai_readiness() {
143
143
 
144
144
  _postman_collection_run() {
145
145
  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 --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") )
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") )
147
147
  return 0
148
148
  fi
149
149
  case "$prev" in
@@ -382,7 +382,7 @@ _postman_workspace() {
382
382
  if [[ "$cur" == -* ]]; then
383
383
  COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
384
384
  else
385
- COMPREPLY=( $(compgen -W "list prepare push" -- "$cur") )
385
+ COMPREPLY=( $(compgen -W "list prepare push lint" -- "$cur") )
386
386
  fi
387
387
  return 0
388
388
  fi
@@ -390,6 +390,7 @@ _postman_workspace() {
390
390
  list) _postman_workspace_list ;;
391
391
  prepare) _postman_workspace_prepare ;;
392
392
  push) _postman_workspace_push ;;
393
+ lint) _postman_workspace_lint ;;
393
394
  esac
394
395
  }
395
396
 
@@ -418,6 +419,15 @@ _postman_workspace_push() {
418
419
  esac
419
420
  }
420
421
 
422
+ _postman_workspace_lint() {
423
+ if [[ "$cur" == -* ]]; then
424
+ COMPREPLY=( $(compgen -W "-f --fail-severity -o --output --meta --workspace-id -h --help" -- "$cur") )
425
+ return 0
426
+ fi
427
+ case "$prev" in
428
+ esac
429
+ }
430
+
421
431
  _postman_performance() {
422
432
  if [[ -z "$subcmd" ]]; then
423
433
  if [[ "$cur" == -* ]]; then
@@ -692,18 +702,34 @@ _postman_mock() {
692
702
  if [[ "$cur" == -* ]]; then
693
703
  COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
694
704
  else
695
- COMPREPLY=( $(compgen -W "run" -- "$cur") )
705
+ COMPREPLY=( $(compgen -W "generate run" -- "$cur") )
696
706
  fi
697
707
  return 0
698
708
  fi
699
709
  case "$subcmd" in
710
+ generate) _postman_mock_generate ;;
700
711
  run) _postman_mock_run ;;
701
712
  esac
702
713
  }
703
714
 
715
+ _postman_mock_generate() {
716
+ if [[ "$cur" == -* ]]; then
717
+ COMPREPLY=( $(compgen -W "-o --output --name --port --force -u --update -x --suppress-exit-code -h --help" -- "$cur") )
718
+ return 0
719
+ fi
720
+ case "$prev" in
721
+ -o|--output)
722
+ _postman_filematch '!*.@(json)' "$cur"
723
+ return 0 ;;
724
+ -u|--update)
725
+ _postman_filematch '!*.@(json)' "$cur"
726
+ return 0 ;;
727
+ esac
728
+ }
729
+
704
730
  _postman_mock_run() {
705
731
  if [[ "$cur" == -* ]]; then
706
- COMPREPLY=( $(compgen -W "-e --environment -g --globals -h --help" -- "$cur") )
732
+ COMPREPLY=( $(compgen -W "-e --environment -g --globals -p --port -h --help" -- "$cur") )
707
733
  return 0
708
734
  fi
709
735
  case "$prev" in
@@ -742,7 +768,7 @@ _postman_application_init() {
742
768
 
743
769
  _postman_application_test() {
744
770
  if [[ "$cur" == -* ]]; then
745
- COMPREPLY=( $(compgen -W "--target --target-collection --target-environment --command --network-log --capture-only --output --force --report-events --verbose -h --help" -- "$cur") )
771
+ COMPREPLY=( $(compgen -W "--target --target-collection --target-environment --command --deployed-version --network-log --capture-only --output --force --report-events --verbose -h --help" -- "$cur") )
746
772
  return 0
747
773
  fi
748
774
  case "$prev" in
@@ -1,4 +1,4 @@
1
- # Fish completion for Postman CLI (postman v1.46.1)
1
+ # Fish completion for Postman CLI (postman v1.48.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
@@ -115,6 +115,7 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
115
115
  complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l export-cookie-jar -d 'Exports the cookie jar to a file after completing the run' -r
116
116
  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
117
  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
+ 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
118
119
  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
119
120
  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'
120
121
  complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
@@ -207,9 +208,10 @@ complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_sub
207
208
  complete -c postman -n '__fish_seen_subcommand_from monitor; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
208
209
 
209
210
  # ---------- workspace ----------
210
- complete -c postman -n '__postman_using_subcommand workspace list prepare push' -a list -d 'List all available Postman Workspaces'
211
- complete -c postman -n '__postman_using_subcommand workspace list prepare push' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
212
- complete -c postman -n '__postman_using_subcommand workspace list prepare push' -a push -d 'Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
211
+ complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a list -d 'List all available Postman Workspaces'
212
+ complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a prepare -d 'Prepare local collections and environments for push by validating and regenerating IDs if needed.'
213
+ complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a push -d 'Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
214
+ complete -c postman -n '__postman_using_subcommand workspace list prepare push lint' -a lint -d 'Lint the current local Postman workspace: its configuration (.postman/resources.yaml) plus every discovered entity. Use --meta to lint only the configuration.'
213
215
  complete -c postman -n '__fish_seen_subcommand_from workspace' -s h -l help -d 'display help for command'
214
216
  # ---------- workspace list ----------
215
217
  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
@@ -228,6 +230,12 @@ complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_s
228
230
  complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -l verbose -d 'Show detailed logging'
229
231
  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'
230
232
  complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from push' -s h -l help -d 'display help for command'
233
+ # ---------- workspace lint ----------
234
+ 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
235
+ complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -s o -l output -d 'Output format: cli (human-readable), table, or json. (default: "cli")' -x
236
+ complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -l meta -d 'Only lint the workspace configuration (.postman/resources.yaml); skip per-entity linting.'
237
+ 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
238
+ complete -c postman -n '__fish_seen_subcommand_from workspace; and __fish_seen_subcommand_from lint' -s h -l help -d 'display help for command'
231
239
 
232
240
  # ---------- performance ----------
233
241
  complete -c postman -n '__postman_using_subcommand performance run' -a run -d 'Run a performance test on a collection'
@@ -446,11 +454,21 @@ complete -c postman -n '__fish_seen_subcommand_from sdk; and __fish_seen_subcomm
446
454
  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'
447
455
 
448
456
  # ---------- mock ----------
449
- complete -c postman -n '__postman_using_subcommand mock run' -a run -d 'Start a local mock server given a manifest file (JSON or YAML).'
457
+ complete -c postman -n '__postman_using_subcommand mock generate run' -a generate -d 'Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto-detected.'
458
+ complete -c postman -n '__postman_using_subcommand mock generate run' -a run -d 'Start a local mock server given a manifest file (JSON or YAML).'
450
459
  complete -c postman -n '__fish_seen_subcommand_from mock' -s h -l help -d 'display help for command'
460
+ # ---------- mock generate ----------
461
+ 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
462
+ complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -l name -d 'Display name for the generated mock' -x
463
+ 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
464
+ 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'
465
+ 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
466
+ 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'
467
+ complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from generate' -s h -l help -d 'display help for command'
451
468
  # ---------- mock run ----------
452
469
  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
453
470
  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
471
+ 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
454
472
  complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
455
473
 
456
474
  # ---------- application ----------
@@ -470,6 +488,7 @@ complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen
470
488
  complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l target-collection -d 'Collection override for the selected target (repeatable) (default: [])' -r
471
489
  complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l target-environment -d 'Environment override for the selected target (last value wins) (default: [])' -r
472
490
  complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l command -d 'Command to run first (primary task). Overrides config.' -x
491
+ complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l deployed-version -d 'Version identity of the application under test (e.g. a build ID, release tag, or version string). Also read from the APP_DEPLOYED_VERSION environment variable.' -x
473
492
  complete -c postman -n '__fish_seen_subcommand_from application; and __fish_seen_subcommand_from test' -l network-log -d 'Directory to scan for captured artifacts, or a direct path to a Playwright JSON report / NDJSON capture file. When a directory is given, recursively discovers `*.json` Playwright reports plus their `trace.zip` attachments, and `network-capture-*.ndjson` at the top level. By default, scans Playwright config `outputDir`, test-results/, then pm-results/.' -r
474
493
  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'
475
494
  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
@@ -1,6 +1,6 @@
1
1
  #compdef postman
2
2
  compdef _postman postman
3
- # Zsh completion for Postman CLI (postman v1.46.1)
3
+ # Zsh completion for Postman CLI (postman v1.48.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
@@ -184,6 +184,7 @@ _postman_collection_run() {
184
184
  '--export-cookie-jar[Exports the cookie jar to a file after completing the run]:path:_files -g "*.json"' \
185
185
  '--verbose[Show detailed information of collection run and each request sent]' \
186
186
  '--mock[Start a mock server from manifest (.json, .yaml or .yml) file]:path:_files -g "*.json"' \
187
+ '--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' \
187
188
  '--simulate[Start mock servers with fault-injection scenarios from a .sim.yaml file]:path:_files -g "*.(sim.yaml|yaml|yml)"' \
188
189
  '--report-events[Send run results and analytics to Postman]' \
189
190
  '(-h --help)'{-h,--help}'[display help for command]' \
@@ -440,6 +441,7 @@ _postman_workspace() {
440
441
  list) _postman_workspace_list ;;
441
442
  prepare) _postman_workspace_prepare ;;
442
443
  push) _postman_workspace_push ;;
444
+ lint) _postman_workspace_lint ;;
443
445
  esac
444
446
  ;;
445
447
  esac
@@ -451,6 +453,7 @@ _postman_workspace_commands() {
451
453
  'list:List all available Postman Workspaces'
452
454
  'prepare:Prepare local collections and environments for push by validating and regenerating IDs if needed.'
453
455
  'push:Push local workspace entities (collections, environments, specifications, and more) to Postman workspace.'
456
+ 'lint:Lint the current local Postman workspace\: its configuration (.postman/resources.yaml) plus every discovered entity. Use --meta to lint only the configuration.'
454
457
  )
455
458
  _describe -t commands 'workspace command' sub
456
459
  }
@@ -481,6 +484,15 @@ _postman_workspace_push() {
481
484
  '(-h --help)'{-h,--help}'[display help for command]'
482
485
  }
483
486
 
487
+ _postman_workspace_lint() {
488
+ _arguments \
489
+ '(-f --fail-severity)'{-f,--fail-severity}'[Exit with failure if diagnostics at this level or above are present. \[choices\: "error", "warning", "info", "hint"\] (default\: "error")]:value' \
490
+ '(-o --output)'{-o,--output}'[Output format\: cli (human-readable), table, or json. (default\: "cli")]:value' \
491
+ '--meta[Only lint the workspace configuration (.postman/resources.yaml); skip per-entity linting.]' \
492
+ '--workspace-id[The workspace ID to use for fetching governance rulesets. Defaults to the id in .postman/resources.yaml.]:value' \
493
+ '(-h --help)'{-h,--help}'[display help for command]'
494
+ }
495
+
484
496
  _postman_performance() {
485
497
  local context state state_descr line
486
498
  typeset -A opt_args
@@ -861,6 +873,7 @@ _postman_mock() {
861
873
  case $state in
862
874
  args)
863
875
  case $words[1] in
876
+ generate) _postman_mock_generate ;;
864
877
  run) _postman_mock_run ;;
865
878
  esac
866
879
  ;;
@@ -870,15 +883,29 @@ _postman_mock() {
870
883
  _postman_mock_commands() {
871
884
  local -a sub
872
885
  sub=(
886
+ 'generate:Generate a local, runnable mock from a Postman collection (v2.0/v2.1/v3 file, or a git-native v3 collection directory) or an OpenAPI 3.0/3.1 spec file. The source type is auto-detected.'
873
887
  'run:Start a local mock server given a manifest file (JSON or YAML).'
874
888
  )
875
889
  _describe -t commands 'mock command' sub
876
890
  }
877
891
 
892
+ _postman_mock_generate() {
893
+ _arguments \
894
+ '(-o --output)'{-o,--output}'[Output directory for the mock (default\: postman/mocks/<slug>)]:dir:_files -g "*.json"' \
895
+ '--name[Display name for the generated mock]:name' \
896
+ '--port[Port the mock server should listen on (default\: 4500)]:port' \
897
+ '--force[Overwrite the config.yaml/default.js in the output directory if it already exists]' \
898
+ '(-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"' \
899
+ '(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[Always exit with code 0, even on failure]' \
900
+ '(-h --help)'{-h,--help}'[display help for command]' \
901
+ '*:sourcePath:'
902
+ }
903
+
878
904
  _postman_mock_run() {
879
905
  _arguments \
880
906
  '(-e --environment)'{-e,--environment}'[Path to an environment file (JSON or YAML) for pm.environment]:path:_files -g "*.json"' \
881
907
  '(-g --globals)'{-g,--globals}'[Path to a globals file (JSON or YAML) for pm.globals]:path:_files -g "*.json"' \
908
+ '(-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' \
882
909
  '(-h --help)'{-h,--help}'[display help for command]' \
883
910
  '*:manifestPath:'
884
911
  }
@@ -926,6 +953,7 @@ _postman_application_test() {
926
953
  '--target-collection[Collection override for the selected target (repeatable) (default\: \[\])]:path:_files -g "*.json"' \
927
954
  '--target-environment[Environment override for the selected target (last value wins) (default\: \[\])]:path:_files -g "*.json"' \
928
955
  '--command[Command to run first (primary task). Overrides config.]:cmd' \
956
+ '--deployed-version[Version identity of the application under test (e.g. a build ID, release tag, or version string). Also read from the APP_DEPLOYED_VERSION environment variable.]:version' \
929
957
  '--network-log[Directory to scan for captured artifacts, or a direct path to a Playwright JSON report / NDJSON capture file. When a directory is given, recursively discovers `*.json` Playwright reports plus their `trace.zip` attachments, and `network-capture-*.ndjson` at the top level. By default, scans Playwright config `outputDir`, test-results/, then pm-results/.]:path:_files -g "*.json"' \
930
958
  '--capture-only[Skip collection matching and tests; capture traffic and save a V3 collection organised by host]' \
931
959
  '--output[Output directory for captured collection (default\: pm-results/captured/; used with --capture-only)]:path:_files -g "*.json"' \
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli-completion",
3
- "version": "1.46.1",
3
+ "version": "1.48.0",
4
4
  "description": "Shell completions for the Postman CLI (zsh, bash, fish)",
5
5
  "type": "module",
6
6
  "bin": {