1337cli 中文文档教程
oclif-hello-world
oclif 示例 Hello World CLI
Usage
$ npm install -g 1337cli
$ 1337cli COMMAND
running command...
$ 1337cli (--version)
1337cli/0.0.1 darwin-arm64 node-v16.13.0
$ 1337cli --help [COMMAND]
USAGE
$ 1337cli COMMAND
...
Commands
1337cli hello PERSON
1337cli hello world
1337cli help [COMMAND]
1337cli plugins
1337cli plugins:inspect PLUGIN...
1337cli plugins:install PLUGIN...
1337cli plugins:link PLUGIN
1337cli plugins:uninstall PLUGIN...
1337cli plugins update
1337cli hello PERSON
问好
USAGE
$ 1337cli hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Whom is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
查看代码:dist/commands/hello/index.ts
1337cli hello world
向世界问好
USAGE
$ 1337cli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)
1337cli help [COMMAND]
显示 1337cli 的帮助。
USAGE
$ 1337cli 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 1337cli.
查看代码:@oclif/plugin-help
1337cli plugins
列出已安装的插件。
USAGE
$ 1337cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ 1337cli plugins
1337cli plugins:inspect PLUGIN...
显示插件的安装属性。
USAGE
$ 1337cli 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
$ 1337cli plugins:inspect myplugin
1337cli plugins:install PLUGIN...
将插件安装到 CLI 中。
USAGE
$ 1337cli 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
$ 1337cli plugins add
EXAMPLES
$ 1337cli plugins:install myplugin
$ 1337cli plugins:install https://github.com/someuser/someplugin
$ 1337cli plugins:install someuser/someplugin
1337cli plugins:link PLUGIN
将插件链接到 CLI 以进行开发。
USAGE
$ 1337cli 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
$ 1337cli plugins:link myplugin
1337cli plugins:uninstall PLUGIN...
从 CLI 中删除插件。
USAGE
$ 1337cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ 1337cli plugins unlink
$ 1337cli plugins remove
1337cli plugins update
更新已安装的插件。
USAGE
$ 1337cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g 1337cli
$ 1337cli COMMAND
running command...
$ 1337cli (--version)
1337cli/0.0.1 darwin-arm64 node-v16.13.0
$ 1337cli --help [COMMAND]
USAGE
$ 1337cli COMMAND
...
Commands
1337cli hello PERSON
1337cli hello world
1337cli help [COMMAND]
1337cli plugins
1337cli plugins:inspect PLUGIN...
1337cli plugins:install PLUGIN...
1337cli plugins:link PLUGIN
1337cli plugins:uninstall PLUGIN...
1337cli plugins update
1337cli hello PERSON
Say hello
USAGE
$ 1337cli hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Whom 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
1337cli hello world
Say hello world
USAGE
$ 1337cli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)
1337cli help [COMMAND]
Display help for 1337cli.
USAGE
$ 1337cli 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 1337cli.
See code: @oclif/plugin-help
1337cli plugins
List installed plugins.
USAGE
$ 1337cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ 1337cli plugins
See code: @oclif/plugin-plugins
1337cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ 1337cli 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
$ 1337cli plugins:inspect myplugin
1337cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ 1337cli 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
$ 1337cli plugins add
EXAMPLES
$ 1337cli plugins:install myplugin
$ 1337cli plugins:install https://github.com/someuser/someplugin
$ 1337cli plugins:install someuser/someplugin
1337cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ 1337cli 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
$ 1337cli plugins:link myplugin
1337cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ 1337cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ 1337cli plugins unlink
$ 1337cli plugins remove
1337cli plugins update
Update installed plugins.
USAGE
$ 1337cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.