SDK and CLI Reference Overview

The official TypeScript SDK (@ligantic/sdk) and command-line interface (@ligantic/cli) give external developers one coherent way to authenticate, manage Spaces and Resources, work with Records, and invoke and inspect Flows against the Ligantic API.

Both packages are treated as one developer experience: they share the same contracts, authentication, error model, and versioning. The CLI is a thin, human-friendly layer built directly on the SDK.

Requires Node.js 22+.
v1 authenticates with API keys only (bearer). Interactive/OAuth login is not supported.
The SDK is a versioned mirror of the OpenAPI v1 surface — every operation returns a Result and the SDK never throws.

SDK and CLI Documentation

The SDK and CLI pages are grouped under the matching section of the external docs.

Tutorials — Learning by Doing

Document	What you'll do
Your First Integration with the Ligantic SDK	Install → authenticate → list a Space → read a Record → run a Flow, end to end

How-To Guides — Accomplishing a Goal

Document	Goal
How to Run a Flow from CI	Trigger and wait on a Flow run from a non-interactive job
How to Sync Records with the CLI	Create and inspect Records from the command line
How to Handle Pagination	Page through list endpoints with raw `limit`/`offset`/`cursor`
How to Build Schemas, Flows, and Experiences Incrementally with the CLI	Change one Schema field, Flow node or edge, or Experience block at a time
How to Use the CLI in a Script	Pipe the key, select a Space, and consume `--json` output without a TTY

Reference — Looking It Up

Document	Contents
SDK API Reference	The `Ligantic` client, every resource method, options, and the result/error types
CLI Command Reference	Every hand-written `ligantic` command, flag, global option, and the config file schema
Generated CLI commands	The commands generated from the OpenAPI spec, covering the rest of the API

Explanation — Understanding the Design

Document	Topic
Authentication and Key Storage	API-key auth, where the CLI stores the key, and the config precedence chain
The Result-Based Error Model	Why the SDK never throws, and how to read a `LiganticError`
The SDK as an API Mirror	The compatibility model and how the SDK tracks the OpenAPI version

Install

pnpm add @ligantic/sdk
pnpm add --global @ligantic/cli

Support

General questions & bugs: open a GitHub issue using the SDK/CLI template. Issues are triaged weekly.
Security reports: see the security page on the Ligantic website. Do not open a public issue.
Paid engagements: see the contact page on the Ligantic website.

Versioning

The SDK and CLI are released in lockstep. Breaking changes to the public surface only occur in a major version; deprecated members remain functional for at least one minor (and through the current major for API-driven deprecations) before removal. See The SDK as an API Mirror for the full compatibility model.