0.1.1-beta.2 • Published 3 years ago
@gochewy/cli v0.1.1-beta.2
Chewy CLI
Welcome to the Chewy Stack. This CLI is probably what you'll want to get started!
Usage
$ npm install -g @gochewy/cli
$ chewy COMMAND
running command...
$ chewy (--version)
@gochewy/cli/0.1.1-beta.1 linux-x64 node-v16.17.1
$ chewy --help [COMMAND]
USAGE
$ chewy COMMAND
...Commands
chewy create [FILE]chewy dev [FILE]chewy help [COMMAND]chewy init [PATH]chewy install [FILE]chewy pluginschewy plugins:install PLUGIN...chewy plugins:inspect PLUGIN...chewy plugins:install PLUGIN...chewy plugins:link PLUGINchewy plugins:uninstall PLUGIN...chewy plugins:uninstall PLUGIN...chewy plugins:uninstall PLUGIN...chewy plugins update
chewy create [FILE]
describe the command here
USAGE
$ chewy create [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ chewy createSee code: dist/commands/create/index.ts
chewy dev [FILE]
describe the command here
USAGE
$ chewy dev [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ chewy devSee code: dist/commands/dev/index.ts
chewy help [COMMAND]
Display help for chewy.
USAGE
$ chewy 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 chewy.See code: @oclif/plugin-help
chewy init [PATH]
describe the command here
USAGE
$ chewy init [PATH] -n <value>
ARGUMENTS
PATH [default: chewy-project] path to create project in
FLAGS
-n, --name=<value> (required) project name (kebab-cased)
DESCRIPTION
describe the command here
EXAMPLES
$ chewy initSee code: dist/commands/init/index.ts
chewy install [FILE]
describe the command here
USAGE
$ chewy install [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ chewy installSee code: dist/commands/install/index.ts
chewy plugins
List installed plugins.
USAGE
$ chewy plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ chewy pluginsSee code: @oclif/plugin-plugins
chewy plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ chewy 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
$ chewy plugins add
EXAMPLES
$ chewy plugins:install myplugin
$ chewy plugins:install https://github.com/someuser/someplugin
$ chewy plugins:install someuser/somepluginchewy plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ chewy 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
$ chewy plugins:inspect mypluginchewy plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ chewy 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
$ chewy plugins add
EXAMPLES
$ chewy plugins:install myplugin
$ chewy plugins:install https://github.com/someuser/someplugin
$ chewy plugins:install someuser/somepluginchewy plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ chewy 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
$ chewy plugins:link mypluginchewy plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ chewy plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ chewy plugins unlink
$ chewy plugins removechewy plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ chewy plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ chewy plugins unlink
$ chewy plugins removechewy plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ chewy plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ chewy plugins unlink
$ chewy plugins removechewy plugins update
Update installed plugins.
USAGE
$ chewy plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.