@coralproject/coral-cli
CLI to interact with Coral
Last updated 8 months ago by wyattjoh .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @coralproject/coral-cli 
SYNC missed versions from official npm registry.

@coralproject/coral-cli

CLI to interact with Coral

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g @coralproject/coral-cli
$ coral-cli COMMAND
running command...
$ coral-cli (-v|--version|version)
@coralproject/coral-cli/0.2.0 darwin-x64 node-v10.15.3
$ coral-cli --help [COMMAND]
USAGE
  $ coral-cli COMMAND
...

Commands

coral-cli help [COMMAND]

display help for coral-cli

USAGE
  $ coral-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

coral-cli login

grabs a token for interacting with Coral

USAGE
  $ coral-cli login

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against

See code: src/commands/login.ts

coral-cli logout

removes credentials for logging in with Coral

USAGE
  $ coral-cli logout

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against

See code: src/commands/logout.ts

coral-cli plugins

list installed plugins

USAGE
  $ coral-cli plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ coral-cli plugins

See code: @oclif/plugin-plugins

coral-cli plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ coral-cli 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
  $ coral-cli plugins:add

EXAMPLES
  $ coral-cli plugins:install myplugin 
  $ coral-cli plugins:install https://github.com/someuser/someplugin
  $ coral-cli plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

coral-cli plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ coral-cli 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
  $ coral-cli plugins:link myplugin

See code: @oclif/plugin-plugins

coral-cli plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ coral-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

ALIASES
  $ coral-cli plugins:unlink
  $ coral-cli plugins:remove

See code: @oclif/plugin-plugins

coral-cli plugins:update

update installed plugins

USAGE
  $ coral-cli plugins:update

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

See code: @oclif/plugin-plugins

coral-cli story:get

fetches a story

USAGE
  $ coral-cli story:get

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against
  --id=id              find a story by ID
  --url=url            find a story by URL

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

coral-cli story:merge

merge stories and their comments into a single story

USAGE
  $ coral-cli story:merge

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against
  --from=from          (required) source Story ID that will be merged from
  --into=into          (required) destination Story ID that will be merged into

See code: src/commands/story/merge.ts

coral-cli story:update

update stories metadata

USAGE
  $ coral-cli story:update

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against
  --id=id              (required) the ID of the story to update
  --url=url            (required) the new URL to update the story to

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

coral-cli token:create

creates tokens on the current user

USAGE
  $ coral-cli token:create

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against
  --name=name          (required) name of the token

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

coral-cli token:list

lists tokens on the current user

USAGE
  $ coral-cli token:list

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against

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

coral-cli token:revoke

revokes tokens on the current user

USAGE
  $ coral-cli token:revoke

OPTIONS
  -d, --domain=domain  (required) domain for tenant to run command against
  --id=id              (required) id of the token to revoke

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

Current Tags

  • 0.2.0                                ...           latest (8 months ago)

3 Versions

  • 0.2.0                                ...           8 months ago
  • 0.1.1                                ...           8 months ago
  • 0.1.0                                ...           8 months ago
Downloads
Today 0
This Week 3
This Month 3
Last Day 0
Last Week 0
Last Month 3
Dev Dependencies (14)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |