Package Exports

@commercelayer/commercelayer-cli

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/commercelayer-cli) 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

Commerce Layer CLI

Usage
Commands

Usage

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

Commands

commercelayer applications
commercelayer applications:current
commercelayer applications:login
commercelayer applications:token
commercelayer config:default
commercelayer config:del PARAM
commercelayer config:get PARAM
commercelayer config:set PARAM VALUE
commercelayer config:show
commercelayer help [COMMAND]
commercelayer plugins
commercelayer plugins:available
commercelayer plugins:inspect PLUGIN...
commercelayer plugins:install PLUGIN...
commercelayer plugins:link PLUGIN
commercelayer plugins:uninstall PLUGIN...
commercelayer plugins:update

`commercelayer applications`

show a list of all (logged in) available CLI applications

USAGE
  $ commercelayer applications

EXAMPLES
  $ commercelayer applications
  $ cl applications

See code: src/commands/applications.ts

`commercelayer applications:current`

set or show the current CLI application

USAGE
  $ commercelayer applications:current

OPTIONS
  -o, --organization=organization  organization slug
  --live                           live execution mode

ALIASES
  $ commercelayer app:current

EXAMPLES
  $ commercelayer applications:current
  $ commercelayer app:current -o <organizationSlug> --live

See code: src/commands/applications/current.ts

`commercelayer applications:login`

execute login to a CLI Commerce Layer application

USAGE
  $ commercelayer applications:login

OPTIONS
  -i, --clientId=clientId          (required) organization client_id
  -o, --organization=organization  (required) organization slug
  -s, --clientSecret=clientSecret  (required) organization client_secret

ALIASES
  $ commercelayer app:login

EXAMPLE
  $ commercelayer applications:login -o <organizationSlug> -i <clientId> -s <clientSecret>

See code: src/commands/applications/login.ts

`commercelayer applications:token`

get a new access token from Commerce Layer API

USAGE
  $ commercelayer applications:token

OPTIONS
  -o, --organization=organization  (required) [default: cli-test-org] organization slug
  --live                           live execution mode
  --save                           save access token

ALIASES
  $ commercelayer app:token

EXAMPLES
  $ commercelayer applications:token
  $ commercelayer app:token -o <organizationSlug> --live --save

See code: src/commands/applications/token.ts

`commercelayer config:default`

reset CLI configuration to default values

USAGE
  $ commercelayer config:default

See code: src/commands/config/default.ts

`commercelayer config:del PARAM`

delete a CLI configuration parameter

USAGE
  $ commercelayer config:del PARAM

ARGUMENTS
  PARAM  configuration parameter name

See code: src/commands/config/del.ts

`commercelayer config:get PARAM`

get a CLI configuration parameter

USAGE
  $ commercelayer config:get PARAM

ARGUMENTS
  PARAM  configuration parameter name

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

`commercelayer config:set PARAM VALUE`

set a CLI configuration parameter

USAGE
  $ commercelayer config:set PARAM VALUE

ARGUMENTS
  PARAM  configuration parameter name
  VALUE  value to be saved in configuration file

See code: src/commands/config/set.ts

`commercelayer config:show`

show current CLI configuration

USAGE
  $ commercelayer config:show

See code: src/commands/config/show.ts

`commercelayer help [COMMAND]`

display help for commercelayer

USAGE
  $ commercelayer help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`commercelayer plugins`

list installed plugins

USAGE
  $ commercelayer plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ commercelayer plugins

See code: @oclif/plugin-plugins

`commercelayer plugins:available`

show all available Commerce Layer CLI plugins

USAGE
  $ commercelayer plugins:available

EXAMPLE
  $ commercelayer plugins:available

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

`commercelayer plugins:inspect PLUGIN...`

displays installation properties of a plugin

USAGE
  $ commercelayer plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] plugin to inspect

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

EXAMPLE
  $ commercelayer plugins:inspect myplugin

See code: @oclif/plugin-plugins

`commercelayer plugins:install PLUGIN...`

installs a plugin into the CLI

USAGE
  $ commercelayer plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ commercelayer plugins:add

EXAMPLES
  $ commercelayer plugins:install myplugin 
  $ commercelayer plugins:install https://github.com/someuser/someplugin
  $ commercelayer plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

`commercelayer plugins:link PLUGIN`

links a plugin into the CLI for development

USAGE
  $ commercelayer plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLE
  $ commercelayer plugins:link myplugin

See code: @oclif/plugin-plugins

`commercelayer plugins:uninstall PLUGIN...`

removes a plugin from the CLI

USAGE
  $ commercelayer plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ commercelayer plugins:unlink
  $ commercelayer plugins:remove

See code: @oclif/plugin-plugins

`commercelayer plugins:update`

update installed plugins

USAGE
  $ commercelayer plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins