Skip to main content

​
list

List services in the current workspace: 
synthetiq service list

NAME              AUTH TYPE    STATUS      TOOLS
shopify           oauth2       Published   12
github            oauth2       Published   8
internal-api      custom       Draft       3
FlagDescription
--jsonOutput as JSON

​
create

Scaffold a new service in the workspace: 
synthetiq service create <name>

​
config

Configure service settings and credentials: 
synthetiq service config <name>
Opens an interactive configuration flow for display name, description, category, authentication type, and credentials.

​
auth

Initiate an OAuth authentication flow for a service: 
synthetiq service auth <name>
For services with oauth2 auth type, this opens your browser to the service’s authorization URL.

​
client

Generate a typed client for a service: 
synthetiq service client <name>

​
push

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

​
versions

List all published versions of a service: 
synthetiq service versions <name>

VERSION              PUBLISHED BY       DATE              ACTIVE
2024.06.10-153042    you@example.com    Jun 10, 2024      ✓
2024.06.05-140000    you@example.com    Jun 5, 2024
FlagDescription
--jsonOutput as JSON

​
set-active

Set the active version for a service: 
synthetiq service set-active <name> --version <version>
The active version is the one installed when other users install this service. Apps that depend on the service continue using their locally installed version until they update. 
synthetiq service set-active shopify --version 2024.06.05-140000