@commercelayer/commercelayer-cli-new
v0.0.0
Published
Commerce Layer CLI
Downloads
1
Readme
commercelayer-cli-new
Commerce Layer CLI
Usage
$ npm install -g @commercelayer/commercelayer-cli-new
$ cl COMMAND
running command...
$ cl (-v|--version|version)
@commercelayer/commercelayer-cli-new/0.0.0 darwin-x64 node-v14.16.0
$ cl --help [COMMAND]
USAGE
$ cl COMMAND
...
Commands
cl applications:current
cl applications:login
cl applications:token
cl get RESOURCE [ID]
cl help [COMMAND]
cl plugins
cl plugins:available
cl plugins:inspect PLUGIN...
cl plugins:install PLUGIN...
cl plugins:link PLUGIN
cl plugins:uninstall PLUGIN...
cl plugins:update
cl applications:current
set or show the current organization
USAGE
$ cl applications:current
OPTIONS
-o, --organization=organization organization slug
--live live execution mode
See code: src/commands/applications/current.ts
cl applications:login
perform CLI login to Commerce Layer
USAGE
$ cl applications:login
OPTIONS
-i, --clientId=clientId (required) organization client_id
-o, --organization=organization (required) organization slug
-s, --clientSecret=clientSecret (required) organization client_secret
See code: src/commands/applications/login.ts
cl applications:token
get new access_token from Commerce Layer
USAGE
$ cl applications:token
OPTIONS
-o, --organization=organization (required) organization slug
-s, --save save access_token
--live live execution mode
See code: src/commands/applications/token.ts
cl get RESOURCE [ID]
Get resources from Commerce Layer
USAGE
$ cl get RESOURCE [ID]
OPTIONS
-h, --help show CLI help
-i, --includes=includes comma separated resources to include
See code: src/commands/get.ts
cl help [COMMAND]
display help for cl
USAGE
$ cl help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
cl plugins
list installed plugins
USAGE
$ cl plugins
OPTIONS
--core show core plugins
EXAMPLE
$ cl plugins
See code: @oclif/plugin-plugins
cl plugins:available
describe the command here
USAGE
$ cl plugins:available
See code: src/commands/plugins/available.ts
cl plugins:inspect PLUGIN...
displays installation properties of a plugin
USAGE
$ cl plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] plugin to inspect
OPTIONS
-h, --help show CLI help
-v, --verbose
EXAMPLE
$ cl plugins:inspect myplugin
See code: @oclif/plugin-plugins
cl plugins:install PLUGIN...
installs a plugin into the CLI
USAGE
$ cl 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
$ cl plugins:add
EXAMPLES
$ cl plugins:install myplugin
$ cl plugins:install https://github.com/someuser/someplugin
$ cl plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
cl plugins:link PLUGIN
links a plugin into the CLI for development
USAGE
$ cl 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
$ cl plugins:link myplugin
See code: @oclif/plugin-plugins
cl plugins:uninstall PLUGIN...
removes a plugin from the CLI
USAGE
$ cl plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ cl plugins:unlink
$ cl plugins:remove
See code: @oclif/plugin-plugins
cl plugins:update
update installed plugins
USAGE
$ cl plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins