https://github.com/commercelayer/commercelayer-cli-plugin-exports

commercelayer
Last synced: about 1 month ago
JSON representation
Host: GitHub
URL: https://github.com/commercelayer/commercelayer-cli-plugin-exports
Owner: commercelayer
License: mit
Created: 2021-04-14T10:05:14.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2026-04-27T11:12:55.000Z (about 1 month ago)
Last Synced: 2026-04-27T12:11:45.973Z (about 1 month ago)
Topics: commercelayer
Language: TypeScript
Homepage:
Size: 2.16 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project

README

          # @commercelayer/cli-plugin-exports

Commerce Layer CLI Exports plugin

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/@commercelayer/cli-plugin-exports.svg)](https://npmjs.org/package/@commercelayer/cli-plugin-exports)

[![Downloads/week](https://img.shields.io/npm/dw/@commercelayer/cli-plugin-exports.svg)](https://npmjs.org/package/@commercelayer/cli-plugin-exports)

[![License](https://img.shields.io/npm/l/@commercelayer/cli-plugin-exports.svg)](https://github.com/@commercelayer/cli-plugin-exports/blob/master/package.json)

* [Usage](#usage)

* [Commands](#commands)

## Usage

```sh-session

commercelayer COMMAND

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

```

## Commands

* [`commercelayer exports [ID]`](#commercelayer-exports-id)

* [`commercelayer exports:all`](#commercelayer-exportsall)

* [`commercelayer exports:create`](#commercelayer-exportscreate)

* [`commercelayer exports:details ID`](#commercelayer-exportsdetails-id)

* [`commercelayer exports:group GROUP_ID`](#commercelayer-exportsgroup-group_id)

* [`commercelayer exports:interrupt ID`](#commercelayer-exportsinterrupt-id)

* [`commercelayer exports:list`](#commercelayer-exportslist)

* [`commercelayer exports:types`](#commercelayer-exportstypes)

### `commercelayer exports [ID]`

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

```sh-session

USAGE

  $ commercelayer exports [ID] [-A | -l ] [-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=

      limit number of exports in output

  -s, --status=

      the export job status

      

  -t, --type=

      the type of resource exported

      

DESCRIPTION

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

```

_See code: [src/commands/exports/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/index.ts)_

### `commercelayer exports:all`

Export all the records.

```sh-session

USAGE

  $ commercelayer exports:all -t  [-i ...] [-w ...] [-f ...] [-D] [-F csv|json | -C |

    ] [-x  | -X ] [-b] [-P | ] [-O] [-q] [-k] [-S ]

FLAGS

  -C, --csv                 export data in CSV format

  -D, --dry-data            skip redundant attributes

  -F, --format=     [default: json] export file format

                            

  -O, --open                open automatically the file after a successful export

  -P, --prettify            prettify json output format

  -S, --size=        max number of records for each export [1000-5000]

  -X, --save-path=   save command output to file and create missing path directories

  -b, --blind               execute in blind mode without showing the progress monitor

  -f, --fields=...   comma separated list of fields to include in the export

  -i, --include=...  comma separated resources to include

  -k, --keep                keep original export files in temp dir

  -q, --quiet               execute command without showing warning messages

  -t, --type=        (required) the type of resource being exported

  -w, --where=...    comma separated list of query filters

  -x, --save=        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 

  $ cl exp:all -t customers -i customer_subscriptions -w email_end=@test.org -X 

  $ cl export -t skus -w code_start=SHIRT -X  --csv

```

_See code: [src/commands/exports/all.ts](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/all.ts)_

### `commercelayer exports:create`

Create a new export.

```sh-session

USAGE

  $ commercelayer exports:create -t  [-i ...] [-w ...] [-f ...] [-D] [-F csv|json | -C |

    ] [-x  | -X ] [-b] [-P | ] [-O]

FLAGS

  -C, --csv                 export data in CSV format

  -D, --dry-data            skip redundant attributes

  -F, --format=     [default: json] export file format

                            

  -O, --open                open automatically the file after a successful export

  -P, --prettify            prettify json output format

  -X, --save-path=   save command output to file and create missing path directories

  -b, --blind               execute in blind mode without showing the progress monitor

  -f, --fields=...   comma separated list of fields to include in the export

  -i, --include=...  comma separated resources to include

  -t, --type=        (required) the type of resource being exported

  -w, --where=...    comma separated list of query filters

  -x, --save=        save command output to file

DESCRIPTION

  create a new export

ALIASES

  $ commercelayer exp:create

EXAMPLES

  $ commercelayer exports:create -t orders -f number -X 

  $ cl exp:create -t customers -i customer_subscriptions -w email_end=@test.org -X  --csv

```

_See code: [src/commands/exports/create.ts](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/create.ts)_

### `commercelayer exports:details ID`

Show the details of an existing export.

```sh-session

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 

  $ cl exp:details 

```

_See code: [src/commands/exports/details.ts](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/details.ts)_

### `commercelayer exports:group GROUP_ID`

List all the exports related to an export group.

```sh-session

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 

  $ cl exp:group 

```

_See code: [src/commands/exports/group.ts](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/group.ts)_

### `commercelayer exports:interrupt ID`

Show the details of an existing export.

```sh-session

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 

  $ cl exp:interrupt 

```

_See code: [src/commands/exports/interrupt.ts](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/interrupt.ts)_

### `commercelayer exports:list`

List all the created exports.

```sh-session

USAGE

  $ commercelayer exports:list [-A | -l ] [-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=

      limit number of exports in output

  -s, --status=

      the export job status

      

  -t, --type=

      the type of resource exported

      

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](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/list.ts)_

### `commercelayer exports:types`

Show online documentation for supported resources.

```sh-session

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](https://github.com/commercelayer/commercelayer-cli-plugin-exports/blob/main/src/commands/exports/types.ts)_
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/commercelayer/commercelayer-cli-plugin-exports

Awesome Lists containing this project

README
