0.0.5 • Published 1 year ago

cfx-tool v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

oclif-hello-world

oclif example Hello World CLI

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g cfx-tool
$ cfx-tool COMMAND
running command...
$ cfx-tool (--version)
cfx-tool/0.0.5 win32-x64 node-v16.18.0
$ cfx-tool --help [COMMAND]
USAGE
  $ cfx-tool 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
...

Commands

cfx-tool help [COMMANDS]

Display help for cfx-tool.

USAGE
  $ cfx-tool 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 cfx-tool.

See code: @oclif/plugin-help

cfx-tool plugins

List installed plugins.

USAGE
  $ cfx-tool plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ cfx-tool plugins

See code: @oclif/plugin-plugins

cfx-tool plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ cfx-tool 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
  $ cfx-tool plugins add

EXAMPLES
  $ cfx-tool plugins:install myplugin 

  $ cfx-tool plugins:install https://github.com/someuser/someplugin

  $ cfx-tool plugins:install someuser/someplugin

cfx-tool plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ cfx-tool 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
  $ cfx-tool plugins:inspect myplugin

cfx-tool plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ cfx-tool 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
  $ cfx-tool plugins add

EXAMPLES
  $ cfx-tool plugins:install myplugin 

  $ cfx-tool plugins:install https://github.com/someuser/someplugin

  $ cfx-tool plugins:install someuser/someplugin

cfx-tool plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ cfx-tool 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
  $ cfx-tool plugins:link myplugin

cfx-tool plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cfx-tool plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ cfx-tool plugins unlink
  $ cfx-tool plugins remove

cfx-tool plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cfx-tool plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ cfx-tool plugins unlink
  $ cfx-tool plugins remove

cfx-tool plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cfx-tool plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ cfx-tool plugins unlink
  $ cfx-tool plugins remove

cfx-tool plugins update

Update installed plugins.

USAGE
  $ cfx-tool plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

cfx-tool res [DIRECTORY] [NAME] [LANG]

Create a new FiveM Resource

USAGE
  $ cfx-tool res [DIRECTORY] [NAME] [LANG]

ARGUMENTS
  DIRECTORY  Resource directory
  NAME       Resource name
  LANG       (lua|js) Resource language

DESCRIPTION
  Create a new FiveM Resource

ALIASES
  $ cfx-tool rsc
  $ cfx-tool res

cfx-tool resource [DIRECTORY] [NAME] [LANG]

Create a new FiveM Resource

USAGE
  $ cfx-tool resource [DIRECTORY] [NAME] [LANG]

ARGUMENTS
  DIRECTORY  Resource directory
  NAME       Resource name
  LANG       (lua|js) Resource language

DESCRIPTION
  Create a new FiveM Resource

ALIASES
  $ cfx-tool rsc
  $ cfx-tool res

See code: dist/commands/resource.ts

cfx-tool rsc [DIRECTORY] [NAME] [LANG]

Create a new FiveM Resource

USAGE
  $ cfx-tool rsc [DIRECTORY] [NAME] [LANG]

ARGUMENTS
  DIRECTORY  Resource directory
  NAME       Resource name
  LANG       (lua|js) Resource language

DESCRIPTION
  Create a new FiveM Resource

ALIASES
  $ cfx-tool rsc
  $ cfx-tool res

oex hello PERSON

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

oex hello world

Say hello world

USAGE
  $ oex hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ oex hello world
  hello world! (./src/commands/hello/world.ts)

oex help [COMMAND]

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

oex plugins

List installed plugins.

USAGE
  $ oex plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ oex plugins

See code: @oclif/plugin-plugins

oex plugins:inspect PLUGIN...

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

oex plugins:install PLUGIN...

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

oex plugins:link PLUGIN

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

oex plugins:uninstall PLUGIN...

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

oex plugins update

Update installed plugins.

USAGE
  $ oex plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.
oclif
@oclif/core@oclif/plugin-help@oclif/plugin-pluginsaxiosinquirerlistr
@everything-registry/sub-chunk-1309
0.0.5

1 year ago

0.0.4

1 year ago

0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago

0.0.0

1 year ago