diff --git a/.changeset/shaggy-turtles-ring.md b/.changeset/shaggy-turtles-ring.md new file mode 100644 index 0000000000..303431adfe --- /dev/null +++ b/.changeset/shaggy-turtles-ring.md @@ -0,0 +1,5 @@ +--- +"@vue-storefront/cli": major +--- + +**[REMOVED]** `generate` command. If you are an enterprise user, please check the [Getting started](https://docs.alokai.com/storefront/introduction/getting-started) page in the docs. If you are a community user, please check the example [Next.js project](https://github.com/vuestorefront/storefront-next13-boilerplate) and [Nuxt project](https://github.com/vuestorefront/storefront-nuxt3-boilerplate). diff --git a/packages/cli/README.md b/packages/cli/README.md index b9691d2976..5ecf62fa45 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -17,10 +17,11 @@ npx @vue-storefront/cli generate template ## Commands -* [`@vue-storefront/cli generate store`](#vue-storefrontcli-generate-store) -* [`@vue-storefront/cli generate template`](#vue-storefrontcli-generate-template) -* [`@vue-storefront/cli help [COMMAND]`](#vue-storefrontcli-help-command) -* [`@vue-storefront/cli init`](#vue-storefrontcli-init) +* [`@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-storefrontcli-plugins) * [`@vue-storefront/cli plugins:install PLUGIN...`](#vue-storefrontcli-pluginsinstall-plugin) * [`@vue-storefront/cli plugins:inspect PLUGIN...`](#vue-storefrontcli-pluginsinspect-plugin) @@ -32,60 +33,108 @@ npx @vue-storefront/cli generate template * [`@vue-storefront/cli plugins update`](#vue-storefrontcli-plugins-update) * [`@vue-storefront/cli update [CHANNEL]`](#vue-storefrontcli-update-channel) -## `@vue-storefront/cli generate store` +## `@vue-storefront/cli add [COMMANDARG] [ENDPOINT]` + +Create new endpoint boilerplate code ``` USAGE - $ @vue-storefront/cli generate store + $ @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 generate store + $ @vue-storefront/cli add ``` -## `@vue-storefront/cli generate template` +_See code: [src/commands/add/index.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/add/index.ts)_ + +## `@vue-storefront/cli add endpoint [NAME]` + +Create new endpoint boilerplate code ``` USAGE - $ @vue-storefront/cli generate template [--output ] + $ @vue-storefront/cli add endpoint [NAME] -FLAGS - --output= [default: .] +ARGUMENTS + NAME Name of the endpoint + +DESCRIPTION + Create new endpoint boilerplate code EXAMPLES - $ @vue-storefront/cli generate template + $ @vue-storefront/cli add endpoint ``` -## `@vue-storefront/cli help [COMMAND]` +_See code: [src/commands/add/endpoint.ts](https://github.com/vuestorefront/vue-storefront/blob/v5.0.0/src/commands/add/endpoint.ts)_ -Display help for @vue-storefront/cli. +## `@vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME]` + +Generate integration boilerplate ``` USAGE - $ @vue-storefront/cli help [COMMAND] [-n] - -ARGUMENTS - COMMAND Command to show help for. + $ @vue-storefront/cli create [COMMANDNAME] [INTEGRATIONNAME] [-t nuxt|next] FLAGS - -n, --nested-commands Include all nested commands in the output. + -t, --framework=