SDKs

Five client SDKs talk to the data API. They are thin — the server does the work — MIT licensed, and each reads like its language.

Language	Install	Repository
JavaScript / TypeScript	npm install @synthigy/sdk	synthigy/js
Python	pip install synthigy	synthigy/py
Go	go get github.com/synthigy/go	synthigy/go
Clojure / ClojureScript	com.synthigy/sdk on Clojars	synthigy/clj
PHP	composer require synthigy/sdk	synthigy/php

All of them read, write, run XSQL and sql-templates, batch operations into one request, act for users (acting_as) and sign users in through the browser. All but PHP also keep queries live (watch). Each repository's README is that SDK's manual.

A Clojure application can skip HTTP altogether and run the engine in-process — see EMBEDDED.md.

Connecting

An application needs an address and an identity. The synthigy CLI keeps both in the project's .synthigy/.env and hands them to your program:

synthigy env init                     # once: this project gets .synthigy/
synthigy up                           # a local server, if you need one

synthigy iam add-client "My App" --id my-app --type confidential \
  --grant client_credentials --role "Dataset Explorer" --api Synthigy --local
synthigy connect http://localhost:7887 --client-id my-app

synthigy exec -- node app.js          # or python, go run, clj …

connect stores the endpoint and the identity — a client id and secret, or a user's browser sign-in. exec runs your program with that environment, and the SDK picks it up without configuration (connect() with no arguments). A long-running program asks exec for a fresh token when the old one expires.

Outside exec, pass the endpoint and credentials to the SDK yourself, or set SYNTHIGY_ENDPOINT and SYNTHIGY_CLIENT_ID / SYNTHIGY_CLIENT_SECRET. synthigy token prints an access token for curl and scripts.

Code generation

Write your queries as .xsql files (XSQL.md) and generate typed functions from them. The generators read your model from xsql/schema.json, which they fetch from the server when it is missing.

Language	Generate
JavaScript / TypeScript	synthigy exec -- npx synthigy-gen xsql/ generated/
Python	synthigy exec -- python -m synthigy.codegen gen xsql/ --out ops.py
Go	//go:generate go run github.com/synthigy/go/cmd/synthigy-gen
Clojure	synthigy exec -- clj -X synthigy.gen/generate :ns-prefix myapp.ops
PHP	synthigy exec -- vendor/bin/synthigy-codegen gen xsql/ --out gen/ops.php

Code is generated for what the connected identity may see: connect as your application's own client to get exactly its view of the model. Each generator has a check mode for CI that fails when generated code is out of date, and synthigy schema check tells you when the model on the server has changed.

xsql/schema.json is your whole data model. Commit it in a private repository; keep it out of a public one.