oclif repository template for cli mockups
# export helper scripts
. init.sh
# set a envs file
touch .env
# install tools if not completed by devcontainer
. .devcontainer/scripts/tools.sh
#optional node install different lts version
#su - root
#. .devcontainer/scripts/node-debian.sh
#exit
#
# export aliases
setup
# test cli template as is
mycli --help
in vscode (ctl + shift + h)
string: mycli
replace:yourcli
oclif example Hello World CLI
$ npm install -g mycli
$ mycli COMMAND
running command...
$ mycli (--version)
mycli/0.0.0 linux-x64 node-v16.18.0
$ mycli --help [COMMAND]
USAGE
$ mycli COMMAND
...mycli hello PERSONmycli hello worldmycli help [COMMAND]mycli pluginsmycli plugins:install PLUGIN...mycli plugins:inspect PLUGIN...mycli plugins:install PLUGIN...mycli plugins:link PLUGINmycli plugins:uninstall PLUGIN...mycli plugins:uninstall PLUGIN...mycli plugins:uninstall PLUGIN...mycli plugins update
Say hello
USAGE
$ mycli 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
Say hello world
USAGE
$ mycli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ mycli hello world
hello world! (./src/commands/hello/world.ts)
Display help for mycli.
USAGE
$ mycli 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 mycli.
See code: @oclif/plugin-help
List installed plugins.
USAGE
$ mycli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ mycli plugins
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ mycli 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
$ mycli plugins add
EXAMPLES
$ mycli plugins:install myplugin
$ mycli plugins:install https://github.com/someuser/someplugin
$ mycli plugins:install someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ mycli 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
$ mycli plugins:inspect myplugin
Installs a plugin into the CLI.
USAGE
$ mycli 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
$ mycli plugins add
EXAMPLES
$ mycli plugins:install myplugin
$ mycli plugins:install https://github.com/someuser/someplugin
$ mycli plugins:install someuser/someplugin
Links a plugin into the CLI for development.
USAGE
$ mycli 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
$ mycli plugins:link myplugin
Removes a plugin from the CLI.
USAGE
$ mycli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mycli plugins unlink
$ mycli plugins remove
Removes a plugin from the CLI.
USAGE
$ mycli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mycli plugins unlink
$ mycli plugins remove
Removes a plugin from the CLI.
USAGE
$ mycli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mycli plugins unlink
$ mycli plugins remove
Update installed plugins.
USAGE
$ mycli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
Outline any requirements to setup a development environment if someone would like to contribute. You may also link to another file for this information.
# test pre commit manually
pre-commit run -a -v