Vue Storefront's CLI.
npm install @vue-storefront/cliTo create a new Alokai project, use the following command:
``bash`
npx @vue-storefront/cli generate store
To generate a new template project from the integration source code, use the following command:
`bash`
npx @vue-storefront/cli generate template
* [@vue-storefront/cli add [COMMANDARG] [ENDPOINT]](#vue-storefrontcli-add-commandarg-endpoint)@vue-storefront/cli add endpoint [NAME]
* [](#vue-storefrontcli-add-endpoint-name)@vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME]
* [](#vue-storefrontcli-create-commandname-integrationname)@vue-storefront/cli create integration [NAME]
* [](#vue-storefrontcli-create-integration-name)@vue-storefront/cli help [COMMANDS]
* [](#vue-storefrontcli-help-commands)@vue-storefront/cli plugins
* @vue-storefront/cli plugins:install PLUGIN...
* @vue-storefront/cli plugins:inspect PLUGIN...
* @vue-storefront/cli plugins:install PLUGIN...
* @vue-storefront/cli plugins:link PLUGIN
* @vue-storefront/cli plugins:uninstall PLUGIN...
* @vue-storefront/cli plugins:uninstall PLUGIN...
* @vue-storefront/cli plugins:uninstall PLUGIN...
* @vue-storefront/cli plugins update
* @vue-storefront/cli update [CHANNEL]
* [](#vue-storefrontcli-update-channel)
Create new endpoint boilerplate code
`
USAGE
$ @vue-storefront/cli add [COMMANDARG] [ENDPOINT]
ARGUMENTS
COMMANDARG Name of the command
ENDPOINT Name of the endpoint
DESCRIPTION
Create new endpoint boilerplate code
EXAMPLES
$ @vue-storefront/cli add
`
_See code: src/commands/add/index.ts_
Create new endpoint boilerplate code
`
USAGE
$ @vue-storefront/cli add endpoint [NAME]
ARGUMENTS
NAME Name of the endpoint
DESCRIPTION
Create new endpoint boilerplate code
EXAMPLES
$ @vue-storefront/cli add endpoint
`
_See code: src/commands/add/endpoint.ts_
Generate integration boilerplate
`
USAGE
$ @vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME] [-t nuxt|next]
FLAGS
-t, --framework=
DESCRIPTION
Generate integration boilerplate
EXAMPLES
$ @vue-storefront/cli create
`
_See code: src/commands/create/index.ts_
Generate integration boilerplate
`
USAGE
$ @vue-storefront/cli create integration [NAME] [-t nuxt|next]
FLAGS
-t, --framework=
DESCRIPTION
Generate integration boilerplate
EXAMPLES
$ @vue-storefront/cli create integration
`
_See code: src/commands/create/integration.ts_
Display help for @vue-storefront/cli.
`
USAGE
$ @vue-storefront/cli 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 @vue-storefront/cli.
`
_See code: @oclif/plugin-help_
List installed plugins.
`
USAGE
$ @vue-storefront/cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ @vue-storefront/cli plugins
`
_See code: @oclif/plugin-plugins_
Installs a plugin into the CLI.
`
USAGE
$ @vue-storefront/cli 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
$ @vue-storefront/cli plugins add
EXAMPLES
$ @vue-storefront/cli plugins:install myplugin
$ @vue-storefront/cli plugins:install https://github.com/someuser/someplugin
$ @vue-storefront/cli plugins:install someuser/someplugin
`
Displays installation properties of a plugin.
`
USAGE
$ @vue-storefront/cli 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
$ @vue-storefront/cli plugins:inspect myplugin
`
_See code: @oclif/plugin-plugins_
Installs a plugin into the CLI.
`
USAGE
$ @vue-storefront/cli 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
$ @vue-storefront/cli plugins add
EXAMPLES
$ @vue-storefront/cli plugins:install myplugin
$ @vue-storefront/cli plugins:install https://github.com/someuser/someplugin
$ @vue-storefront/cli plugins:install someuser/someplugin
`
_See code: @oclif/plugin-plugins_
Links a plugin into the CLI for development.
`
USAGE
$ @vue-storefront/cli 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
$ @vue-storefront/cli plugins:link myplugin
`
_See code: @oclif/plugin-plugins_
Removes a plugin from the CLI.
`
USAGE
$ @vue-storefront/cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ @vue-storefront/cli plugins unlink
$ @vue-storefront/cli plugins remove
`
Removes a plugin from the CLI.
`
USAGE
$ @vue-storefront/cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ @vue-storefront/cli plugins unlink
$ @vue-storefront/cli plugins remove
`
_See code: @oclif/plugin-plugins_
Removes a plugin from the CLI.
`
USAGE
$ @vue-storefront/cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ @vue-storefront/cli plugins unlink
$ @vue-storefront/cli plugins remove
`
Update installed plugins.
`
USAGE
$ @vue-storefront/cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
`
_See code: @oclif/plugin-plugins_
update the @vue-storefront/cli CLI
`
USAGE
$ @vue-storefront/cli update [CHANNEL] [-a] [-v
FLAGS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=
--force Force a re-download of the requested version.
DESCRIPTION
update the @vue-storefront/cli CLI
EXAMPLES
Update to the stable channel:
$ @vue-storefront/cli update stable
Update to a specific version:
$ @vue-storefront/cli update --version 1.0.0
Interactively select version:
$ @vue-storefront/cli update --interactive
See available versions:
$ @vue-storefront/cli update --available
``
_See code: @oclif/plugin-update_