Sign In

@mabry/genesis

Package Overview
Dependencies
Maintainers
1
Versions
24
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
Package was removed
Sorry, it seems this package was removed from the registry

@mabry/genesis

A CLI tool for generating Lit Element components, Storybook stories, and more!

latest
Source
npmnpm
Version
0.3.20
Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

Genesis CLI

A CLI tool for generating Lit Element components, Storybook stories, and more!

@TODO - Readme

oclif Version CircleCI Downloads/week License

  • Usage
  • Commands

Usage

$ npm install -g @mabry/genesis
$ genesis COMMAND
running command...
$ genesis (--version)
@mabry/genesis/0.3.20 darwin-x64 node-v14.16.0
$ genesis --help [COMMAND]
USAGE
  $ genesis COMMAND
...

Commands

genesis component create NAME

describe the command here

USAGE
  $ genesis component create [NAME] [-o <value>] [-p <value>] [-b <value>] [-d <value>] [-t]

ARGUMENTS
  NAME  name of component

FLAGS
  -b, --baseClass=<value>  name of base class
  -d, --directory=<value>  directory for the component. defaults to the base name used for the component
  -o, --output=<value>     category for the story, defaults to the same path as the component
  -p, --path=<value>       path to custom-elements.json
  -t, --test               create a test file for the component

DESCRIPTION
  describe the command here

EXAMPLES
  $ genesis component create

genesis help [COMMAND]

Display help for genesis.

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

See code: @oclif/plugin-help

genesis init

Initializes a config file at the root of the current directory

USAGE
  $ genesis init

DESCRIPTION
  Initializes a config file at the root of the current directory

EXAMPLES
  $ genesis init

See code: dist/commands/init.ts

genesis plugins

List installed plugins.

USAGE
  $ genesis plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ genesis plugins

See code: @oclif/plugin-plugins

genesis plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ genesis plugins:install myplugin 

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

  $ genesis plugins:install someuser/someplugin

genesis plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

genesis plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ genesis plugins:install myplugin 

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

  $ genesis plugins:install someuser/someplugin

Links a plugin into the CLI for development.

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

genesis plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ genesis plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ genesis plugins unlink
  $ genesis plugins remove

genesis plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ genesis plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ genesis plugins unlink
  $ genesis plugins remove

genesis plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ genesis plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ genesis plugins unlink
  $ genesis plugins remove

genesis plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

genesis story create NAME

Generates a Storybook story using the custom-elements.json file.

USAGE
  $ genesis story create [NAME] [-f] [-o <value>] [-p <value>] [-c <value>] [-d <value>] [-t]

ARGUMENTS
  NAME  name of component

FLAGS
  -c, --category=<value>            [default: Content] category for the story
  -d, --defaultDirectory=<value>    The default directory of the components. defaults to the base name used for the
                                    component
  -f, --fullBleed                   allow the component to expand to the full width and height of the Storybook Canvas
  -o, --output=<value>              category for the story, defaults to the same path as the component
  -p, --customElementsPath=<value>  path to custom-elements.json. overrides config setting
  -t, --test                        create a test file for the component story

DESCRIPTION
  Generates a Storybook story using the custom-elements.json file.

EXAMPLES
  $ genesis story create

genesis story update NAME

describe the command here

USAGE
  $ genesis story update [NAME] [-f] [-o <value>] [-p <value>] [-s <value>] [-c <value>] [-d <value>] [-t]

ARGUMENTS
  NAME  name of component

FLAGS
  -c, --category=<value>            [default: Content] category for the story
  -d, --defaultDirectory=<value>    Default directory for the component. defaults to the base name used for the
                                    component
  -f, --fullBleed                   allow the component to expand to the full width and height of the Storybook Canvas
  -o, --output=<value>              category for the story, defaults to the same path as the component
  -p, --customElementsPath=<value>  path to custom-elements.json. overrides config setting
  -s, --storyPath=<value>           path to components story file.
                                    overrides config setting
                                    defaults to same folder as component
  -t, --test                        create a test file for the component story

DESCRIPTION
  describe the command here

EXAMPLES
  $ genesis story update

Keywords

oclif

FAQs

Package last updated on 22 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts