Skip to content

Latest commit

 

History

History
399 lines (272 loc) · 10 KB

README.md

File metadata and controls

399 lines (272 loc) · 10 KB
Raw

kf-format-generator

Randomly generate formats for playing KeyForge

OCLIF

oclif-hello-world

oclif example Hello World CLI

oclif CircleCI GitHub license

Usage

$ npm install -g keyforge-format-generator
$ keyforge-format-generator COMMAND
running command...
$ keyforge-format-generator (--version)
keyforge-format-generator/0.0.0 darwin-arm64 node-v20.10.0
$ keyforge-format-generator --help [COMMAND]
USAGE
  $ keyforge-format-generator COMMAND
...

Commands

keyforge-format-generator hello PERSON

Say hello

USAGE
  $ keyforge-format-generator 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

keyforge-format-generator hello world

Say hello world

USAGE
  $ keyforge-format-generator hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ keyforge-format-generator hello world
  hello world! (./src/commands/hello/world.ts)

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

keyforge-format-generator help [COMMANDS]

Display help for keyforge-format-generator.

USAGE
  $ keyforge-format-generator 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 keyforge-format-generator.

See code: @oclif/plugin-help

keyforge-format-generator plugins

List installed plugins.

USAGE
  $ keyforge-format-generator plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ keyforge-format-generator plugins

See code: @oclif/plugin-plugins

keyforge-format-generator plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ keyforge-format-generator 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
  $ keyforge-format-generator plugins add

EXAMPLES
  $ keyforge-format-generator plugins add myplugin

  $ keyforge-format-generator plugins add https://github.com/someuser/someplugin

  $ keyforge-format-generator plugins add someuser/someplugin

keyforge-format-generator plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ keyforge-format-generator 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
  $ keyforge-format-generator plugins inspect myplugin

See code: @oclif/plugin-plugins

keyforge-format-generator plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ keyforge-format-generator 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
  $ keyforge-format-generator plugins add

EXAMPLES
  $ keyforge-format-generator plugins install myplugin

  $ keyforge-format-generator plugins install https://github.com/someuser/someplugin

  $ keyforge-format-generator plugins install someuser/someplugin

See code: @oclif/plugin-plugins

keyforge-format-generator plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ keyforge-format-generator 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
  $ keyforge-format-generator plugins link myplugin

See code: @oclif/plugin-plugins

keyforge-format-generator plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ keyforge-format-generator 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
  $ keyforge-format-generator plugins unlink
  $ keyforge-format-generator plugins remove

EXAMPLES
  $ keyforge-format-generator plugins remove myplugin

keyforge-format-generator plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ keyforge-format-generator plugins reset

See code: @oclif/plugin-plugins

keyforge-format-generator plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ keyforge-format-generator plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ keyforge-format-generator plugins unlink
  $ keyforge-format-generator plugins remove

EXAMPLES
  $ keyforge-format-generator plugins uninstall myplugin

See code: @oclif/plugin-plugins

keyforge-format-generator plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ keyforge-format-generator 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
  $ keyforge-format-generator plugins unlink
  $ keyforge-format-generator plugins remove

EXAMPLES
  $ keyforge-format-generator plugins unlink myplugin

keyforge-format-generator plugins update

Update installed plugins.

USAGE
  $ keyforge-format-generator plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins