codebx
v0.0.3
Published
CLI for Codebox
Downloads
6
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g codebx
$ codebx COMMAND
running command...
$ codebx (--version)
codebx/0.0.3 darwin-arm64 node-v16.17.1
$ codebx --help [COMMAND]
USAGE
$ codebx COMMAND
...
Commands
codebx help [COMMAND]
codebx plugins
codebx plugins:install PLUGIN...
codebx plugins:inspect PLUGIN...
codebx plugins:install PLUGIN...
codebx plugins:link PLUGIN
codebx plugins:uninstall PLUGIN...
codebx plugins:uninstall PLUGIN...
codebx plugins:uninstall PLUGIN...
codebx plugins update
codebx save [FILE]
codebx help [COMMAND]
Display help for codebx.
USAGE
$ codebx help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for codebx.
See code: @oclif/plugin-help
codebx plugins
List installed plugins.
USAGE
$ codebx plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ codebx plugins
See code: @oclif/plugin-plugins
codebx plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ codebx plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
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
$ codebx plugins add
EXAMPLES
$ codebx plugins:install myplugin
$ codebx plugins:install https://github.com/someuser/someplugin
$ codebx plugins:install someuser/someplugin
codebx plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ codebx plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ codebx plugins:inspect myplugin
codebx plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ codebx plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
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
$ codebx plugins add
EXAMPLES
$ codebx plugins:install myplugin
$ codebx plugins:install https://github.com/someuser/someplugin
$ codebx plugins:install someuser/someplugin
codebx plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ codebx plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
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.
EXAMPLES
$ codebx plugins:link myplugin
codebx plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ codebx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ codebx plugins unlink
$ codebx plugins remove
codebx plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ codebx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ codebx plugins unlink
$ codebx plugins remove
codebx plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ codebx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ codebx plugins unlink
$ codebx plugins remove
codebx plugins update
Update installed plugins.
USAGE
$ codebx plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
codebx save [FILE]
Saves a file to your codebox.
USAGE
$ codebx save [FILE] [-f <value>]
FLAGS
-f, --file=<value> file path to save
DESCRIPTION
Saves a file to your codebox.
EXAMPLES
$ codebx save
See code: dist/commands/save.ts