oclif example Hello World CLI
$ npm install -g careserver
$ careserver COMMAND
running command...
$ careserver (--version)
careserver/0.4.28 linux-x64 node-v20.8.1
$ careserver --help [COMMAND]
USAGE
$ careserver COMMAND
...
careserver hello PERSON
careserver hello world
careserver help [COMMAND]
careserver plugins
careserver plugins add PLUGIN
careserver plugins:inspect PLUGIN...
careserver plugins install PLUGIN
careserver plugins link PATH
careserver plugins remove [PLUGIN]
careserver plugins reset
careserver plugins uninstall [PLUGIN]
careserver plugins unlink [PLUGIN]
careserver plugins update
Say hello
USAGE
$ careserver 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
$ careserver hello world
DESCRIPTION
Say hello world
EXAMPLES
$ careserver hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
Display help for careserver.
USAGE
$ careserver 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 careserver.
See code: @oclif/plugin-help
List installed plugins.
USAGE
$ careserver plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ careserver plugins
See code: @oclif/plugin-plugins
Installs a plugin into careserver.
USAGE
$ careserver 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 careserver.
Uses bundled npm executable to install plugins into /home/user/.local/share/careserver
Installation of a user-installed plugin will override a core plugin.
Use the CARESERVER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CARESERVER_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ careserver plugins add
EXAMPLES
Install a plugin from npm registry.
$ careserver plugins add myplugin
Install a plugin from a github url.
$ careserver plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ careserver plugins add someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ careserver 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
$ careserver plugins inspect myplugin
See code: @oclif/plugin-plugins
Installs a plugin into careserver.
USAGE
$ careserver 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 careserver.
Uses bundled npm executable to install plugins into /home/user/.local/share/careserver
Installation of a user-installed plugin will override a core plugin.
Use the CARESERVER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CARESERVER_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ careserver plugins add
EXAMPLES
Install a plugin from npm registry.
$ careserver plugins install myplugin
Install a plugin from a github url.
$ careserver plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ careserver plugins install someuser/someplugin
See code: @oclif/plugin-plugins
Links a plugin into the CLI for development.
USAGE
$ careserver 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
$ careserver plugins link myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ careserver 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
$ careserver plugins unlink
$ careserver plugins remove
EXAMPLES
$ careserver plugins remove myplugin
Remove all user-installed and linked plugins.
USAGE
$ careserver 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
$ careserver 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
$ careserver plugins unlink
$ careserver plugins remove
EXAMPLES
$ careserver plugins uninstall myplugin
See code: @oclif/plugin-plugins
Removes a plugin from the CLI.
USAGE
$ careserver 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
$ careserver plugins unlink
$ careserver plugins remove
EXAMPLES
$ careserver plugins unlink myplugin
Update installed plugins.
USAGE
$ careserver plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins