README.md

@commercelayer/cli-plugin-cleanups

Commerce Layer CLI Cleanups plugin

• Usage
• Commands

Usage

commercelayer COMMAND

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

Commands

• commercelayer cleanups [ID]
• commercelayer cleanups:create
• commercelayer cleanups:details ID
• commercelayer cleanups:group GROUP_ID
• commercelayer cleanups:list
• commercelayer cleanups:types

commercelayer cleanups [ID]

List all the created cleanups or show details of a single cleanup.

USAGE
  $ commercelayer cleanups [ID] [-A | -l <value>] [-t
    bundles|gift_cards|prices|promotions|sku_lists|sku_options|skus|stock_items] [-s
    in_progress|pending|completed|interrupted]

ARGUMENTS
  ID  unique id of the cleanup to be retrieved

FLAGS
  -A, --all              show all cleanups instead of first 25 only
  -l, --limit=<value>    limit number of cleanups in output
  -s, --status=<option>  the cleanup job status
                         <options: in_progress|pending|completed|interrupted>
  -t, --type=<option>    the type of resource cleaned
                         <options: bundles|gift_cards|prices|promotions|sku_lists|sku_options|skus|stock_items>

DESCRIPTION
  list all the created cleanups or show details of a single cleanup

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

commercelayer cleanups:create

Create a new cleanup.

USAGE
  $ commercelayer cleanups:create -t bundles|gift_cards|prices|promotions|... [-w <value>...] [-b | -q | ]

FLAGS
  -b, --blind                                          execute in blind mode without showing the progress monitor
  -q, --quiet                                          execute command without showing warning messages
  -t, --type=bundles|gift_cards|prices|promotions|...  (required) the type of resource to clean up
  -w, --where=<value>...                               comma separated list of query filters

DESCRIPTION
  create a new cleanup

ALIASES
  $ commercelayer clp:create
  $ commercelayer cleanup

EXAMPLES
  $ commercelayer cleanups:create -t skus

  $ cl clp:create -t stock_items

  $ cl cleanup -t skus -w reference_origin_eq=<ref-id>

See code: src/commands/cleanups/create.ts

commercelayer cleanups:details ID

Show the details of an existing cleanup.

USAGE
  $ commercelayer cleanups:details ID [-l]

ARGUMENTS
  ID  unique id of the cleanup

FLAGS
  -l, --logs  show error logs related to the cleanup process

DESCRIPTION
  show the details of an existing cleanup

ALIASES
  $ commercelayer clp:details

EXAMPLES
  $ commercelayer cleanups:details <cleanup-id>

  $ cl clp:details <cleanup-id>

See code: src/commands/cleanups/details.ts

commercelayer cleanups:group GROUP_ID

List all the cleanups related to a cleanup group.

USAGE
  $ commercelayer cleanups:group GROUP_ID

ARGUMENTS
  GROUP_ID  unique id of the group cleanup

DESCRIPTION
  list all the cleanups related to a cleanup group

ALIASES
  $ commercelayer clp:group

EXAMPLES
  $ commercelayer cleanups:group <group-id>

  $ cl clp:group <group-id>

See code: src/commands/cleanups/group.ts

commercelayer cleanups:list

List all the created cleanups.

USAGE
  $ commercelayer cleanups:list [-A | -l <value>] [-t
    bundles|gift_cards|prices|promotions|sku_lists|sku_options|skus|stock_items] [-s
    in_progress|pending|completed|interrupted]

FLAGS
  -A, --all              show all cleanups instead of first 25 only
  -l, --limit=<value>    limit number of cleanups in output
  -s, --status=<option>  the cleanup job status
                         <options: in_progress|pending|completed|interrupted>
  -t, --type=<option>    the type of resource cleaned
                         <options: bundles|gift_cards|prices|promotions|sku_lists|sku_options|skus|stock_items>

DESCRIPTION
  list all the created cleanups

ALIASES
  $ commercelayer clp:list

EXAMPLES
  $ commercelayer cleanups

  $ cl cleanups:list -A

  $ cl clp:list

See code: src/commands/cleanups/list.ts

commercelayer cleanups:types

Show online documentation for supported resources.

USAGE
  $ commercelayer cleanups:types [-O]

FLAGS
  -O, --open  open online documentation page

DESCRIPTION
  show online documentation for supported resources

ALIASES
  $ commercelayer clp:types

EXAMPLES
  $ commercelayer cleanups:types

  $ cl clp:types

See code: src/commands/cleanups/types.ts