Package Exports

@commercelayer/cli-plugin-resources

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@commercelayer/cli-plugin-resources) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@commercelayer/cli-plugin-resources

Commerce Layer CLI Resources plugin

Usage
Commands

Usage

$ npm install -g @commercelayer/cli-plugin-resources
$ cl-resources COMMAND
running command...
$ cl-resources (-v|--version|version)
@commercelayer/cli-plugin-resources/0.0.9 darwin-x64 node-v15.13.0
$ cl-resources --help [COMMAND]
USAGE
  $ cl-resources COMMAND
...

Commands

cl-resources resources:available
cl-resources resources:create
cl-resources resources:delete
cl-resources resources:filters
cl-resources resources:get RESOURCE [ID]
cl-resources resources:list RESOURCE
cl-resources resources:retrieve RESOURCE [ID]
cl-resources resources:update

`cl-resources resources:available`

list all the available Commerce Layer API resources

USAGE
  $ cl-resources resources:available

See code: src/commands/resources/available.ts

`cl-resources resources:create`

create a new resource

USAGE
  $ cl-resources resources:create

OPTIONS
  -a, --attribute=attribute        define a resource attribute
  -o, --organization=organization  (required) the slug of your organization
  -r, --relationship=relationship  define a relationship with another resource

ALIASES
  $ cl-resources create
  $ cl-resources rc
  $ cl-resources res:create

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

`cl-resources resources:delete`

delete a resource

USAGE
  $ cl-resources resources:delete

OPTIONS
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-resources delete
  $ cl-resources rd
  $ cl-resources res:delete

See code: src/commands/resources/delete.ts

`cl-resources resources:filters`

shows a list of all available filter predicates

USAGE
  $ cl-resources resources:filters

See code: src/commands/resources/filters.ts

`cl-resources resources:get RESOURCE [ID]`

retrieve or list resources

USAGE
  $ cl-resources resources:get RESOURCE [ID]

ARGUMENTS
  RESOURCE  the resource type
  ID        id of the resource to retrieve

OPTIONS
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-resources get
  $ cl-resources res:get

See code: src/commands/resources/get.ts

`cl-resources resources:list RESOURCE`

fetch a collection of resources

USAGE
  $ cl-resources resources:list RESOURCE

ARGUMENTS
  RESOURCE  the resource type

OPTIONS
  -f, --fields=fields              comma separeted list of fields in the format [resource]=field1,field2...
  -i, --include=include            comma separated resources to include
  -n, --pageSize=pageSize          number of elements per page
  -o, --organization=organization  (required) the slug of your organization
  -p, --page=page                  page number
  -s, --sort=sort                  defines results ordering
  -w, --where=where                comma separated list of query filters

ALIASES
  $ cl-resources list
  $ cl-resources rl
  $ cl-resources res:list

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

`cl-resources resources:retrieve RESOURCE [ID]`

fetch a single resource

USAGE
  $ cl-resources resources:retrieve RESOURCE [ID]

ARGUMENTS
  RESOURCE  the resource type
  ID        id of the resource to retrieve

OPTIONS
  -f, --fields=fields              comma separeted list of fields in the format [resource]=field1,field2...
  -i, --include=include            comma separated resources to include
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-resources retrieve
  $ cl-resources rr
  $ cl-resources res:retrieve

See code: src/commands/resources/retrieve.ts

`cl-resources resources:update`

update a resource

USAGE
  $ cl-resources resources:update

OPTIONS
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-resources update
  $ cl-resources ru
  $ cl-resources res:update

See code: src/commands/resources/update.ts