@brevity-builder/cli
Advanced tools
oclif example Hello World CLI
$ npm install -g @brevity-builder/cli
$ brevity COMMAND
running command...
$ brevity (--version)
@brevity-builder/cli/0.0.2 linux-x64 node-v17.8.0
$ brevity --help [COMMAND]
USAGE
$ brevity COMMAND
...
brevity help [COMMAND]brevity pluginsbrevity plugins:install PLUGIN...brevity plugins:inspect PLUGIN...brevity plugins:install PLUGIN...brevity plugins:link PLUGINbrevity plugins:uninstall PLUGIN...brevity plugins:uninstall PLUGIN...brevity plugins:uninstall PLUGIN...brevity plugins updatebrevity help [COMMAND]Display help for brevity.
USAGE
$ brevity 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 brevity.
See code: @oclif/plugin-help
brevity pluginsList installed plugins.
USAGE
$ brevity plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ brevity plugins
See code: @oclif/plugin-plugins
brevity plugins:install PLUGIN...Installs a plugin into the CLI.
USAGE
$ brevity 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
$ brevity plugins add
EXAMPLES
$ brevity plugins:install myplugin
$ brevity plugins:install https://github.com/someuser/someplugin
$ brevity plugins:install someuser/someplugin
brevity plugins:inspect PLUGIN...Displays installation properties of a plugin.
USAGE
$ brevity 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
$ brevity plugins:inspect myplugin
brevity plugins:install PLUGIN...Installs a plugin into the CLI.
USAGE
$ brevity 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
$ brevity plugins add
EXAMPLES
$ brevity plugins:install myplugin
$ brevity plugins:install https://github.com/someuser/someplugin
$ brevity plugins:install someuser/someplugin
brevity plugins:link PLUGINLinks a plugin into the CLI for development.
USAGE
$ brevity 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
$ brevity plugins:link myplugin
brevity plugins:uninstall PLUGIN...Removes a plugin from the CLI.
USAGE
$ brevity plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ brevity plugins unlink
$ brevity plugins remove
brevity plugins:uninstall PLUGIN...Removes a plugin from the CLI.
USAGE
$ brevity plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ brevity plugins unlink
$ brevity plugins remove
brevity plugins:uninstall PLUGIN...Removes a plugin from the CLI.
USAGE
$ brevity plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ brevity plugins unlink
$ brevity plugins remove
brevity plugins updateUpdate installed plugins.
USAGE
$ brevity plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
FAQs
CLI to work with Brevity Plugins
The npm package @brevity-builder/cli receives a total of 19 weekly downloads. As such, @brevity-builder/cli popularity was classified as not popular.
We found that @brevity-builder/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.
Security News
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
Security News
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.