Storeware Docs
Command reference

Command reference

Every command the CLI has, 24 in all, with its arguments, flags and examples.

Each command runs as npx @storeware/cli <command>. The same text is in your terminal: run npx @storeware/cli help for this list, or add --help to any command for its page.

Signing in

CommandWhat it does
loginSign in by approving a code in the admin.
logoutEnd this sign-in, on the server as well as here.
whoamiShow who you are, in which organisation, and your apps.

Building an app

CommandWhat it does
initScaffold an app, with a manifest and a server to start from.
validateCheck a manifest, and its scopes and events when you are signed in.
app devRun your app on a development store, through a tunnel to this machine.
app preflightRun the checks a review runs, against your app on a development store.
app submitSend your app's listing draft for review.
mcpServe the docs, the manifest schema and your app to a coding agent, over MCP on stdio.
app deploySend a production release, with a hosted app’s code bundled and uploaded first, and say which shops take it.
app releasesList releases, newest first, with how many shops run each.
app rollbackMake an earlier production release the current one again.
app logsShow the API calls your app made, newest last.
webhook triggerSend your app one signed event from a development store.

Development stores

CommandWhat it does
store listList your development stores.
store createMake a store that never opens and takes test payments only.
store seedFill a development store with sample products and customers.
store test-orderPlace a real order, so your app gets real order events.

Themes

CommandWhat it does
theme initScaffold a theme, offline.
theme validateRead a theme file with the platform's own parsers, offline.
theme pullWrite this shop's published look to a file.
theme pushSend a theme file to the draft, which shoppers do not see.
theme previewPrint a link that serves the draft, retiring the last one.
theme publishMake the draft the shop, the one theme command a shopper sees.

Flags every command takes

FlagWhat it does
--api <url>Use another API, for local development.
--admin <url>Use another admin, for local development.
--helpShow the command's help instead of running it.

On this page