Skip to main content

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:

ep [COMMAND] --[FLAG]

Command reference

CommandAliasDescription
loginLogin to the Composable CLI
logoutLogout of the Composable CLI
feedbackFeedback to the Composable CLI
configinteract with stored configuration
storeinteract with Elastic Path store
generateggenerate Elastic Path storefront
insightsopt in/out product insights
integrationintSetup Elastic Path integrations for your storefront
paymentspSetup Elastic Path payment gateways for your storefront
OptionsDescriptionValue
--versionShow version number[boolean]
--debugDebug mode. This is true by default if the collection is a relative path[boolean][default: null]
--interactiveSetting to false disables interactive input prompts.[boolean][default: true]
-v, --verboseRun with verbose logging[boolean][default: false]
-dry-runRun without generating output[boolean][default: null]
-allow-privateAllow private schematics to be run from the command line.[boolean][default: false]
--forceForce overwriting files that would otherwise be an error.[boolean]
--list-schematicsList all schematics from the collection, by name.[boolean]
-h, --helpShow help[boolean]

login

Authenticate to the Composable CLI

ep login

Flags

FlagDescription
--region, -rRegion 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

FlagDescription
--project-name, -pThe name of the new project.
--help, -hShow help for the generate command

caution

Work in progress more coming soon