@trungnguyentrong/my-plugin
v0.0.3
Published
A new CLI generated with oclif
Downloads
267
Readme
my-plugin
A new CLI generated with oclif
Usage
$ npm install -g @trungnguyentrong/my-plugin
$ my-plugin COMMAND
running command...
$ my-plugin (--version)
@trungnguyentrong/my-plugin/0.0.3 darwin-arm64 node-v20.15.1
$ my-plugin --help [COMMAND]
USAGE
$ my-plugin COMMAND
...
Commands
my-plugin help [COMMAND]
my-plugin morning PERSON
my-plugin morning world
my-plugin plugins
my-plugin plugins add PLUGIN
my-plugin plugins:inspect PLUGIN...
my-plugin plugins install PLUGIN
my-plugin plugins link PATH
my-plugin plugins remove [PLUGIN]
my-plugin plugins reset
my-plugin plugins uninstall [PLUGIN]
my-plugin plugins unlink [PLUGIN]
my-plugin plugins update
my-plugin help [COMMAND]
Display help for my-plugin.
USAGE
$ my-plugin 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 my-plugin.
See code: @oclif/plugin-help
my-plugin morning PERSON
Say hello
USAGE
$ my-plugin morning PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ my-plugin morning friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: src/commands/morning/index.ts
my-plugin morning world
Say hello world
USAGE
$ my-plugin morning world
DESCRIPTION
Say hello world
EXAMPLES
$ my-plugin morning world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/morning/world.ts
my-plugin plugins
List installed plugins.
USAGE
$ my-plugin plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ my-plugin plugins
See code: @oclif/plugin-plugins
my-plugin plugins add PLUGIN
Installs a plugin into my-plugin.
USAGE
$ my-plugin 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 my-plugin.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the MY_PLUGIN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the MY_PLUGIN_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ my-plugin plugins add
EXAMPLES
Install a plugin from npm registry.
$ my-plugin plugins add myplugin
Install a plugin from a github url.
$ my-plugin plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ my-plugin plugins add someuser/someplugin
my-plugin plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ my-plugin 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
$ my-plugin plugins inspect myplugin
See code: @oclif/plugin-plugins
my-plugin plugins install PLUGIN
Installs a plugin into my-plugin.
USAGE
$ my-plugin 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 my-plugin.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the MY_PLUGIN_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the MY_PLUGIN_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ my-plugin plugins add
EXAMPLES
Install a plugin from npm registry.
$ my-plugin plugins install myplugin
Install a plugin from a github url.
$ my-plugin plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ my-plugin plugins install someuser/someplugin
See code: @oclif/plugin-plugins
my-plugin plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ my-plugin 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
$ my-plugin plugins link myplugin
See code: @oclif/plugin-plugins
my-plugin plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ my-plugin 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
$ my-plugin plugins unlink
$ my-plugin plugins remove
EXAMPLES
$ my-plugin plugins remove myplugin
my-plugin plugins reset
Remove all user-installed and linked plugins.
USAGE
$ my-plugin 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
my-plugin plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ my-plugin 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
$ my-plugin plugins unlink
$ my-plugin plugins remove
EXAMPLES
$ my-plugin plugins uninstall myplugin
See code: @oclif/plugin-plugins
my-plugin plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ my-plugin 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
$ my-plugin plugins unlink
$ my-plugin plugins remove
EXAMPLES
$ my-plugin plugins unlink myplugin
my-plugin plugins update
Update installed plugins.
USAGE
$ my-plugin plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins