@eventuras/oxo
v0.0.1
Published
Eventuras CLI tools
Readme
@eventuras/oxo
Eventuras CLI tools
Usage
$ npm install -g @eventuras/oxo
$ oxo COMMAND
running command...
$ oxo (--version)
@eventuras/oxo/0.0.1 darwin-arm64 node-v24.10.0
$ oxo --help [COMMAND]
USAGE
$ oxo COMMAND
...Commands
oxo hello PERSONoxo hello worldoxo help [COMMAND]oxo pluginsoxo plugins add PLUGINoxo plugins:inspect PLUGIN...oxo plugins install PLUGINoxo plugins link PATHoxo plugins remove [PLUGIN]oxo plugins resetoxo plugins uninstall [PLUGIN]oxo plugins unlink [PLUGIN]oxo plugins update
oxo hello PERSON
Say hello
USAGE
$ oxo hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oxo hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)See code: src/commands/hello/index.ts
oxo hello world
Say hello world
USAGE
$ oxo hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oxo hello world
hello world! (./src/commands/hello/world.ts)See code: src/commands/hello/world.ts
oxo help [COMMAND]
Display help for oxo.
USAGE
$ oxo 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 oxo.See code: @oclif/plugin-help
oxo plugins
List installed plugins.
USAGE
$ oxo plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ oxo pluginsSee code: @oclif/plugin-plugins
oxo plugins add PLUGIN
Installs a plugin into oxo.
USAGE
$ oxo 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 oxo.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the OXO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the OXO_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ oxo plugins add
EXAMPLES
Install a plugin from npm registry.
$ oxo plugins add myplugin
Install a plugin from a github url.
$ oxo plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ oxo plugins add someuser/somepluginoxo plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ oxo 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
$ oxo plugins inspect mypluginSee code: @oclif/plugin-plugins
oxo plugins install PLUGIN
Installs a plugin into oxo.
USAGE
$ oxo 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 oxo.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the OXO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the OXO_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ oxo plugins add
EXAMPLES
Install a plugin from npm registry.
$ oxo plugins install myplugin
Install a plugin from a github url.
$ oxo plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ oxo plugins install someuser/somepluginSee code: @oclif/plugin-plugins
oxo plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ oxo 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
$ oxo plugins link mypluginSee code: @oclif/plugin-plugins
oxo plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ oxo 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
$ oxo plugins unlink
$ oxo plugins remove
EXAMPLES
$ oxo plugins remove mypluginoxo plugins reset
Remove all user-installed and linked plugins.
USAGE
$ oxo 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
oxo plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ oxo 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
$ oxo plugins unlink
$ oxo plugins remove
EXAMPLES
$ oxo plugins uninstall mypluginSee code: @oclif/plugin-plugins
oxo plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ oxo 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
$ oxo plugins unlink
$ oxo plugins remove
EXAMPLES
$ oxo plugins unlink mypluginoxo plugins update
Update installed plugins.
USAGE
$ oxo plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
