LogoLogo
Build appsContact API support
  • Build apps
  • Site Templates
  • API Reference
  • Changelog
  • Introduction to Instant Site development
  • Site templates glossary
  • Develop Site templates
    • Quickstart guide to a working Site template
    • Ecwid (Lightspeed E-Series) Crane CLI tool
    • Build Site templates: project structure
      • template-name.ts
      • section-name.vue
      • content.ts
      • design.ts
      • showcases/1.ts
      • translations.ts
      • layout.ts
  • Launch Site templates
    • Step-by-step publishing guide for Site templates
    • Monetize Site templates
    • Requirements for public Site templates
    • Recommendations for building public Site templates
  • Develop custom sections
    • How to use sections without templates
    • Quickstart with custom sections without building a template

Lightspeed® 2025

On this page

Was this helpful?

  1. Develop Site templates

Ecwid (Lightspeed E-Series) Crane CLI tool

Last updated 7 months ago

Was this helpful?

Instant Site templates are built locally and then deployed to Ecwid. Therefore developers don’t need to worry about the hosting, but they need the tool specified for building templates. Ecwid offers such a tool called Crane.

Crane includes CLI (command line interface) and IDE features that help with creating and deploying templates and their components for Ecwid Instant Site:

  • Install all pre-required packages automatically

  • Initialize a new template using our example as a starting point

  • Build and deploy templates and sections from the command line

CLI commands

You can initialize, build, and deploy templates with the command line. Find a detailed guide for their usage in the .

init command initializes the project in your local environment and downloads code examples. It requires two arguments: type and name.

The type argument is one of the -- app, --section, or --template.

Code example:

npx @lightspeed/crane@latest init --app <name>

build command creates a new build in your local environment. It doesn’t apply any changes to the project version deployed to Ecwid and should always be used in combination with the deploy command.

Code example:

npx @lightspeed/crane@latest build

deploy command sends the current build from your local environment to Ecwid.

Code example:

npx @lightspeed/crane@latest deploy
Quickstart