fxserver-cli v0.0.1
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g fxserver-cli
$ fxserver-cli COMMAND
running command...
$ fxserver-cli (--version)
fxserver-cli/0.0.1 linux-x64 node-v20.11.0
$ fxserver-cli --help [COMMAND]
USAGE
$ fxserver-cli COMMAND
...
Commands
fxserver-cli hello PERSON
fxserver-cli hello world
fxserver-cli help [COMMANDS]
fxserver-cli init [DIRECTORY]
fxserver-cli plugins
fxserver-cli plugins:install PLUGIN...
fxserver-cli plugins:inspect PLUGIN...
fxserver-cli plugins:install PLUGIN...
fxserver-cli plugins:link PLUGIN
fxserver-cli plugins:uninstall PLUGIN...
fxserver-cli plugins reset
fxserver-cli plugins:uninstall PLUGIN...
fxserver-cli plugins:uninstall PLUGIN...
fxserver-cli plugins update
fxserver-cli hello PERSON
Say hello
USAGE
$ fxserver-cli 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
fxserver-cli hello world
Say hello world
USAGE
$ fxserver-cli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ fxserver-cli hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
fxserver-cli help [COMMANDS]
Display help for fxserver-cli.
USAGE
$ fxserver-cli 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 fxserver-cli.
See code: @oclif/plugin-help
fxserver-cli init [DIRECTORY]
Say hello
USAGE
$ fxserver-cli init [DIRECTORY] [-f <value>]
ARGUMENTS
DIRECTORY [default: .] Directory to initalise in
FLAGS
-f, --framework=<value> [default: none] The framework to initalise
DESCRIPTION
Say hello
See code: src/commands/init/index.ts
fxserver-cli plugins
List installed plugins.
USAGE
$ fxserver-cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ fxserver-cli plugins
See code: @oclif/plugin-plugins
fxserver-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ fxserver-cli plugins add plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ fxserver-cli plugins add
EXAMPLES
$ fxserver-cli plugins add myplugin
$ fxserver-cli plugins add https://github.com/someuser/someplugin
$ fxserver-cli plugins add someuser/someplugin
fxserver-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ fxserver-cli 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
$ fxserver-cli plugins inspect myplugin
See code: @oclif/plugin-plugins
fxserver-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ fxserver-cli plugins install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ fxserver-cli plugins add
EXAMPLES
$ fxserver-cli plugins install myplugin
$ fxserver-cli plugins install https://github.com/someuser/someplugin
$ fxserver-cli plugins install someuser/someplugin
See code: @oclif/plugin-plugins
fxserver-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ fxserver-cli plugins link PLUGIN
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
$ fxserver-cli plugins link myplugin
See code: @oclif/plugin-plugins
fxserver-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ fxserver-cli plugins remove plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fxserver-cli plugins unlink
$ fxserver-cli plugins remove
EXAMPLES
$ fxserver-cli plugins remove myplugin
fxserver-cli plugins reset
Remove all user-installed and linked plugins.
USAGE
$ fxserver-cli plugins reset
See code: @oclif/plugin-plugins
fxserver-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ fxserver-cli plugins uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fxserver-cli plugins unlink
$ fxserver-cli plugins remove
EXAMPLES
$ fxserver-cli plugins uninstall myplugin
See code: @oclif/plugin-plugins
fxserver-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ fxserver-cli plugins unlink plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ fxserver-cli plugins unlink
$ fxserver-cli plugins remove
EXAMPLES
$ fxserver-cli plugins unlink myplugin
fxserver-cli plugins update
Update installed plugins.
USAGE
$ fxserver-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins