@emu/cli
v0.0.1
Published
emu cli
Downloads
5
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @emu/cli
$ emu COMMAND
running command...
$ emu (--version)
@emu/cli/0.0.1 darwin-x64 node-v14.18.2
$ emu --help [COMMAND]
USAGE
$ emu COMMAND
...
Commands
emu dev PATH
emu help [COMMAND]
emu plugins
emu plugins:inspect PLUGIN...
emu plugins:install PLUGIN...
emu plugins:link PLUGIN
emu plugins:uninstall PLUGIN...
emu plugins update
emu dev PATH
Start emu development server
USAGE
$ emu dev [PATH]
ARGUMENTS
PATH the mdx file path
DESCRIPTION
Start emu development server
EXAMPLES
$ emu dev slide.mdx
See code: dist/commands/dev/index.ts
emu help [COMMAND]
Display help for emu.
USAGE
$ emu 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 emu.
See code: @oclif/plugin-help
emu plugins
List installed plugins.
USAGE
$ emu plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ emu plugins
See code: @oclif/plugin-plugins
emu plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ emu 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
$ emu plugins:inspect myplugin
emu plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ emu 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
$ emu plugins add
EXAMPLES
$ emu plugins:install myplugin
$ emu plugins:install https://github.com/someuser/someplugin
$ emu plugins:install someuser/someplugin
emu plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ emu 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
$ emu plugins:link myplugin
emu plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ emu plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ emu plugins unlink
$ emu plugins remove
emu plugins update
Update installed plugins.
USAGE
$ emu plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.