@brevity-builder/cli
v1.2.185
Published
CLI to work with Brevity Plugins
Downloads
100
Readme
Brevity CLI
Brevity CLI
Usage
$ npm install -g @brevity-builder/cli
$ brevity COMMAND
running command...
$ brevity (--version)
@brevity-builder/cli/1.2.185 darwin-arm64 node-v22.9.0
$ brevity --help [COMMAND]
USAGE
$ brevity COMMAND
...
Commands
brevity auth login
brevity auth logout
brevity help [COMMAND]
brevity plugin publish SEMVER
brevity plugins
brevity plugins add PLUGIN
brevity plugins:inspect PLUGIN...
brevity plugins install PLUGIN
brevity plugins link PATH
brevity plugins remove [PLUGIN]
brevity plugins reset
brevity plugins uninstall [PLUGIN]
brevity plugins unlink [PLUGIN]
brevity plugins update
brevity auth login
Login to Brevity
USAGE
$ brevity auth login
DESCRIPTION
Login to Brevity
EXAMPLES
$ brevity login
See code: src/commands/auth/login.ts
brevity auth logout
Logout out from Brevity
USAGE
$ brevity auth logout
DESCRIPTION
Logout out from Brevity
EXAMPLES
$ brevity logout
See code: src/commands/auth/logout.ts
brevity 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 plugin publish SEMVER
describe the command here
USAGE
$ brevity plugin publish SEMVER -c <value> [-b]
ARGUMENTS
SEMVER (major|minor|patch) semver version to publish
FLAGS
-b, --buildOnly only build the plugin
-c, --config=<value> (required) config file to use
DESCRIPTION
describe the command here
EXAMPLES
$ brevity plugin publish
See code: src/commands/plugin/publish.ts
brevity plugins
List installed plugins.
USAGE
$ brevity plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ brevity plugins
See code: @oclif/plugin-plugins
brevity plugins add PLUGIN
Installs a plugin into brevity.
USAGE
$ brevity plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into brevity.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the BREVITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the BREVITY_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ brevity plugins add
EXAMPLES
Install a plugin from npm registry.
$ brevity plugins add myplugin
Install a plugin from a github url.
$ brevity plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ brevity plugins add 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ brevity plugins inspect myplugin
See code: @oclif/plugin-plugins
brevity plugins install PLUGIN
Installs a plugin into brevity.
USAGE
$ brevity plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into brevity.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the BREVITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the BREVITY_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ brevity plugins add
EXAMPLES
Install a plugin from npm registry.
$ brevity plugins install myplugin
Install a plugin from a github url.
$ brevity plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ brevity plugins install someuser/someplugin
See code: @oclif/plugin-plugins
brevity plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ brevity plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
See code: @oclif/plugin-plugins
brevity plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ brevity plugins remove [PLUGIN...] [-h] [-v]
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
EXAMPLES
$ brevity plugins remove myplugin
brevity plugins reset
Remove all user-installed and linked plugins.
USAGE
$ brevity plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
brevity plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ brevity plugins uninstall [PLUGIN...] [-h] [-v]
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
EXAMPLES
$ brevity plugins uninstall myplugin
See code: @oclif/plugin-plugins
brevity plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ brevity plugins unlink [PLUGIN...] [-h] [-v]
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
EXAMPLES
$ brevity plugins unlink myplugin
brevity plugins update
Update installed plugins.
USAGE
$ brevity plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins