postman-cli-completion 1.66.0 → 1.67.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 +16 -26
- package/completions/fish/postman.fish +43 -43
- package/completions/zsh/_postman +28 -33
- 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.67.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
|
|
@@ -179,7 +179,7 @@ _postman_collection() {
|
|
|
179
179
|
if [[ "$cur" == -* ]]; then
|
|
180
180
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
181
181
|
else
|
|
182
|
-
COMPREPLY=( $(compgen -W "new migrate lint
|
|
182
|
+
COMPREPLY=( $(compgen -W "new migrate lint get publish generate sync request folder list run" -- "$cur") )
|
|
183
183
|
fi
|
|
184
184
|
return 0
|
|
185
185
|
fi
|
|
@@ -187,8 +187,8 @@ _postman_collection() {
|
|
|
187
187
|
new) _postman_collection_new ;;
|
|
188
188
|
migrate) _postman_collection_migrate ;;
|
|
189
189
|
lint) _postman_collection_lint ;;
|
|
190
|
-
ai-readiness) _postman_collection_ai_readiness ;;
|
|
191
190
|
get) _postman_collection_get ;;
|
|
191
|
+
publish) _postman_collection_publish ;;
|
|
192
192
|
generate) _postman_collection_generate ;;
|
|
193
193
|
sync) _postman_collection_sync ;;
|
|
194
194
|
request) _postman_collection_request ;;
|
|
@@ -230,29 +230,32 @@ _postman_collection_lint() {
|
|
|
230
230
|
_postman_filematch '!*.@(json)' "$cur"
|
|
231
231
|
}
|
|
232
232
|
|
|
233
|
-
|
|
233
|
+
_postman_collection_get() {
|
|
234
234
|
if [[ "$cur" == -* ]]; then
|
|
235
|
-
COMPREPLY=( $(compgen -W "-
|
|
235
|
+
COMPREPLY=( $(compgen -W "--api-key --json -h --help" -- "$cur") )
|
|
236
236
|
return 0
|
|
237
237
|
fi
|
|
238
238
|
case "$prev" in
|
|
239
|
-
--
|
|
240
|
-
_postman_filematch '!*.@(
|
|
239
|
+
--api-key)
|
|
240
|
+
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
241
241
|
return 0 ;;
|
|
242
242
|
esac
|
|
243
|
-
_postman_filematch '!*.@(json)' "$cur"
|
|
244
243
|
}
|
|
245
244
|
|
|
246
|
-
|
|
245
|
+
_postman_collection_publish() {
|
|
247
246
|
if [[ "$cur" == -* ]]; then
|
|
248
|
-
COMPREPLY=( $(compgen -W "--api-key --json -h --help" -- "$cur") )
|
|
247
|
+
COMPREPLY=( $(compgen -W "--target --environment --title --description --note --api-key --json -h --help" -- "$cur") )
|
|
249
248
|
return 0
|
|
250
249
|
fi
|
|
251
250
|
case "$prev" in
|
|
251
|
+
--environment)
|
|
252
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
253
|
+
return 0 ;;
|
|
252
254
|
--api-key)
|
|
253
255
|
_postman_filematch '!*.@(pem|crt|key)' "$cur"
|
|
254
256
|
return 0 ;;
|
|
255
257
|
esac
|
|
258
|
+
_postman_filematch '!*.@(json)' "$cur"
|
|
256
259
|
}
|
|
257
260
|
|
|
258
261
|
_postman_collection_generate() {
|
|
@@ -336,7 +339,7 @@ _postman_collection_request_add() {
|
|
|
336
339
|
|
|
337
340
|
_postman_collection_request_update() {
|
|
338
341
|
if [[ "$cur" == -* ]]; then
|
|
339
|
-
COMPREPLY=( $(compgen -W "--collection --folder --rename --url --method --param -d --body --variables --description --headers --auth --scripts -w --workspace --type --json -h --help" -- "$cur") )
|
|
342
|
+
COMPREPLY=( $(compgen -W "--collection --folder --rename --url --method --param --clear-params -d --body --variables --description --headers --auth --scripts -w --workspace --type --json -h --help" -- "$cur") )
|
|
340
343
|
return 0
|
|
341
344
|
fi
|
|
342
345
|
case "$prev" in
|
|
@@ -708,13 +711,12 @@ _postman_spec() {
|
|
|
708
711
|
if [[ "$cur" == -* ]]; then
|
|
709
712
|
COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
|
|
710
713
|
else
|
|
711
|
-
COMPREPLY=( $(compgen -W "lint
|
|
714
|
+
COMPREPLY=( $(compgen -W "lint list get file create generate sync delete" -- "$cur") )
|
|
712
715
|
fi
|
|
713
716
|
return 0
|
|
714
717
|
fi
|
|
715
718
|
case "$subcmd" in
|
|
716
719
|
lint) _postman_spec_lint ;;
|
|
717
|
-
ai-readiness) _postman_spec_ai_readiness ;;
|
|
718
720
|
list) _postman_spec_list ;;
|
|
719
721
|
get) _postman_spec_get ;;
|
|
720
722
|
file) _postman_spec_file ;;
|
|
@@ -734,18 +736,6 @@ _postman_spec_lint() {
|
|
|
734
736
|
esac
|
|
735
737
|
}
|
|
736
738
|
|
|
737
|
-
_postman_spec_ai_readiness() {
|
|
738
|
-
if [[ "$cur" == -* ]]; then
|
|
739
|
-
COMPREPLY=( $(compgen -W "-o --output --export --min-score -h --help" -- "$cur") )
|
|
740
|
-
return 0
|
|
741
|
-
fi
|
|
742
|
-
case "$prev" in
|
|
743
|
-
--export)
|
|
744
|
-
_postman_filematch '!*.@(json)' "$cur"
|
|
745
|
-
return 0 ;;
|
|
746
|
-
esac
|
|
747
|
-
}
|
|
748
|
-
|
|
749
739
|
_postman_spec_list() {
|
|
750
740
|
if [[ "$cur" == -* ]]; then
|
|
751
741
|
COMPREPLY=( $(compgen -W "-w --workspace --api-key --json -h --help" -- "$cur") )
|
|
@@ -1582,7 +1572,7 @@ _postman_mock_generate() {
|
|
|
1582
1572
|
|
|
1583
1573
|
_postman_mock_run() {
|
|
1584
1574
|
if [[ "$cur" == -* ]]; then
|
|
1585
|
-
COMPREPLY=( $(compgen -W "-e --environment -g --globals -p --port --api-key -w --workspace --no-history --dataset -h --help" -- "$cur") )
|
|
1575
|
+
COMPREPLY=( $(compgen -W "-e --environment -g --globals -p --port --api-key -w --workspace --no-history --output --dataset -h --help" -- "$cur") )
|
|
1586
1576
|
return 0
|
|
1587
1577
|
fi
|
|
1588
1578
|
case "$prev" in
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Fish completion for Postman CLI (postman v1.
|
|
1
|
+
# Fish completion for Postman CLI (postman v1.67.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
|
|
@@ -113,17 +113,17 @@ complete -c postman -n '__fish_seen_subcommand_from skills; and __fish_seen_subc
|
|
|
113
113
|
complete -c postman -n '__fish_seen_subcommand_from skills; and __fish_seen_subcommand_from update' -r -k -a '(__fish_complete_suffix .json)'
|
|
114
114
|
|
|
115
115
|
# ---------- collection ----------
|
|
116
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
117
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
118
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
119
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
120
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
121
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
122
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
123
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
124
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
125
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
126
|
-
complete -c postman -n '__postman_using_subcommand collection new migrate lint
|
|
116
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a new -d 'Scaffold a v3 collection on disk, or create one in a cloud Postman workspace with --workspace.'
|
|
117
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a migrate -d 'Migrate a v2.1 collection to the v3 format'
|
|
118
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a lint -d 'Run linting on a local v3 collection at the given file or directory path.'
|
|
119
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a get -d 'Fetch a Postman collection in the V3 format and print it.'
|
|
120
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a publish -d 'Publish a cloud collection\'s documentation (or request Community Manager approval).'
|
|
121
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a generate -d 'Generate artifacts from a collection.'
|
|
122
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a sync -d 'Sync artifacts generated from a collection.'
|
|
123
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a request -d 'Add, update, or remove requests in a local v3 collection.'
|
|
124
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a folder -d 'Add, update, or remove folders in a local v3 collection.'
|
|
125
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a list -d 'List collections: your local project\'s collections by default, or a Postman cloud workspace\'s collections with --workspace.'
|
|
126
|
+
complete -c postman -n '__postman_using_subcommand collection new migrate lint get publish generate sync request folder list run' -a run -d 'Initiate a Postman collection run from a given ID or path.'
|
|
127
127
|
complete -c postman -n '__fish_seen_subcommand_from collection' -s h -l help -d 'display help for command'
|
|
128
128
|
# ---------- collection new ----------
|
|
129
129
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from new' -s w -l workspace -d 'Create the collection in a cloud Postman workspace instead of scaffolding it locally. Required when the current directory is not a local Postman workspace.' -x
|
|
@@ -140,16 +140,20 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
140
140
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from lint' -s r -l reporter -d 'Output format: cli (human-readable) or json. (default: "cli")' -x
|
|
141
141
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from lint' -s h -l help -d 'display help for command'
|
|
142
142
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from lint' -r -k -a '(__fish_complete_suffix .json)'
|
|
143
|
-
# ---------- collection ai-readiness ----------
|
|
144
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from ai-readiness' -s o -l output -d 'Output format for the results. [choices: "cli", "json", "html"]' -x
|
|
145
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from ai-readiness' -l export -d 'Write the report to this file instead of stdout. A directory receives the report under a name derived from the collection. Requires --output html.' -r
|
|
146
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from ai-readiness' -l min-score -d 'Exit with a non-zero code if the overall score is below this threshold (0-100).' -x
|
|
147
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from ai-readiness' -s h -l help -d 'display help for command'
|
|
148
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from ai-readiness' -r -k -a '(__fish_complete_suffix .json)'
|
|
149
143
|
# ---------- collection get ----------
|
|
150
144
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from get' -l api-key -d 'Postman API key (defaults to your `postman login` session)' -r
|
|
151
145
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from get' -l json -d 'Print the collection as machine-readable V3 JSON instead of a table'
|
|
152
146
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from get' -s h -l help -d 'display help for command'
|
|
147
|
+
# ---------- collection publish ----------
|
|
148
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -l target -d 'Where to publish (default: documentation) (default: "documentation")' -x
|
|
149
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -l environment -d 'Cloud environment UID to bind to the docs' -r
|
|
150
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -l title -d 'SEO title meta tag (max 120 characters)' -x
|
|
151
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -l description -d 'SEO description meta tag (max 320 characters)' -x
|
|
152
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -l note -d 'Note for Community Managers (request-to-publish only)' -x
|
|
153
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -l api-key -d 'Postman API key (defaults to your `postman login` session)' -r
|
|
154
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -l json -d 'Machine-readable JSON on stdout (errors on stderr)'
|
|
155
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -s h -l help -d 'display help for command'
|
|
156
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from publish' -r -k -a '(__fish_complete_suffix .json)'
|
|
153
157
|
# ---------- collection generate ----------
|
|
154
158
|
complete -c postman -n '__postman_using_subcommand generate spec' -a spec -d 'Generate an OpenAPI specification from a Postman collection.'
|
|
155
159
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from generate' -s h -l help -d 'display help for command'
|
|
@@ -185,9 +189,10 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
185
189
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l collection -d 'Target collection: name, directory, id, cloud id, or path (cloud: id only). Required.' -x
|
|
186
190
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l folder -d 'Folder to scope the request selector, e.g. "Users/Admin" (local: name/path; cloud: id).' -x
|
|
187
191
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l rename -d 'Rename the request (moves its file). Any request type.' -x
|
|
188
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l url -d 'Request URL. Any request type.' -x
|
|
192
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l url -d 'Request URL; its query string becomes the query parameters. Any request type.' -x
|
|
189
193
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l method -d 'HTTP method (http requests only).' -x
|
|
190
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l param -d 'Replace query parameters. Repeatable (http requests only). (default: [])' -r
|
|
194
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l param -d 'Replace all query parameters and the url query string. Repeatable (http requests only). (default: [])' -r
|
|
195
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l clear-params -d 'Remove all query parameters and the url query string (http requests only).'
|
|
191
196
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -s d -l body -d 'Request payload (inline, @file, or - for stdin), interpreted by request type. For http, an optional "<type>:" prefix picks the content type: json/text/xml/html/javascript, file:<path>, urlencoded:key=v&k2=v2, or formdata:key=v&file=@path.' -x
|
|
192
197
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l variables -d 'GraphQL variables JSON (graphql requests only).' -x
|
|
193
198
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from request; and __fish_seen_subcommand_from update' -l description -d 'Request description.' -x
|
|
@@ -249,9 +254,9 @@ complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_
|
|
|
249
254
|
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.'
|
|
250
255
|
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
|
|
251
256
|
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
|
|
252
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l iteration-data-dataset -d '
|
|
253
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l iteration-data-view -d '
|
|
254
|
-
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l dataset -d '
|
|
257
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l iteration-data-dataset -d 'Path to a .dataset.yaml (local collection) or a cloud dataset id (cloud collection) whose view drives the iteration data. Mutually exclusive with --iteration-data. Requires --iteration-data-view.' -r
|
|
258
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l iteration-data-view -d 'Name or id of the view to execute (within --iteration-data-dataset). The view\'s result set drives one iteration per row.' -x
|
|
259
|
+
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l dataset -d 'Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to collection scripts and local mock handlers as pm.datasets(<id>). When provided, auto-discovery of .dataset.yaml files from the collection\'s parent repo is disabled. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged-in cloud session. (default: [])' -r
|
|
255
260
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -s i -d 'Specify the request/folder id, name, or path to run from the collection. Use a path (e.g. "FolderName/RequestName") to disambiguate items with the same name. Can be specified multiple times to run multiple items (default: [])' -x
|
|
256
261
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l global-var -d 'Allows the specification of global variables via the command line, in a key=value format' -x
|
|
257
262
|
complete -c postman -n '__fish_seen_subcommand_from collection; and __fish_seen_subcommand_from run' -l env-var -d 'Allows the specification of environment variables via the command line, in a key=value format (default: [])' -x
|
|
@@ -412,15 +417,14 @@ complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subc
|
|
|
412
417
|
complete -c postman -n '__fish_seen_subcommand_from runner; and __fish_seen_subcommand_from regions' -s h -l help -d 'display help for command'
|
|
413
418
|
|
|
414
419
|
# ---------- spec ----------
|
|
415
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
416
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
417
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
418
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
419
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
420
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
421
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
422
|
-
complete -c postman -n '__postman_using_subcommand spec lint
|
|
423
|
-
complete -c postman -n '__postman_using_subcommand spec lint ai-readiness list get file create generate sync delete' -a delete -d 'Delete a spec by its cloud ID or local file path. Cannot be undone.'
|
|
420
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a lint -d 'Run linting on the given specification by ID or local file path.'
|
|
421
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a list -d 'List local spec files under a path, or (no path) a workspace\'s cloud specs.'
|
|
422
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a get -d 'Read a spec definition, including every file of a multi-file spec.'
|
|
423
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a file -d 'Add, update, or remove files in a spec (cloud ID or local directory).'
|
|
424
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a create -d 'Create a new spec in a workspace, or (with path) scaffold a local spec file.'
|
|
425
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a generate -d 'Generate artifacts from a specification.'
|
|
426
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a sync -d 'Sync a generated collection with its source specification.'
|
|
427
|
+
complete -c postman -n '__postman_using_subcommand spec lint list get file create generate sync delete' -a delete -d 'Delete a spec by its cloud ID or local file path. Cannot be undone.'
|
|
424
428
|
complete -c postman -n '__fish_seen_subcommand_from spec' -s h -l help -d 'display help for command'
|
|
425
429
|
# ---------- spec lint ----------
|
|
426
430
|
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
|
|
@@ -429,11 +433,6 @@ complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcom
|
|
|
429
433
|
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'
|
|
430
434
|
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'
|
|
431
435
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from lint' -s h -l help -d 'display help for command'
|
|
432
|
-
# ---------- spec ai-readiness ----------
|
|
433
|
-
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
|
|
434
|
-
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from ai-readiness' -l export -d 'Write the report to this file instead of stdout. A directory receives the report under a name derived from the specification. Requires --output html.' -r
|
|
435
|
-
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from ai-readiness' -l min-score -d 'Exit with a non-zero code if the overall score is below this threshold (0-100).' -x
|
|
436
|
-
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from ai-readiness' -s h -l help -d 'display help for command'
|
|
437
436
|
# ---------- spec list ----------
|
|
438
437
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from list' -s w -l workspace -d 'Workspace ID (defaults to .postman/resources.yaml binding)' -x
|
|
439
438
|
complete -c postman -n '__fish_seen_subcommand_from spec; and __fish_seen_subcommand_from list' -l api-key -d 'Postman API key' -r
|
|
@@ -997,6 +996,7 @@ complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcom
|
|
|
997
996
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -l api-key -d 'Postman API key, used with a Postman cloud id (defaults to your `postman login` session)' -r
|
|
998
997
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -s w -l workspace -d 'Workspace that owns the run, for recording its start history. Auto-resolved for a Postman cloud id; required to record history for a path.' -x
|
|
999
998
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -l no-history -d 'Do not record this run in the mock\'s start history.'
|
|
999
|
+
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -l output -d 'Live output format: auto (default, human-readable logs) or ndjson (one JSON event per line on stdout, ending with a "summary" event — for CI or other non-interactive use) (default: "auto")' -x
|
|
1000
1000
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -l dataset -d 'Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to the mock\'s handlers as pm.datasets(<id>). (default: [])' -r
|
|
1001
1001
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
|
|
1002
1002
|
complete -c postman -n '__fish_seen_subcommand_from mock; and __fish_seen_subcommand_from run' -r -k -a '(__fish_complete_suffix .json)'
|
|
@@ -1283,7 +1283,7 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
1283
1283
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -l json -d 'Output the full dataset as JSON'
|
|
1284
1284
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from get' -s h -l help -d 'display help for command'
|
|
1285
1285
|
# ---------- dataset query ----------
|
|
1286
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s q -l query -d 'SQL query to execute (e.g. "SELECT * FROM
|
|
1286
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s q -l query -d 'SQL query to execute (e.g. "SELECT * FROM users LIMIT 10")' -x
|
|
1287
1287
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s s -l source -d 'Execute directly against a database datasource; without --source, use federated SQLite' -x
|
|
1288
1288
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -s p -l param -d 'Bind values to $1, $2, ... in order; pass multiple values after -p or repeat -p' -x
|
|
1289
1289
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from query' -l api-key -d 'Postman API key (defaults to the `postman login` session)' -r
|
|
@@ -1318,14 +1318,14 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
1318
1318
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from list' -s h -l help -d 'display help for command'
|
|
1319
1319
|
# ---------- dataset source add ----------
|
|
1320
1320
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -s d -l dataset -d 'Dataset to add the source to; positional target is also accepted for v1.45 compatibility' -x
|
|
1321
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -s n -l name -d 'Logical name for the source (becomes the SQL table name)' -x
|
|
1321
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -s n -l name -d 'Logical name for the source (becomes the SQL table name). Required for every source except a spreadsheet, whose worksheets are each named source_<worksheet>' -x
|
|
1322
1322
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l source-id -d 'Override the generated source id (local dataset only)' -x
|
|
1323
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l format -d 'Use this format instead of extension/type inference; file contents are not sniffed' -x
|
|
1323
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l format -d 'Use this format instead of extension/type inference; file contents are not sniffed. A spreadsheet (xlsx/xls/ods) is added as one source per worksheet, each named source_<worksheet>' -x
|
|
1324
1324
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l type -d 'Source kind; local is inferred from --file, jdbc from --driver-jar' -x
|
|
1325
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l file -d 'Path to a local CSV/JSON file (absolute or cwd-relative)' -r
|
|
1325
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l file -d 'Path to a local CSV/JSON/spreadsheet file (absolute or cwd-relative)' -r
|
|
1326
1326
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l ref-only -d 'Reference the file in place; do NOT copy into data_dir (local dataset)'
|
|
1327
1327
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l force -d 'When copying, overwrite an existing file at the destination (local dataset)'
|
|
1328
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l upload -d 'Cloud dataset only: upload --file as a postmancloudfile source (runs via /exec). Without --upload, --file is registered as a local_filesystem
|
|
1328
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l upload -d 'Cloud dataset only: upload --file as a postmancloudfile source (runs via /exec). Without --upload, --file is registered as a local_filesystem source read by the local engine. Either way a cloud dataset takes csv/json only — add a spreadsheet to a local .dataset.yaml, where each worksheet becomes its own source.'
|
|
1329
1329
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l driver-jar -d 'JDBC driver JAR(s). Repeatable, or pass several after one flag' -r
|
|
1330
1330
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l driver-class -d 'Driver class. Auto-resolved when the JAR contains exactly one' -x
|
|
1331
1331
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from add' -l driver-name -d 'Label for this driver type (defaults to the JAR filename)' -x
|
|
@@ -1368,7 +1368,7 @@ complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_sub
|
|
|
1368
1368
|
# ---------- dataset source update ----------
|
|
1369
1369
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -s d -l dataset -d 'Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id' -x
|
|
1370
1370
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -s n -l name -d 'Rename the source' -x
|
|
1371
|
-
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l format -d 'Change the format (local dataset only; cloud source formats are immutable)' -x
|
|
1371
|
+
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l format -d 'Change the format (local dataset only; cloud source formats are immutable). A spreadsheet format is not offered here: this command changes the format field alone and cannot pin a worksheet, so the source would not compile. Add the workbook with `dataset source add` instead, which makes one worksheet-pinned source per sheet' -x
|
|
1372
1372
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l file -d 'Replace the source file (local dataset only; cloud file replacement is unsupported)' -r
|
|
1373
1373
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l ref-only -d 'With --file, reference in place instead of copying (local dataset only)'
|
|
1374
1374
|
complete -c postman -n '__fish_seen_subcommand_from dataset; and __fish_seen_subcommand_from source; and __fish_seen_subcommand_from update' -l force -d 'With --file, overwrite the copied destination (local dataset only)'
|
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.67.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
|
|
@@ -207,8 +207,8 @@ _postman_collection() {
|
|
|
207
207
|
new) _postman_collection_new ;;
|
|
208
208
|
migrate) _postman_collection_migrate ;;
|
|
209
209
|
lint) _postman_collection_lint ;;
|
|
210
|
-
ai-readiness) _postman_collection_ai_readiness ;;
|
|
211
210
|
get) _postman_collection_get ;;
|
|
211
|
+
publish) _postman_collection_publish ;;
|
|
212
212
|
generate) _postman_collection_generate ;;
|
|
213
213
|
sync) _postman_collection_sync ;;
|
|
214
214
|
request) _postman_collection_request ;;
|
|
@@ -226,8 +226,8 @@ _postman_collection_commands() {
|
|
|
226
226
|
'new:Scaffold a v3 collection on disk, or create one in a cloud Postman workspace with --workspace.'
|
|
227
227
|
'migrate:Migrate a v2.1 collection to the v3 format'
|
|
228
228
|
'lint:Run linting on a local v3 collection at the given file or directory path.'
|
|
229
|
-
'ai-readiness:Score a Postman collection for AI readiness by ID, local file path, or local-mode directory.'
|
|
230
229
|
'get:Fetch a Postman collection in the V3 format and print it.'
|
|
230
|
+
'publish:Publish a cloud collection'\''s documentation (or request Community Manager approval).'
|
|
231
231
|
'generate:Generate artifacts from a collection.'
|
|
232
232
|
'sync:Sync artifacts generated from a collection.'
|
|
233
233
|
'request:Add, update, or remove requests in a local v3 collection.'
|
|
@@ -263,21 +263,25 @@ _postman_collection_lint() {
|
|
|
263
263
|
'*:path:_files -g "*.json"'
|
|
264
264
|
}
|
|
265
265
|
|
|
266
|
-
|
|
266
|
+
_postman_collection_get() {
|
|
267
267
|
_arguments \
|
|
268
|
-
'
|
|
269
|
-
'--
|
|
270
|
-
'--min-score[Exit with a non-zero code if the overall score is below this threshold (0-100).]:n' \
|
|
268
|
+
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
269
|
+
'--json[Print the collection as machine-readable V3 JSON instead of a table]' \
|
|
271
270
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
272
|
-
'*:
|
|
271
|
+
'*:id:'
|
|
273
272
|
}
|
|
274
273
|
|
|
275
|
-
|
|
274
|
+
_postman_collection_publish() {
|
|
276
275
|
_arguments \
|
|
276
|
+
'--target[Where to publish (default\: documentation) (default\: "documentation")]:name' \
|
|
277
|
+
'--environment[Cloud environment UID to bind to the docs]:environment-id:_files -g "*.json"' \
|
|
278
|
+
'--title[SEO title meta tag (max 120 characters)]:seo-title' \
|
|
279
|
+
'--description[SEO description meta tag (max 320 characters)]:seo-description' \
|
|
280
|
+
'--note[Note for Community Managers (request-to-publish only)]:text' \
|
|
277
281
|
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
278
|
-
'--json[
|
|
282
|
+
'--json[Machine-readable JSON on stdout (errors on stderr)]' \
|
|
279
283
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
280
|
-
'*:id:'
|
|
284
|
+
'*:collection-id:_files -g "*.json"'
|
|
281
285
|
}
|
|
282
286
|
|
|
283
287
|
_postman_collection_generate() {
|
|
@@ -391,9 +395,10 @@ _postman_collection_request_update() {
|
|
|
391
395
|
'--collection[Target collection\: name, directory, id, cloud id, or path (cloud\: id only). Required.]:id|name' \
|
|
392
396
|
'--folder[Folder to scope the request selector, e.g. "Users/Admin" (local\: name/path; cloud\: id).]:id|name|path' \
|
|
393
397
|
'--rename[Rename the request (moves its file). Any request type.]:name' \
|
|
394
|
-
'--url[Request URL. Any request type.]:url' \
|
|
398
|
+
'--url[Request URL; its query string becomes the query parameters. Any request type.]:url' \
|
|
395
399
|
'--method[HTTP method (http requests only).]:method' \
|
|
396
|
-
'--param[Replace query parameters. Repeatable (http requests only). (default\: \[\])]:key\:value:_files -g "*.(pem|crt|key)"' \
|
|
400
|
+
'--param[Replace all query parameters and the url query string. Repeatable (http requests only). (default\: \[\])]:key\:value:_files -g "*.(pem|crt|key)"' \
|
|
401
|
+
'--clear-params[Remove all query parameters and the url query string (http requests only).]' \
|
|
397
402
|
'(-d --body)'{-d,--body}'[Request payload (inline, @file, or - for stdin), interpreted by request type. For http, an optional "<type>\:" prefix picks the content type\: json/text/xml/html/javascript, file\:<path>, urlencoded\:key=v&k2=v2, or formdata\:key=v&file=@path.]:body' \
|
|
398
403
|
'--variables[GraphQL variables JSON (graphql requests only).]:json' \
|
|
399
404
|
'--description[Request description.]:text' \
|
|
@@ -501,9 +506,9 @@ _postman_collection_run() {
|
|
|
501
506
|
'--reporter-json-structure[\[Optional\] Generate JSON report using the Newman schema. By default, JSON reports use the native structure of Postman CLI.]' \
|
|
502
507
|
'(-n --iteration-count)'{-n,--iteration-count}'[Define the number of iterations to run]:n' \
|
|
503
508
|
'(-d --iteration-data)'{-d,--iteration-data}'[Specify a data file to use for iterations (either JSON or CSV)]:path:_files -g "*.(json|csv)"' \
|
|
504
|
-
'--iteration-data-dataset[
|
|
505
|
-
'--iteration-data-view[
|
|
506
|
-
'--dataset[
|
|
509
|
+
'--iteration-data-dataset[Path to a .dataset.yaml (local collection) or a cloud dataset id (cloud collection) whose view drives the iteration data. Mutually exclusive with --iteration-data. Requires --iteration-data-view.]:pathOrId:_files -g "*.(json|csv)"' \
|
|
510
|
+
'--iteration-data-view[Name or id of the view to execute (within --iteration-data-dataset). The view'\''s result set drives one iteration per row.]:nameOrId' \
|
|
511
|
+
'--dataset[Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to collection scripts and local mock handlers as pm.datasets(<id>). When provided, auto-discovery of .dataset.yaml files from the collection'\''s parent repo is disabled. For a cloud collection, scripts address cloud datasets by id via pm.datasets(<id>) (resolved from your `postman login` session). SECURITY\: for a cloud collection this does NOT scope access — a script can pm.datasets(<anyId>) for any dataset your session can read. Only run collections you trust against a logged-in cloud session. (default\: \[\])]:pathOrDir:_files -g "*.json"' \
|
|
507
512
|
'-i[Specify the request/folder id, name, or path to run from the collection. Use a path (e.g. "FolderName/RequestName") to disambiguate items with the same name. Can be specified multiple times to run multiple items (default\: \[\])]:id' \
|
|
508
513
|
'--global-var[Allows the specification of global variables via the command line, in a key=value format]:value' \
|
|
509
514
|
'--env-var[Allows the specification of environment variables via the command line, in a key=value format (default\: \[\])]:value' \
|
|
@@ -829,7 +834,6 @@ _postman_spec() {
|
|
|
829
834
|
args)
|
|
830
835
|
case $words[1] in
|
|
831
836
|
lint) _postman_spec_lint ;;
|
|
832
|
-
ai-readiness) _postman_spec_ai_readiness ;;
|
|
833
837
|
list) _postman_spec_list ;;
|
|
834
838
|
get) _postman_spec_get ;;
|
|
835
839
|
file) _postman_spec_file ;;
|
|
@@ -846,7 +850,6 @@ _postman_spec_commands() {
|
|
|
846
850
|
local -a sub
|
|
847
851
|
sub=(
|
|
848
852
|
'lint:Run linting on the given specification by ID or local file path.'
|
|
849
|
-
'ai-readiness:Score an OpenAPI specification for AI readiness by ID or local file path.'
|
|
850
853
|
'list:List local spec files under a path, or (no path) a workspace'\''s cloud specs.'
|
|
851
854
|
'get:Read a spec definition, including every file of a multi-file spec.'
|
|
852
855
|
'file:Add, update, or remove files in a spec (cloud ID or local directory).'
|
|
@@ -869,15 +872,6 @@ _postman_spec_lint() {
|
|
|
869
872
|
'*:spec:'
|
|
870
873
|
}
|
|
871
874
|
|
|
872
|
-
_postman_spec_ai_readiness() {
|
|
873
|
-
_arguments \
|
|
874
|
-
'(-o --output)'{-o,--output}'[Output format for the results. \[choices\: "cli", "json", "html"\]]:value' \
|
|
875
|
-
'--export[Write the report to this file instead of stdout. A directory receives the report under a name derived from the specification. Requires --output html.]:path:_files -g "*.json"' \
|
|
876
|
-
'--min-score[Exit with a non-zero code if the overall score is below this threshold (0-100).]:n' \
|
|
877
|
-
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
878
|
-
'*:spec:'
|
|
879
|
-
}
|
|
880
|
-
|
|
881
875
|
_postman_spec_list() {
|
|
882
876
|
_arguments \
|
|
883
877
|
'(-w --workspace)'{-w,--workspace}'[Workspace ID (defaults to .postman/resources.yaml binding)]:id' \
|
|
@@ -1938,6 +1932,7 @@ _postman_mock_run() {
|
|
|
1938
1932
|
'--api-key[Postman API key, used with a Postman cloud id (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1939
1933
|
'(-w --workspace)'{-w,--workspace}'[Workspace that owns the run, for recording its start history. Auto-resolved for a Postman cloud id; required to record history for a path.]:id' \
|
|
1940
1934
|
'--no-history[Do not record this run in the mock'\''s start history.]' \
|
|
1935
|
+
'--output[Live output format\: auto (default, human-readable logs) or ndjson (one JSON event per line on stdout, ending with a "summary" event — for CI or other non-interactive use) (default\: "auto")]:format' \
|
|
1941
1936
|
'--dataset[Pass --dataset multiple times to load several .dataset.yaml files (or directories containing them). Each is made available to the mock'\''s handlers as pm.datasets(<id>). (default\: \[\])]:pathOrDir:_files -g "*.json"' \
|
|
1942
1937
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1943
1938
|
'*:mockIdOrPath:_files -g "*.json"'
|
|
@@ -2713,7 +2708,7 @@ _postman_dataset_get() {
|
|
|
2713
2708
|
|
|
2714
2709
|
_postman_dataset_query() {
|
|
2715
2710
|
_arguments \
|
|
2716
|
-
'(-q --query)'{-q,--query}'[SQL query to execute (e.g. "SELECT * FROM
|
|
2711
|
+
'(-q --query)'{-q,--query}'[SQL query to execute (e.g. "SELECT * FROM users LIMIT 10")]:sql' \
|
|
2717
2712
|
'(-s --source)'{-s,--source}'[Execute directly against a database datasource; without --source, use federated SQLite]:nameOrIdOrSlug' \
|
|
2718
2713
|
'(-p --param)'{-p,--param}'[Bind values to $1, $2, ... in order; pass multiple values after -p or repeat -p]:value...' \
|
|
2719
2714
|
'--api-key[Postman API key (defaults to the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
@@ -2787,14 +2782,14 @@ _postman_dataset_source_list() {
|
|
|
2787
2782
|
_postman_dataset_source_add() {
|
|
2788
2783
|
_arguments \
|
|
2789
2784
|
'(-d --dataset)'{-d,--dataset}'[Dataset to add the source to; positional target is also accepted for v1.45 compatibility]:datasetPathOrId' \
|
|
2790
|
-
'(-n --name)'{-n,--name}'[Logical name for the source (becomes the SQL table name)]:name' \
|
|
2785
|
+
'(-n --name)'{-n,--name}'[Logical name for the source (becomes the SQL table name). Required for every source except a spreadsheet, whose worksheets are each named source_<worksheet>]:name' \
|
|
2791
2786
|
'--source-id[Override the generated source id (local dataset only)]:uuid' \
|
|
2792
|
-
'--format[Use this format instead of extension/type inference; file contents are not sniffed]:csv|json|mysql|postgres|sqlserver' \
|
|
2787
|
+
'--format[Use this format instead of extension/type inference; file contents are not sniffed. A spreadsheet (xlsx/xls/ods) is added as one source per worksheet, each named source_<worksheet>]:csv|json|xlsx|xls|ods|jdbc|mysql|postgres|sqlserver' \
|
|
2793
2788
|
'--type[Source kind; local is inferred from --file, jdbc from --driver-jar]:local|mysql|postgresql|sqlserver|jdbc' \
|
|
2794
|
-
'--file[Path to a local CSV/JSON file (absolute or cwd-relative)]:path:_files -g "*.json"' \
|
|
2789
|
+
'--file[Path to a local CSV/JSON/spreadsheet file (absolute or cwd-relative)]:path:_files -g "*.json"' \
|
|
2795
2790
|
'--ref-only[Reference the file in place; do NOT copy into data_dir (local dataset)]' \
|
|
2796
2791
|
'--force[When copying, overwrite an existing file at the destination (local dataset)]' \
|
|
2797
|
-
'--upload[Cloud dataset only\: upload --file as a postmancloudfile source (runs via /exec). Without --upload, --file is registered as a local_filesystem
|
|
2792
|
+
'--upload[Cloud dataset only\: upload --file as a postmancloudfile source (runs via /exec). Without --upload, --file is registered as a local_filesystem source read by the local engine. Either way a cloud dataset takes csv/json only — add a spreadsheet to a local .dataset.yaml, where each worksheet becomes its own source.]' \
|
|
2798
2793
|
'--driver-jar[JDBC driver JAR(s). Repeatable, or pass several after one flag]:path...:_files -g "*.json"' \
|
|
2799
2794
|
'--driver-class[Driver class. Auto-resolved when the JAR contains exactly one]:fqcn' \
|
|
2800
2795
|
'--driver-name[Label for this driver type (defaults to the JAR filename)]:label' \
|
|
@@ -2845,7 +2840,7 @@ _postman_dataset_source_update() {
|
|
|
2845
2840
|
_arguments \
|
|
2846
2841
|
'(-d --dataset)'{-d,--dataset}'[Dataset the source belongs to — a local .dataset.yaml path or a cloud dataset id]:datasetPathOrId' \
|
|
2847
2842
|
'(-n --name)'{-n,--name}'[Rename the source]:name' \
|
|
2848
|
-
'--format[Change the format (local dataset only; cloud source formats are immutable)]:csv|json|mysql|postgres|sqlserver' \
|
|
2843
|
+
'--format[Change the format (local dataset only; cloud source formats are immutable). A spreadsheet format is not offered here\: this command changes the format field alone and cannot pin a worksheet, so the source would not compile. Add the workbook with `dataset source add` instead, which makes one worksheet-pinned source per sheet]:csv|json|jdbc|mysql|postgres|sqlserver' \
|
|
2849
2844
|
'--file[Replace the source file (local dataset only; cloud file replacement is unsupported)]:path:_files -g "*.json"' \
|
|
2850
2845
|
'--ref-only[With --file, reference in place instead of copying (local dataset only)]' \
|
|
2851
2846
|
'--force[With --file, overwrite the copied destination (local dataset only)]' \
|