@commercelayer/cli-plugin-exports

@commercelayer/cli-plugin-exports

Commerce Layer CLI Exports plugin

• Usage
• Commands

Usage

commercelayer COMMAND

commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.

Commands

• commercelayer exports [ID]
• commercelayer exports:all
• commercelayer exports:create
• commercelayer exports:details ID
• commercelayer exports:group GROUP_ID
• commercelayer exports:interrupt ID
• commercelayer exports:list
• commercelayer exports:types

commercelayer exports [ID]

List all the created exports or show details of a single export.

USAGE
  $ commercelayer exports [ID] [-A | -l <value>] [-t
    addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
    |customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|returns|shipmen
    ts|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|t
    ax_categories|transactions|voids] [-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|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_sub
      scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|retur
      ns|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transf
      ers|tags|tax_categories|transactions|voids>

DESCRIPTION
  list all the created exports or show details of a single export

See code: src/commands/exports/index.ts

commercelayer exports:all

Export all the records.

USAGE
  $ commercelayer exports:all -t <value> [-i <value>...] [-w <value>...] [-f <value>...] [-D] [-F csv|json | -C |
    ] [-x <value> | -X <value>] [-b] [-P | ] [-O] [-q] [-k] [-S <value>]

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
  -S, --size=<value>        max number of records for each export [1000-5000]
  -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
  -f, --fields=<value>...   comma separated list of fields to include in the export
  -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=<value>        (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 orders -f number -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:create

Create a new export.

USAGE
  $ commercelayer exports:create -t <value> [-i <value>...] [-w <value>...] [-f <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
  -f, --fields=<value>...   comma separated list of fields to include in the export
  -i, --include=<value>...  comma separated resources to include
  -t, --type=<value>        (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 -f number -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 ID

Show the details of an existing export.

USAGE
  $ commercelayer exports:details ID

ARGUMENTS
  ID  id of the export resource

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_ID

List 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:interrupt ID

Show the details of an existing export.

USAGE
  $ commercelayer exports:interrupt ID [-D]

ARGUMENTS
  ID  id of the export resource

FLAGS
  -D, --details  show export details after command execution

DESCRIPTION
  show the details of an existing export

ALIASES
  $ commercelayer exp:interrupt

EXAMPLES
  $ commercelayer exports:interrupt <export-id>

  $ cl exp:interrupt <export-id>

See code: src/commands/exports/interrupt.ts

commercelayer exports:list

List all the created exports.

USAGE
  $ commercelayer exports:list [-A | -l <value>] [-t
    addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
    |customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|returns|shipmen
    ts|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|t
    ax_categories|transactions|voids] [-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|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_sub
      scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|retur
      ns|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transf
      ers|tags|tax_categories|transactions|voids>

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:types

Show 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