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

commercelayer
Last synced: 2 months ago
JSON representation
Host: GitHub
URL: https://github.com/commercelayer/commercelayer-cli-plugin-imports
Owner: commercelayer
License: mit
Created: 2021-09-13T10:54:09.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2026-03-26T18:33:42.000Z (2 months ago)
Last Synced: 2026-03-27T03:54:57.210Z (2 months ago)
Topics: commercelayer
Language: TypeScript
Homepage:
Size: 1.47 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project

README

          # cli-plugin-imports

Commerce Layer CLI Imports plugin

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

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

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

[![License](https://img.shields.io/npm/l/@commercelayer/cli-plugin-imports.svg)](https://github.com/commercelayer/cli-plugin-imports/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 imports [ID]`](#commercelayer-imports-id)

* [`commercelayer imports:create`](#commercelayer-importscreate)

* [`commercelayer imports:delete ID`](#commercelayer-importsdelete-id)

* [`commercelayer imports:details ID`](#commercelayer-importsdetails-id)

* [`commercelayer imports:group GROUP_ID`](#commercelayer-importsgroup-group_id)

* [`commercelayer imports:list`](#commercelayer-importslist)

* [`commercelayer imports:types`](#commercelayer-importstypes)

### `commercelayer imports [ID]`

List all the created imports or show details of a single import.

```sh-session

USAGE

  $ commercelayer imports [ID] [-A | -l ] [-t

    addresses|bundles|coupons|customer_addresses|customer_payment_sources|customer_subscriptions|customers|gift_cards|li

    ne_items|line_item_options|orders|price_tiers|prices|shipping_categories|sku_lists|sku_list_items|sku_options|skus|s

    tock_items|stock_transfers|tags|tax_categories] [-g  | ] [-s in_progress|pending|completed|interrupted] [-e]

    [-w]

ARGUMENTS

  ID  unique id of the import to be retrieved

FLAGS

  -A, --all              show all imports instead of first 25 only

  -e, --errors           show only imports with errors

  -g, --group=    the group ID associated to the import in case of multi-chunk imports

  -l, --limit=    limit number of imports in output

  -s, --status=  the import job status

                         

  -t, --type=    the type of resource imported

                         

  -w, --warnings         show only import with warnings

DESCRIPTION

  list all the created imports or show details of a single import

```

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

### `commercelayer imports:create`

Create a new import.

```sh-session

USAGE

  $ commercelayer imports:create -t addresses|bundles|coupons|customer_addresses|... [-p ] (-C -i )

    [-b | -q | ]

FLAGS

  -C, --csv                                                    accept input file in CSV format

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

                                                               monitor

  -i, --inputs=                                         (required) the path of the file containing the data to

                                                               import

  -p, --parent=                                         the id of the parent resource to be associated with

                                                               imported data

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

  -t, --type=addresses|bundles|coupons|customer_addresses|...  (required) the type of resource being imported

DESCRIPTION

  create a new import

ALIASES

  $ commercelayer imp:create

  $ commercelayer import

EXAMPLES

  $ commercelayer imports:create -t stock_items -p  -i 

  $ cl imp:create -t skus -i 

```

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

### `commercelayer imports:delete ID`

Delete an existing import.

```sh-session

USAGE

  $ commercelayer imports:delete ID

ARGUMENTS

  ID  unique id of the import

DESCRIPTION

  delete an existing import

ALIASES

  $ commercelayer imp:delete

EXAMPLES

  $ commercelayer imports:delete >

  $ cl imp:delete >

```

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

### `commercelayer imports:details ID`

Show the details of an existing import.

```sh-session

USAGE

  $ commercelayer imports:details ID [-l] [-S  -i]

ARGUMENTS

  ID  unique id of the import

FLAGS

  -S, --save-inputs=  save import inputs to local file

  -i, --inputs               show input items associated with the import

  -l, --logs                 show warning and error logs related to the import process

DESCRIPTION

  show the details of an existing import

ALIASES

  $ commercelayer imp:details

EXAMPLES

  $ commercelayer imports:details 

  $ cl imp:details  -i

  $ cl imp:details  -i -l

```

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

### `commercelayer imports:group GROUP_ID`

List all the imports related to an import group.

```sh-session

USAGE

  $ commercelayer imports:group GROUP_ID

ARGUMENTS

  GROUP_ID  unique id of the group import

DESCRIPTION

  list all the imports related to an import group

ALIASES

  $ commercelayer imp:group

EXAMPLES

  $ commercelayer imports:group 

  $ cl imp:group 

```

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

### `commercelayer imports:list`

List all the created imports.

```sh-session

USAGE

  $ commercelayer imports:list [-A | -l ] [-t

    addresses|bundles|coupons|customer_addresses|customer_payment_sources|customer_subscriptions|customers|gift_cards|li

    ne_items|line_item_options|orders|price_tiers|prices|shipping_categories|sku_lists|sku_list_items|sku_options|skus|s

    tock_items|stock_transfers|tags|tax_categories] [-g  | ] [-s in_progress|pending|completed|interrupted] [-e]

    [-w]

FLAGS

  -A, --all              show all imports instead of first 25 only

  -e, --errors           show only imports with errors

  -g, --group=    the group ID associated to the import in case of multi-chunk imports

  -l, --limit=    limit number of imports in output

  -s, --status=  the import job status

                         

  -t, --type=    the type of resource imported

                         

  -w, --warnings         show only import with warnings

DESCRIPTION

  list all the created imports

ALIASES

  $ commercelayer imp:list

EXAMPLES

  $ commercelayer imports

  $ cl imports:list -A

  $ cl imp:list

```

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

### `commercelayer imports:types`

Show online documentation for supported resources.

```sh-session

USAGE

  $ commercelayer imports:types [-O]

FLAGS

  -O, --open  open online documentation page

DESCRIPTION

  show online documentation for supported resources

ALIASES

  $ commercelayer imp:types

EXAMPLES

  $ commercelayer imports:types

  $ cl imp:types

```

_See code: [src/commands/imports/types.ts](https://github.com/commercelayer/commercelayer-cli-plugin-imports/blob/main/src/commands/imports/types.ts)_
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

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

Awesome Lists containing this project

README
