Composable CLI commands for storefront development
This reference lists the commands that you can use to build storefronts with Composable CLI.
Command Overview
Composable CLI accelerates your time to market by providing the following features:
- Create new Next.js storefronts
- Easy setup and configuration of Elastic Path Products and Integrations
Command Syntax
If you've installed Composable CLI globally you can run all commands using your package manager:
- Alais
- Standard
ep [COMMAND] --[FLAG]
composable-cli [COMMAND] --[FLAG]
Command reference
Command | Alias | Description |
---|---|---|
login | Login to the Composable CLI | |
logout | Logout of the Composable CLI | |
feedback | Feedback to the Composable CLI | |
config | interact with stored configuration | |
store | interact with Elastic Path store | |
generate | g | generate Elastic Path storefront |
insights | opt in/out product insights | |
integration | int | Setup Elastic Path integrations for your storefront |
payments | p | Setup Elastic Path payment gateways for your storefront |
Options | Description | Value |
---|---|---|
--version | Show version number | [boolean] |
--debug | Debug mode. This is true by default if the collection is a relative path | [boolean][default: null] |
--interactive | Setting to false disables interactive input prompts. | [boolean][default: true] |
-v, --verbose | Run with verbose logging | [boolean][default: false] |
-dry-run | Run without generating output | [boolean][default: null] |
-allow-private | Allow private schematics to be run from the command line. | [boolean][default: false] |
--force | Force overwriting files that would otherwise be an error. | [boolean] |
--list-schematics | List all schematics from the collection, by name. | [boolean] |
-h, --help | Show help | [boolean] |
login
Authenticate to the Composable CLI
ep login
Flags
Flag | Description |
---|---|
--region, -r | Region of Elastic Path account |
Logout
Logout of the Composable CLI
ep logout
note
D2C is the only available option at this time
Generate
Generate a new Elastic Path storefront
ep generate d2c [project-name]
Flags
Flag | Description |
---|---|
--project-name, -p | The name of the new project. |
--help, -h | Show help for the generate command |
caution
Work in progress more coming soon