https://github.com/commercelayer/commercelayer-cli-plugin-cleanups
https://github.com/commercelayer/commercelayer-cli-plugin-cleanups
commercelayer
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/commercelayer/commercelayer-cli-plugin-cleanups
- Owner: commercelayer
- License: mit
- Created: 2023-04-03T11:18:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T17:06:27.000Z (about 2 years ago)
- Last Synced: 2024-04-12T21:24:55.523Z (about 2 years ago)
- Topics: commercelayer
- Language: TypeScript
- Homepage:
- Size: 724 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @commercelayer/cli-plugin-cleanups
Commerce Layer CLI Cleanups plugin
[](https://oclif.io)
[](https://npmjs.org/package/@commercelayer/cli-plugin-cleanups)
[](https://npmjs.org/package/@commercelayer/cli-plugin-cleanups)
[](https://github.com/@commercelayer/cli-plugin-cleanups/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 cleanups [ID]`](#commercelayer-cleanups-id)
* [`commercelayer cleanups:create`](#commercelayer-cleanupscreate)
* [`commercelayer cleanups:details ID`](#commercelayer-cleanupsdetails-id)
* [`commercelayer cleanups:group GROUP_ID`](#commercelayer-cleanupsgroup-group_id)
* [`commercelayer cleanups:list`](#commercelayer-cleanupslist)
* [`commercelayer cleanups:types`](#commercelayer-cleanupstypes)
### `commercelayer cleanups [ID]`
List all the created cleanups or show details of a single cleanup.
```sh-session
USAGE
$ commercelayer cleanups [ID] [-A | -l ] [-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= limit number of cleanups in output
-s, --status= the cleanup job status
-t, --type= the type of resource cleaned
DESCRIPTION
list all the created cleanups or show details of a single cleanup
```
_See code: [src/commands/cleanups/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-cleanups/blob/main/src/commands/cleanups/index.ts)_
### `commercelayer cleanups:create`
Create a new cleanup.
```sh-session
USAGE
$ commercelayer cleanups:create -t bundles|gift_cards|prices|promotions|... [-w ...] [-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=... 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=
```
_See code: [src/commands/cleanups/create.ts](https://github.com/commercelayer/commercelayer-cli-plugin-cleanups/blob/main/src/commands/cleanups/create.ts)_
### `commercelayer cleanups:details ID`
Show the details of an existing cleanup.
```sh-session
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
$ cl clp:details
```
_See code: [src/commands/cleanups/details.ts](https://github.com/commercelayer/commercelayer-cli-plugin-cleanups/blob/main/src/commands/cleanups/details.ts)_
### `commercelayer cleanups:group GROUP_ID`
List all the cleanups related to a cleanup group.
```sh-session
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
$ cl clp:group
```
_See code: [src/commands/cleanups/group.ts](https://github.com/commercelayer/commercelayer-cli-plugin-cleanups/blob/main/src/commands/cleanups/group.ts)_
### `commercelayer cleanups:list`
List all the created cleanups.
```sh-session
USAGE
$ commercelayer cleanups:list [-A | -l ] [-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= limit number of cleanups in output
-s, --status= the cleanup job status
-t, --type= the type of resource cleaned
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](https://github.com/commercelayer/commercelayer-cli-plugin-cleanups/blob/main/src/commands/cleanups/list.ts)_
### `commercelayer cleanups:types`
Show online documentation for supported resources.
```sh-session
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](https://github.com/commercelayer/commercelayer-cli-plugin-cleanups/blob/main/src/commands/cleanups/types.ts)_