canghaimynewcli
v0.0.0
Published
oclif example Hello World CLI
Downloads
2
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g mynewcli
$ mynewcli COMMAND
running command...
$ mynewcli (--version)
mynewcli/0.0.0 win32-x64 node-v18.15.0
$ mynewcli --help [COMMAND]
USAGE
$ mynewcli COMMAND
...
$ npm install -g oclif-hello-world
$ oex COMMAND
running command...
$ oex (--version)
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1
$ oex --help [COMMAND]
USAGE
$ oex COMMAND
...
Commands
mynewcli hello PERSON
mynewcli hello world
mynewcli help [COMMANDS]
mynewcli ls [FILE]
mynewcli plugins
mynewcli plugins:install PLUGIN...
mynewcli plugins:inspect PLUGIN...
mynewcli plugins:install PLUGIN...
mynewcli plugins:link PLUGIN
mynewcli plugins:uninstall PLUGIN...
mynewcli plugins:uninstall PLUGIN...
mynewcli plugins:uninstall PLUGIN...
mynewcli plugins update
mynewcli hello PERSON
Say hello
USAGE
$ mynewcli hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: dist/commands/hello/index.ts
mynewcli hello world
Say hello world
USAGE
$ mynewcli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ mynewcli hello world
hello world! (./src/commands/hello/world.ts)
mynewcli help [COMMANDS]
Display help for mynewcli.
USAGE
$ mynewcli help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for mynewcli.
See code: @oclif/plugin-help
mynewcli ls [FILE]
测试ls命令
USAGE
$ mynewcli ls [FILE] [-p <value>] [-f]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-p, --file=<value> path
DESCRIPTION
测试ls命令
EXAMPLES
$ mynewcli ls
See code: dist/commands/ls.ts
mynewcli plugins
List installed plugins.
USAGE
$ mynewcli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ mynewcli plugins
See code: @oclif/plugin-plugins
mynewcli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ mynewcli 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
$ mynewcli plugins add
EXAMPLES
$ mynewcli plugins:install myplugin
$ mynewcli plugins:install https://github.com/someuser/someplugin
$ mynewcli plugins:install someuser/someplugin
mynewcli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ mynewcli 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
$ mynewcli plugins:inspect myplugin
mynewcli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ mynewcli 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
$ mynewcli plugins add
EXAMPLES
$ mynewcli plugins:install myplugin
$ mynewcli plugins:install https://github.com/someuser/someplugin
$ mynewcli plugins:install someuser/someplugin
mynewcli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ mynewcli 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
$ mynewcli plugins:link myplugin
mynewcli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ mynewcli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mynewcli plugins unlink
$ mynewcli plugins remove
mynewcli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ mynewcli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mynewcli plugins unlink
$ mynewcli plugins remove
mynewcli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ mynewcli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mynewcli plugins unlink
$ mynewcli plugins remove
mynewcli plugins update
Update installed plugins.
USAGE
$ mynewcli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
oex hello PERSON
oex hello world
oex help [COMMAND]
oex plugins
oex plugins:inspect PLUGIN...
oex plugins:install PLUGIN...
oex plugins:link PLUGIN
oex plugins:uninstall PLUGIN...
oex plugins update
oex hello PERSON
Say hello
USAGE
$ oex hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: dist/commands/hello/index.ts
oex hello world
Say hello world
USAGE
$ oex hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)
oex help [COMMAND]
Display help for oex.
USAGE
$ oex 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 oex.
See code: @oclif/plugin-help
oex plugins
List installed plugins.
USAGE
$ oex plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ oex plugins
See code: @oclif/plugin-plugins
oex plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ oex 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
$ oex plugins:inspect myplugin
oex plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ oex 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
$ oex plugins add
EXAMPLES
$ oex plugins:install myplugin
$ oex plugins:install https://github.com/someuser/someplugin
$ oex plugins:install someuser/someplugin
oex plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ oex 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
$ oex plugins:link myplugin
oex plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ oex plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ oex plugins unlink
$ oex plugins remove
oex plugins update
Update installed plugins.
USAGE
$ oex plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.