oclif example Hello World CLI
$ npm install -g do
$ do COMMAND
running command...
$ do (--version)
do/0.0.0 win32-x64 node-v18.18.2
$ do --help [COMMAND]
USAGE
$ do 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
...
do autocomplete [SHELL]
do commands
do hello PERSON
do hello world
do help [COMMAND]
do json sort FILES_OR_FOLDER
do plugins
do plugins add PLUGIN
do plugins:inspect PLUGIN...
do plugins install PLUGIN
do plugins link PATH
do plugins remove [PLUGIN]
do plugins reset
do plugins uninstall [PLUGIN]
do plugins unlink [PLUGIN]
do plugins update
do version
Display autocomplete installation instructions.
USAGE
$ do autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ do autocomplete
$ do autocomplete bash
$ do autocomplete zsh
$ do autocomplete powershell
$ do autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
list all the commands
USAGE
$ do commands [--json] [--deprecated] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter <value>]
[--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--deprecated show deprecated commands
--filter=<value> filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--tree show tree of commands
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
list all the commands
See code: @oclif/plugin-commands
Say hello
USAGE
$ do 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: src/commands/hello/index.ts
Say hello world
USAGE
$ do hello world
DESCRIPTION
Say hello world
EXAMPLES
$ do hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
Display help for do.
USAGE
$ do 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 do.
See code: @oclif/plugin-help
Sort the contents of .json files
USAGE
$ do json sort FILES_OR_FOLDER [-o <value>] [-p <value>] [-v <value>]
ARGUMENTS
FILES_OR_FOLDER Files or folder
FLAGS
-o, --output=<value> Output to file
-p, --prepend=<value> Prepend to generated filenames
-v, --verbose=<value> Verbose mode
DESCRIPTION
Sort the contents of .json files
EXAMPLES
Single file use
$ do json sort file.json
Single file use with selected output name
$ do json sort file.json --output sorted.json
Single file use with prepend
$ do json sort file.json --output sorted.json --prepend "sorted-"
Multifile files use
$ do json sort *.json
$ do json sort *.json --output ./sorted
$ do json sort ./ --output ./sorted
$ do json sort ./ --output ./sorted --prepend "sorted-"
See code: src/commands/json/sort.ts
List installed plugins.
USAGE
$ do plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ do plugins
See code: @oclif/plugin-plugins
Installs a plugin into do.
USAGE
$ do 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 do.
Uses bundled npm executable to install plugins into C:\Users\alpap\AppData\Local\do
Installation of a user-installed plugin will override a core plugin.
Use the DO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the DO_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ do plugins add
EXAMPLES
Install a plugin from npm registry.
$ do plugins add myplugin
Install a plugin from a github url.
$ do plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ do plugins add someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ do 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
$ do plugins inspect myplugin
See code: @oclif/plugin-plugins
Installs a plugin into do.
USAGE
$ do 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 do.
Uses bundled npm executable to install plugins into C:\Users\alpap\AppData\Local\do
Installation of a user-installed plugin will override a core plugin.
Use the DO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the DO_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ do plugins add
EXAMPLES
Install a plugin from npm registry.
$ do plugins install myplugin
Install a plugin from a github url.
$ do plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ do plugins install someuser/someplugin
See code: @oclif/plugin-plugins
Links a plugin into the CLI for development.
USAGE
$ do 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
$ do plugins link myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ do 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
$ do plugins unlink
$ do plugins remove
EXAMPLES
$ do plugins remove myplugin
Remove all user-installed and linked plugins.
USAGE
$ do 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
Removes a plugin from the CLI.
USAGE
$ do 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
$ do plugins unlink
$ do plugins remove
EXAMPLES
$ do plugins uninstall myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ do 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
$ do plugins unlink
$ do plugins remove
EXAMPLES
$ do plugins unlink myplugin
Update installed plugins.
USAGE
$ do plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
USAGE
$ do version [--json] [--verbose]
FLAGS
--verbose Show additional information about the CLI.
GLOBAL FLAGS
--json Format output as json.
FLAG DESCRIPTIONS
--verbose Show additional information about the CLI.
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
See code: @oclif/plugin-version
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
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
Say hello world
USAGE
$ oex hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)
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
List installed plugins.
USAGE
$ oex plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ oex plugins
See code: @oclif/plugin-plugins
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
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
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
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
Update installed plugins.
USAGE
$ oex plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.