Install the SDK
Get the SDK package, install it in your Node project, and use its JavaScript, TypeScript, and CLI entry points.
Requires Node.js 22 or later. ESM, CommonJS, and TypeScript declarations are included.
Get and install the package
The SDK isn't published to npm or offered as a public download. Email p@synquic.com for the package: a
synq-<version>.tgz file matching your panel's version. Install it in your Node project:
npm install /absolute/path/to/synq-<version>.tgzInstall the matching package again when you upgrade your panel. Everything the SDK does is also available over the REST API, with a personal access token.
Choose an import
| Import | Provides |
|---|---|
synq | Native factory, remote clients, deployment helpers, public types, and errors. |
synq/client | Remote clients and HTTP helpers. |
synq/native | Native factory, identity types, lifecycle options, and scoped operations. |
import { createShip, SynqClient } from "synq";
import type { ScopedShip, ProjectOperations } from "synq";const { SynqClient } = require("synq/client");
const { createShip } = require("synq/native");Imports are passive. An import does not start the CLI, open a database, or create a worker.
Use the CLI from the same installation
npx synq --helpInstalling the tarball as a dependency provides both application imports and the command through npx or
npm scripts.
Continue with remote setup, native setup, or the runnable example. See compatibility for server requirements.