@mci-fe/mocker
v1.1.0
Published
oclif example Hello World CLI (ESM)
Downloads
12
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @mci-fe/mocker
$ mocker COMMAND
running command...
$ mocker (--version)
@mci-fe/mocker/1.1.0 darwin-arm64 node-v18.17.0
$ mocker --help [COMMAND]
USAGE
$ mocker COMMAND
...
Commands
mocker help [COMMAND]
mocker plugins
mocker plugins add PLUGIN
mocker plugins:inspect PLUGIN...
mocker plugins install PLUGIN
mocker plugins link PATH
mocker plugins remove [PLUGIN]
mocker plugins reset
mocker plugins uninstall [PLUGIN]
mocker plugins unlink [PLUGIN]
mocker plugins update
mocker serve
mocker help [COMMAND]
Display help for mocker.
USAGE
$ mocker 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 mocker.
See code: @oclif/plugin-help
mocker plugins
List installed plugins.
USAGE
$ mocker plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ mocker plugins
See code: @oclif/plugin-plugins
mocker plugins add PLUGIN
Installs a plugin into mocker.
USAGE
$ mocker 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 mocker.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the MOCKER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the MOCKER_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ mocker plugins add
EXAMPLES
Install a plugin from npm registry.
$ mocker plugins add myplugin
Install a plugin from a github url.
$ mocker plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ mocker plugins add someuser/someplugin
mocker plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ mocker 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
$ mocker plugins inspect myplugin
See code: @oclif/plugin-plugins
mocker plugins install PLUGIN
Installs a plugin into mocker.
USAGE
$ mocker 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 mocker.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the MOCKER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the MOCKER_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ mocker plugins add
EXAMPLES
Install a plugin from npm registry.
$ mocker plugins install myplugin
Install a plugin from a github url.
$ mocker plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ mocker plugins install someuser/someplugin
See code: @oclif/plugin-plugins
mocker plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ mocker 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
$ mocker plugins link myplugin
See code: @oclif/plugin-plugins
mocker plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ mocker 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
$ mocker plugins unlink
$ mocker plugins remove
EXAMPLES
$ mocker plugins remove myplugin
mocker plugins reset
Remove all user-installed and linked plugins.
USAGE
$ mocker 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
mocker plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ mocker 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
$ mocker plugins unlink
$ mocker plugins remove
EXAMPLES
$ mocker plugins uninstall myplugin
See code: @oclif/plugin-plugins
mocker plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ mocker 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
$ mocker plugins unlink
$ mocker plugins remove
EXAMPLES
$ mocker plugins unlink myplugin
mocker plugins update
Update installed plugins.
USAGE
$ mocker plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
mocker serve
describe the command here
USAGE
$ mocker serve [-p <value>]
FLAGS
-p, --port=<value> port to bootstrap up mock server
DESCRIPTION
describe the command here
EXAMPLES
$ mocker serve -p 3000
See code: src/commands/serve.ts