plugin-scaffold
v0.0.0
Published
A new CLI generated with oclif
Readme
plugin-scaffold
A new CLI generated with oclif
Usage
$ npm install -g plugin-scaffold
$ plugin-scaffold COMMAND
running command...
$ plugin-scaffold (--version)
plugin-scaffold/0.0.0 win32-x64 node-v22.18.0
$ plugin-scaffold --help [COMMAND]
USAGE
$ plugin-scaffold COMMAND
...Commands
plugin-scaffold generate NAMEplugin-scaffold help [COMMAND]plugin-scaffold pluginsplugin-scaffold plugins add PLUGINplugin-scaffold plugins:inspect PLUGIN...plugin-scaffold plugins install PLUGINplugin-scaffold plugins link PATHplugin-scaffold plugins remove [PLUGIN]plugin-scaffold plugins resetplugin-scaffold plugins uninstall [PLUGIN]plugin-scaffold plugins unlink [PLUGIN]plugin-scaffold plugins update
plugin-scaffold generate NAME
Scaffold a new project (shell or microfrontend)
USAGE
$ plugin-scaffold generate NAME [--type shell|microfront]
ARGUMENTS
NAME Name of the project to generate
FLAGS
--type=<option> <options: shell|microfront>
DESCRIPTION
Scaffold a new project (shell or microfrontend)
EXAMPLES
$ plugin-scaffold generate my-new-app --type=shellSee code: src/commands/generate.ts
plugin-scaffold help [COMMAND]
Display help for plugin-scaffold.
USAGE
$ plugin-scaffold 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 plugin-scaffold.See code: @oclif/plugin-help
plugin-scaffold plugins
List installed plugins.
USAGE
$ plugin-scaffold plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ plugin-scaffold pluginsSee code: @oclif/plugin-plugins
plugin-scaffold plugins add PLUGIN
Installs a plugin into plugin-scaffold.
USAGE
$ plugin-scaffold plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into plugin-scaffold.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PLUGIN_SCAFFOLD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PLUGIN_SCAFFOLD_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ plugin-scaffold plugins add
EXAMPLES
Install a plugin from npm registry.
$ plugin-scaffold plugins add myplugin
Install a plugin from a github url.
$ plugin-scaffold plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ plugin-scaffold plugins add someuser/somepluginplugin-scaffold plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ plugin-scaffold 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
$ plugin-scaffold plugins inspect mypluginSee code: @oclif/plugin-plugins
plugin-scaffold plugins install PLUGIN
Installs a plugin into plugin-scaffold.
USAGE
$ plugin-scaffold plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into plugin-scaffold.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PLUGIN_SCAFFOLD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PLUGIN_SCAFFOLD_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ plugin-scaffold plugins add
EXAMPLES
Install a plugin from npm registry.
$ plugin-scaffold plugins install myplugin
Install a plugin from a github url.
$ plugin-scaffold plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ plugin-scaffold plugins install someuser/somepluginSee code: @oclif/plugin-plugins
plugin-scaffold plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ plugin-scaffold plugins link PATH [-h] [--install] [-v]
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
$ plugin-scaffold plugins link mypluginSee code: @oclif/plugin-plugins
plugin-scaffold plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ plugin-scaffold plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ plugin-scaffold plugins unlink
$ plugin-scaffold plugins remove
EXAMPLES
$ plugin-scaffold plugins remove mypluginplugin-scaffold plugins reset
Remove all user-installed and linked plugins.
USAGE
$ plugin-scaffold 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
plugin-scaffold plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ plugin-scaffold plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ plugin-scaffold plugins unlink
$ plugin-scaffold plugins remove
EXAMPLES
$ plugin-scaffold plugins uninstall mypluginSee code: @oclif/plugin-plugins
plugin-scaffold plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ plugin-scaffold plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ plugin-scaffold plugins unlink
$ plugin-scaffold plugins remove
EXAMPLES
$ plugin-scaffold plugins unlink mypluginplugin-scaffold plugins update
Update installed plugins.
USAGE
$ plugin-scaffold plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
