Skip to main content

​
list

List apps in the current workspace: 
synthetiq app list

NAME              CATEGORY       STATUS      LAST MODIFIED
my-app            Productivity   Published   2024-06-10
analytics-dash    Analytics      Draft       2024-06-08
FlagDescription
--jsonOutput as JSON

​
create

Create a new app from the app-framework template: 
synthetiq app create <name>

​
clone

Clone an existing app as a starting point for a new project: 
synthetiq app clone <name> [--as <new-name>]
FlagDefaultDescription
--as <new-name><name>-copyName for the cloned app

​
config

View or edit app configuration: 
synthetiq app config <name>
Opens an interactive configuration flow for app display name, description, category, and settings.

​
package

Build a self-contained production package: 
synthetiq app package <name> [options]
FlagDefaultDescription
--db-adapter <type>sqliteDatabase adapter: sqlite, postgresql, mysql
--target-arch <arch>—Target architecture (e.g., linux-arm64)
synthetiq app package my-app --db-adapter postgresql --target-arch linux-arm64

​
Running the package

node .package/server.js    # Start the app server
node .package/worker.js    # Start the workflow worker

​
push

Publish a new version of an app to the Synthetiq registry: 
synthetiq app push <name> [options]
FlagDescription
--message <msg>Version description
--forcePublish even if no changes detected

​
versions

List all published versions of an app: 
synthetiq app versions <name>

VERSION              PUBLISHED BY       DATE              ACTIVE
2024.06.10-153042    you@example.com    Jun 10, 2024      ✓
2024.06.08-091530    you@example.com    Jun 8, 2024
2024.06.01-120000    co@example.com     Jun 1, 2024
FlagDescription
--jsonOutput as JSON

​
set-active

Set the active version for an app: 
synthetiq app set-active <name> --version <version>
The active version is the current version in the app store. This affects the version people install or upgrade to. 
synthetiq app set-active my-app --version 2024.06.08-091530