@launchmystore/cli
v2.0.3
Published
LaunchMyStore CLI — scaffold apps, deploy extensions, compile WASM functions locally (Javy), tail webhook logs.
Maintainers
Readme
@launchmystore/cli
lms — command-line tool for the LaunchMyStore
app ecosystem. Scaffold apps, deploy extensions and functions, manage
webhooks, and tail logs without leaving your terminal.
About LaunchMyStore
LaunchMyStore is a multi-tenant e-commerce
platform that renders Shopify-compatible Liquid themes and runs a full
app ecosystem on top of them. Merchants get a branded storefront on a
custom domain; developers ship apps that extend the storefront,
checkout, and admin via the same Apps row, OAuth scopes, webhooks,
and declarative function manifests. This CLI is the developer-side
companion to the App Bridge SDK
and React bindings.
Learn more: launchmystore.io · Docs: docs.launchmystore.io
Install
npm install -g @launchmystore/cliRequires Node.js 18+. To build functions you'll also need Bytecode Alliance Javy v3+.
Quick start
lms auth login
lms app create
lms function build --file src/discount.js -o dist/discount.wasm
lms function test --file src/discount.js --type discount
lms function deploy --file src/discount.js --handle save-10 --type discount
lms extension push --name "Reviews" --handle reviews --type app_block --target product --path ./reviews
lms webhook listRun lms <command> --help for full options on any subcommand.
Functions: local compile
Functions are compiled on your machine using the
Bytecode Alliance Javy toolchain,
then uploaded as pre-built .wasm. The server only validates that uploads
are Javy dynamic-mode modules — it never compiles your code. This mirrors
how Shopify Functions are shipped.
Install Javy and put it on your $PATH, or set JAVY_BIN_PATH to its
absolute location.
lms function build— compile JS to a dynamic-mode.wasmlms function deploy— build then upload (--wasm <path>skips the build and uploads a pre-built artifact)lms function test— build then run in the sandbox
Source-size limit: 64 KB. Compiled-size limit: 256 KB.
Configuration
- Credentials:
~/.lms/credentials.json(mode 0600). Override the directory withLMS_CONFIG_DIR. - API base:
https://api.launchmystore.ioby default. Override withLMS_API_BASEorlms auth login --api-base <url>. - Project config:
.lmsrc.jsonin your repo. Auto-discovered up to 10 parent directories. Most commands default to itsappId.
Command groups
lms auth— login / logout / whoamilms app— create / list / infolms function— build / test / deploy / list / logslms extension— list / push / removelms webhook— list / retry
See the docs for full details.
