fa-gen-ts v0.6.7

FontAwesome Icon Component Generator

Generates icon components using FontAwesome for React.

• Usage
• Commands

Usage

$ npm install -g fa-gen-ts
$ fa-gen COMMAND
running command...
$ fa-gen (--version)
fa-gen-ts/0.6.7 darwin-arm64 node-v16.15.1
$ fa-gen --help [COMMAND]
USAGE
  $ fa-gen COMMAND
...

Commands

• fa-gen generate
• fa-gen help [COMMANDS]
• fa-gen plugins
• fa-gen plugins:install PLUGIN...
• fa-gen plugins:inspect PLUGIN...
• fa-gen plugins:install PLUGIN...
• fa-gen plugins:link PLUGIN
• fa-gen plugins:uninstall PLUGIN...
• fa-gen plugins:uninstall PLUGIN...
• fa-gen plugins:uninstall PLUGIN...
• fa-gen plugins update

fa-gen generate

Generates an icon wrapper component for FontAwesome Icons

USAGE
  $ fa-gen generate [-c <value>] [-e] [-t <value>]

FLAGS
  -c, --config=<value>    Path to the config file
  -e, --export            Output an index.ts file in the output directory with all generated files exported
  -t, --template=<value>  Path to the templates that are used when creating the icon components

DESCRIPTION
  Generates an icon wrapper component for FontAwesome Icons

See code: dist/commands/generate.ts

fa-gen help [COMMANDS]

Display help for fa-gen.

USAGE
  $ fa-gen 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 fa-gen.

See code: @oclif/plugin-help

fa-gen plugins

List installed plugins.

USAGE
  $ fa-gen plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ fa-gen plugins

See code: @oclif/plugin-plugins

fa-gen plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ fa-gen plugins:install myplugin 

  $ fa-gen plugins:install https://github.com/someuser/someplugin

  $ fa-gen plugins:install someuser/someplugin

fa-gen plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ fa-gen 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
  $ fa-gen plugins:inspect myplugin

fa-gen plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ fa-gen plugins:install myplugin 

  $ fa-gen plugins:install https://github.com/someuser/someplugin

  $ fa-gen plugins:install someuser/someplugin

fa-gen plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ fa-gen 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
  $ fa-gen plugins:link myplugin

fa-gen plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fa-gen plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fa-gen plugins unlink
  $ fa-gen plugins remove

fa-gen plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fa-gen plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fa-gen plugins unlink
  $ fa-gen plugins remove

fa-gen plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fa-gen plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fa-gen plugins unlink
  $ fa-gen plugins remove

fa-gen plugins update

Update installed plugins.

USAGE
  $ fa-gen plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.