@storebrand-digital/iwa.cli v2.3.1

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @storebrand-digital/iwa.cli
$ iwa COMMAND
running command...
$ iwa (--version)
@storebrand-digital/iwa.cli/2.3.1 linux-x64 node-v18.20.1
$ iwa --help [COMMAND]
USAGE
  $ iwa COMMAND
...

Commands

• iwa c INPUT
• iwa clean INPUT
• iwa g INPUT [OUTPUT]
• iwa gen INPUT [OUTPUT]
• iwa generate INPUT [OUTPUT]
• iwa help [COMMANDS]
• iwa plugins
• iwa plugins:install PLUGIN...
• iwa plugins:inspect PLUGIN...
• iwa plugins:install PLUGIN...
• iwa plugins:link PLUGIN
• iwa plugins:uninstall PLUGIN...
• iwa plugins:reset
• iwa plugins:uninstall PLUGIN...
• iwa plugins:uninstall PLUGIN...
• iwa plugins:update

iwa c INPUT

USAGE
  $ iwa c INPUT

ARGUMENTS
  INPUT  Path to the input index.html file

ALIASES
  $ iwa c

iwa clean INPUT

USAGE
  $ iwa clean INPUT

ARGUMENTS
  INPUT  Path to the input index.html file

ALIASES
  $ iwa c

See code: src/commands/clean.ts

iwa g INPUT [OUTPUT]

Inject configuration into your project

USAGE
  $ iwa g INPUT [OUTPUT] [-c <value>] [-e <value>] [-v] [-h]

ARGUMENTS
  INPUT   Path to the input index.html file
  OUTPUT  Path to the output index.html file. If not specified,
          the input file will be overriden instead

FLAGS
  -c, --config=<value>       [default: /home/runner/work/iwa/iwa/packages/cli] Path to the .iwarc file
  -e, --environment=<value>  [default: production] Environemnt to instigate
  -h, --help                 Show CLI help.
  -v, --version              Show CLI version.

DESCRIPTION
  Inject configuration into your project

ALIASES
  $ iwa g
  $ iwa gen

iwa gen INPUT [OUTPUT]

Inject configuration into your project

USAGE
  $ iwa gen INPUT [OUTPUT] [-c <value>] [-e <value>] [-v] [-h]

ARGUMENTS
  INPUT   Path to the input index.html file
  OUTPUT  Path to the output index.html file. If not specified,
          the input file will be overriden instead

FLAGS
  -c, --config=<value>       [default: /home/runner/work/iwa/iwa/packages/cli] Path to the .iwarc file
  -e, --environment=<value>  [default: production] Environemnt to instigate
  -h, --help                 Show CLI help.
  -v, --version              Show CLI version.

DESCRIPTION
  Inject configuration into your project

ALIASES
  $ iwa g
  $ iwa gen

iwa generate INPUT [OUTPUT]

Inject configuration into your project

USAGE
  $ iwa generate INPUT [OUTPUT] [-c <value>] [-e <value>] [-v] [-h]

ARGUMENTS
  INPUT   Path to the input index.html file
  OUTPUT  Path to the output index.html file. If not specified,
          the input file will be overriden instead

FLAGS
  -c, --config=<value>       [default: /home/runner/work/iwa/iwa/packages/cli] Path to the .iwarc file
  -e, --environment=<value>  [default: production] Environemnt to instigate
  -h, --help                 Show CLI help.
  -v, --version              Show CLI version.

DESCRIPTION
  Inject configuration into your project

ALIASES
  $ iwa g
  $ iwa gen

See code: src/commands/generate.ts

iwa help [COMMANDS]

Display help for iwa.

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

See code: @oclif/plugin-help

iwa plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ iwa plugins

See code: @oclif/plugin-plugins

iwa plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ iwa plugins:add myplugin 

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

  $ iwa plugins:add someuser/someplugin

iwa plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

iwa plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ iwa plugins:install myplugin 

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

  $ iwa plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

iwa plugins:link PLUGIN

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

iwa plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

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

EXAMPLES
  $ iwa plugins:remove myplugin

iwa plugins:reset

Remove all user-installed and linked plugins.

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

iwa plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ iwa plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ iwa plugins:unlink
  $ iwa plugins:remove

EXAMPLES
  $ iwa plugins:uninstall myplugin

See code: @oclif/plugin-plugins

iwa plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

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

EXAMPLES
  $ iwa plugins:unlink myplugin

iwa plugins:update

Update installed plugins.

USAGE
  $ iwa plugins:update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins