@voxable/cli
v0.1.7
Published
A client for the Voxable conversation design platform's API.
Downloads
6
Readme
@voxable/cli
A client for the Voxable conversation design platform's API. 🪄
Usage
$ npm install -g @voxable/cli
$ voxable COMMAND
running command...
$ voxable (-v|--version|version)
@voxable/cli/0.1.7 darwin-x64 node-v15.12.0
$ voxable --help [COMMAND]
USAGE
$ voxable COMMAND
...
Commands
voxable help [COMMAND]
voxable plugins
voxable plugins:inspect PLUGIN...
voxable plugins:install PLUGIN...
voxable plugins:link PLUGIN
voxable plugins:uninstall PLUGIN...
voxable plugins:update
voxable projects:export PROJECT_ID
voxable projects:list
voxable help [COMMAND]
display help for voxable
USAGE
$ voxable help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
voxable plugins
list installed plugins
USAGE
$ voxable plugins
OPTIONS
--core show core plugins
EXAMPLE
$ voxable plugins
See code: @oclif/plugin-plugins
voxable plugins:inspect PLUGIN...
displays installation properties of a plugin
USAGE
$ voxable plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] plugin to inspect
OPTIONS
-h, --help show CLI help
-v, --verbose
EXAMPLE
$ voxable plugins:inspect myplugin
See code: @oclif/plugin-plugins
voxable plugins:install PLUGIN...
installs a plugin into the CLI
USAGE
$ voxable 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
$ voxable plugins:add
EXAMPLES
$ voxable plugins:install myplugin
$ voxable plugins:install https://github.com/someuser/someplugin
$ voxable plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
voxable plugins:link PLUGIN
links a plugin into the CLI for development
USAGE
$ voxable 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
$ voxable plugins:link myplugin
See code: @oclif/plugin-plugins
voxable plugins:uninstall PLUGIN...
removes a plugin from the CLI
USAGE
$ voxable plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ voxable plugins:unlink
$ voxable plugins:remove
See code: @oclif/plugin-plugins
voxable plugins:update
update installed plugins
USAGE
$ voxable plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
voxable projects:export PROJECT_ID
export a project
USAGE
$ voxable projects:export PROJECT_ID
ARGUMENTS
PROJECT_ID project ID
OPTIONS
-h, --help show CLI help
EXAMPLE
$ voxable projects:export PROJECT_ID
voxable projects:list
list all projects
USAGE
$ voxable projects:list
OPTIONS
-j, --json Output results in JSON. When not specified, renders in human-readable format.
EXAMPLE
$ voxable projects:list