Skip to main content

App Commands

Commands for creating, developing, and deploying Qumra apps.

Overview

CommandDescription
qumra app initCreate a new Qumra app
qumra app devStart the development environment
qumra app deployDeploy app to production

qumra app init

Create a new Qumra app with the starter template.

Usage

qumra app init

Interactive Steps

  1. App Name: Enter a name for your app (alphanumeric and dashes only)
  2. Organization: Select your organization from the list
  3. Dependencies: Choose whether to install npm dependencies automatically

What Happens

  • Creates the app on Qumra Cloud
  • Clones the starter template from GitHub
  • Saves configuration to .qumra/qumra.config.json
  • Optionally installs npm dependencies

Example

$ qumra app init

? Enter app name: my-store-app
? Select organization: My Company
? Install dependencies? Yes

✅ App created successfully!

📁 Created: my-store-app/
📝 Config: .qumra/qumra.config.json

Next steps:
cd my-store-app
qumra app dev

qumra app dev

Start the development environment with live reload and tunneling.

Usage

qumra app dev

Requirements

Must be run from inside an initialized app directory (with .qumra/qumra.config.json).

Interactive Steps

  1. Dev Store: Select an existing store or create a new one for development

Features

  • Automatic Tunneling: Creates a secure tunnel using Cloudflare for external access
  • Live Dashboard: Interactive terminal UI showing URLs and logs
  • Hot Reload: Automatically syncs changes during development
  • Database Migrations: Runs Prisma migrations automatically

Dashboard Keyboard Shortcuts

KeyAction
qQuit the dev server
pOpen preview URL
oOpen store URL

Environment Variables

The dev server sets these environment variables:

VariableDescription
QUMRA_APP_URLYour app's tunnel URL
QUMRA_API_KEYAPI key for Qumra Cloud
QUMRA_API_SECRETAPI secret for authentication
PORTLocal server port

Example

$ qumra app dev

? Select dev store: my-test-store

🚀 Development server started!

📡 Local URL → http://localhost:3000
🌍 Tunnel URL → https://abc123.trycloudflare.com
🏪 Store URL → https://my-test-store.qumra.store
📦 Install URL → https://app.qumra.cloud/install/...

Press 'q' to quit, 'p' for preview, 'o' to open store

qumra app deploy

Deploy your app to production.

Usage

qumra app deploy

Requirements

  • Must be run from inside an initialized app directory
  • App manifest file (qumra.app.json) must exist

App Manifest

Your qumra.app.json should include:

{
"name": "My App",
"production_url": "https://my-app.example.com",
"embedded": true,
"scopes": ["read_products", "write_orders"],
"webhooks": [
{
"topic": "orders/create",
"address": "/webhooks/orders"
}
]
}

Example

$ qumra app deploy

📦 Deploying app...

✅ App deployed successfully!

🌍 Production URL: https://my-app.example.com
📱 App ID: abc123xyz

Configuration

.qumra/qumra.config.json

Created automatically by qumra app init:

{
"appId": "unique-app-id",
"clientId": "client-id-for-oauth",
"devStore": "selected-dev-store"
}

Tips

Development Workflow
  1. Run qumra app init to create your app
  2. Use qumra app dev during development
  3. Deploy with qumra app deploy when ready
Troubleshooting
  • If tunnel fails, check your internet connection
  • Make sure no other process is using the required ports
  • Run qumra user login if you get authentication errors