@commercelayer/cli-plugin-exports
Advanced tools
Commerce Layer CLI Exports plugin
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
commercelayer exports [ID]commercelayer exports:allcommercelayer exports:createcommercelayer exports:details IDcommercelayer exports:group GROUP_IDcommercelayer exports:listcommercelayer exports:typescommercelayer exports [ID]List all the created exports or show details of a single export.
USAGE
$ commercelayer exports [ID] [-A | -l <value>] [-t
addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
gories|transactions|authorizations|captures|voids|refunds] [-s in_progress|pending|completed|interrupted]
ARGUMENTS
ID unique id of the export to be retrieved
FLAGS
-A, --all show all exports instead of first 25 only
-l, --limit=<value> limit number of exports in output
-s, --status=<option> the export job status
<options: in_progress|pending|completed|interrupted>
-t, --type=<option> the type of resource exported
<options: addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orde
rs|payment_methods|price_tiers|prices|shipments|shipping_categories|shipping_methods|sku_lists|
sku_list_items|sku_options|skus|stock_items|tax_categories|transactions|authorizations|captures
|voids|refunds>
DESCRIPTION
list all the created exports or show details of a single export
See code: src/commands/exports/index.ts
commercelayer exports:allExport all the records.
USAGE
$ commercelayer exports:all -t
addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
gories|transactions|authorizations|captures|voids|refunds [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x
<value> | -X <value>] [-b] [-P | ] [-O] [-q] [-k]
FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress
monitor
-i, --include=<value>... comma separated resources to include
-k, --keep keep original export files in temp dir
-q, --quiet execute command without showing warning messages
-t, --type=addresses|bundles|coupons|customer_subscriptions|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file
DESCRIPTION
export all the records
ALIASES
$ commercelayer exp:all
$ commercelayer export
EXAMPLES
$ commercelayer exports:all -t cusorderstomers -X <output-file-path>
$ cl exp:all -t customers -i customer_subscriptions -w email_end=@test.org -X <output-file-path>
$ cl export -t skus -w code_start=SHIRT -X <output-file-path> --csv
See code: src/commands/exports/all.ts
commercelayer exports:createCreate a new export.
USAGE
$ commercelayer exports:create -t
addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
gories|transactions|authorizations|captures|voids|refunds [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x
<value> | -X <value>] [-b] [-P | ] [-O]
FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress
monitor
-i, --include=<value>... comma separated resources to include
-t, --type=addresses|bundles|coupons|customer_subscriptions|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file
DESCRIPTION
create a new export
ALIASES
$ commercelayer exp:create
EXAMPLES
$ commercelayer exports:create -t orders -X <output-file-path>
$ cl exp:create -t customers -i customer_subscriptions -w email_end=@test.org -X <output-file-path> --csv
See code: src/commands/exports/create.ts
commercelayer exports:details IDShow the details of an existing export.
USAGE
$ commercelayer exports:details ID
ARGUMENTS
ID unique id of the export
DESCRIPTION
show the details of an existing export
ALIASES
$ commercelayer exp:details
EXAMPLES
$ commercelayer exports:details <export-id>
$ cl exp:details <export-id>
See code: src/commands/exports/details.ts
commercelayer exports:group GROUP_IDList all the exports related to an export group.
USAGE
$ commercelayer exports:group GROUP_ID
ARGUMENTS
GROUP_ID unique id of the group export
DESCRIPTION
list all the exports related to an export group
ALIASES
$ commercelayer exp:group
EXAMPLES
$ commercelayer exports:group <group-id>
$ cl exp:group <group-id>
See code: src/commands/exports/group.ts
commercelayer exports:listList all the created exports.
USAGE
$ commercelayer exports:list [-A | -l <value>] [-t
addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
gories|transactions|authorizations|captures|voids|refunds] [-s in_progress|pending|completed|interrupted]
FLAGS
-A, --all show all exports instead of first 25 only
-l, --limit=<value> limit number of exports in output
-s, --status=<option> the export job status
<options: in_progress|pending|completed|interrupted>
-t, --type=<option> the type of resource exported
<options: addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orde
rs|payment_methods|price_tiers|prices|shipments|shipping_categories|shipping_methods|sku_lists|
sku_list_items|sku_options|skus|stock_items|tax_categories|transactions|authorizations|captures
|voids|refunds>
DESCRIPTION
list all the created exports
ALIASES
$ commercelayer exp:list
EXAMPLES
$ commercelayer exports
$ cl exports:list -A
$ cl exp:list
See code: src/commands/exports/list.ts
commercelayer exports:typesShow online documentation for supported resources.
USAGE
$ commercelayer exports:types [-O]
FLAGS
-O, --open open online documentation page
DESCRIPTION
show online documentation for supported resources
ALIASES
$ commercelayer exp:types
EXAMPLES
$ commercelayer exports:types
$ cl exp:types
See code: src/commands/exports/types.ts
3.0.0-oclif3.4 (2024-02-22)
FAQs
Commerce Layer CLI Exports plugin
The npm package @commercelayer/cli-plugin-exports receives a total of 13 weekly downloads. As such, @commercelayer/cli-plugin-exports popularity was classified as not popular.
We found that @commercelayer/cli-plugin-exports demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.