tfw v0.0.0

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g tfw
$ tfw COMMAND
running command...
$ tfw (--version)
tfw/0.0.0 darwin-x64 node-v20.11.0
$ tfw --help [COMMAND]
USAGE
  $ tfw COMMAND
...

Commands

• tfw hello PERSON
• tfw hello world
• tfw help [COMMAND]
• tfw plugins
• tfw plugins:install PLUGIN...
• tfw plugins:inspect PLUGIN...
• tfw plugins:install PLUGIN...
• tfw plugins:link PLUGIN
• tfw plugins:uninstall PLUGIN...
• tfw plugins reset
• tfw plugins:uninstall PLUGIN...
• tfw plugins:uninstall PLUGIN...
• tfw plugins update

tfw hello PERSON

Say hello

USAGE
  $ tfw 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

tfw hello world

Say hello world

USAGE
  $ tfw hello world

DESCRIPTION
  Say hello world

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

See code: src/commands/hello/world.ts

tfw help [COMMAND]

Display help for tfw.

USAGE
  $ tfw 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 tfw.

See code: @oclif/plugin-help

tfw plugins

List installed plugins.

USAGE
  $ tfw plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ tfw plugins

See code: @oclif/plugin-plugins

tfw plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ tfw plugins add myplugin 

  $ tfw plugins add https://github.com/someuser/someplugin

  $ tfw plugins add someuser/someplugin

tfw plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ tfw 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
  $ tfw plugins inspect myplugin

See code: @oclif/plugin-plugins

tfw plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ tfw plugins install myplugin 

  $ tfw plugins install https://github.com/someuser/someplugin

  $ tfw plugins install someuser/someplugin

See code: @oclif/plugin-plugins

tfw plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ tfw 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
  $ tfw plugins link myplugin

See code: @oclif/plugin-plugins

tfw plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ tfw 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
  $ tfw plugins unlink
  $ tfw plugins remove

EXAMPLES
  $ tfw plugins remove myplugin

tfw plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ tfw 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

tfw plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ tfw plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ tfw plugins unlink
  $ tfw plugins remove

EXAMPLES
  $ tfw plugins uninstall myplugin

See code: @oclif/plugin-plugins

tfw plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ tfw 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
  $ tfw plugins unlink
  $ tfw plugins remove

EXAMPLES
  $ tfw plugins unlink myplugin

tfw plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins