@ed3digital/cli

ED3 CLI

• ED3 CLI
• Usage
• Commands

Usage

$ npm install -g @ed3digital/cli
$ ed3 COMMAND
running command...
$ ed3 (--version)
@ed3digital/cli/0.1.11 linux-x64 node-v18.19.0
$ ed3 --help [COMMAND]
USAGE
  $ ed3 COMMAND
...

Commands

• ed3 create component
• ed3 create page [NAME]
• ed3 help [COMMANDS]
• ed3 plugins
• ed3 plugins:install PLUGIN...
• ed3 plugins:inspect PLUGIN...
• ed3 plugins:install PLUGIN...
• ed3 plugins:link PLUGIN
• ed3 plugins:uninstall PLUGIN...
• ed3 plugins reset
• ed3 plugins:uninstall PLUGIN...
• ed3 plugins:uninstall PLUGIN...
• ed3 plugins update

ed3 create component

Create a new component

USAGE
  $ ed3 create component [-c <value>] [-n <value>] [-t <value>]

FLAGS
  -c, --composition=<value>  Vtex interface composition type (block, children, none)
  -n, --name=<value>         Component name (Any PascalCase text ou path. Ex: Component or Component/Component
  -t, --type=<value>         Component type (basic, cva, stitches

DESCRIPTION
  Create a new component

EXAMPLES
  $ ed3 create component -n ComponentName -t cva -c children

  $ ed3 create component -n ComponentName/ComponentName -t basic -c block

  $ ed3 create component (Use without flags to be prompted for the component name, type and composition type)

ed3 create page [NAME]

Create a new page

USAGE
  $ ed3 create page [NAME] [-t <value>]

ARGUMENTS
  NAME  Page name

FLAGS
  -t, --type=<value>  Page type

DESCRIPTION
  Create a new page

EXAMPLES
  $ ed3 create page

ed3 help [COMMANDS]

Display help for ed3.

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

See code: @oclif/plugin-help

ed3 plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ed3 plugins

See code: @oclif/plugin-plugins

ed3 plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ ed3 plugins add myplugin 

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

  $ ed3 plugins add someuser/someplugin

ed3 plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

ed3 plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ ed3 plugins install myplugin 

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

  $ ed3 plugins install someuser/someplugin

See code: @oclif/plugin-plugins

ed3 plugins:link PLUGIN

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

ed3 plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

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

EXAMPLES
  $ ed3 plugins remove myplugin

ed3 plugins reset

Remove all user-installed and linked plugins.

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

ed3 plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ed3 plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ed3 plugins unlink
  $ ed3 plugins remove

EXAMPLES
  $ ed3 plugins uninstall myplugin

See code: @oclif/plugin-plugins

ed3 plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

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

EXAMPLES
  $ ed3 plugins unlink myplugin

ed3 plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jhon Santana 💻 📖

Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!