Skip to content

A CLI to facilitate the generation of new Lit Web Components and tools.

License

Notifications You must be signed in to change notification settings

inlinejs/lit-generate

Repository files navigation

[DRAFT] lit-generate

CLI to generate new Lit Web Components.

This is a work in progress and will not be stable or probably do much of anything until a 0.1.0. release.

oclif Version Downloads/week License

Usage

$ npm install -g lit-generate
$ lit-generate COMMAND
running command...
$ lit-generate (--version)
lit-generate/0.0.3 darwin-x64 node-v18.8.0
$ lit-generate --help [COMMAND]
USAGE
  $ lit-generate COMMAND
...

Commands

lit-generate component

Creates a new Lit Web Component.

USAGE
  $ lit-generate component

DESCRIPTION
  Creates a new Lit Web Component.

EXAMPLES
  $ lit-generate component

See code: dist/commands/component.ts

lit-generate help [COMMAND]

Display help for lit-generate.

USAGE
  $ lit-generate 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 lit-generate.

See code: @oclif/plugin-help

lit-generate plugins

List installed plugins.

USAGE
  $ lit-generate plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ lit-generate plugins

See code: @oclif/plugin-plugins

lit-generate plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ lit-generate plugins:install myplugin 

  $ lit-generate plugins:install https://github.com/someuser/someplugin

  $ lit-generate plugins:install someuser/someplugin

lit-generate plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

lit-generate plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ lit-generate plugins:install myplugin 

  $ lit-generate plugins:install https://github.com/someuser/someplugin

  $ lit-generate plugins:install someuser/someplugin

lit-generate plugins:link PLUGIN

Links a plugin into the CLI for development.

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

lit-generate plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ lit-generate plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ lit-generate plugins unlink
  $ lit-generate plugins remove

lit-generate plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ lit-generate plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ lit-generate plugins unlink
  $ lit-generate plugins remove

lit-generate plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ lit-generate plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ lit-generate plugins unlink
  $ lit-generate plugins remove

lit-generate plugins update

Update installed plugins.

USAGE
  $ lit-generate plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

About

A CLI to facilitate the generation of new Lit Web Components and tools.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published