Linkage Docs

Linkage is a React Flow-based workflow UI SDK. It gives you the canvas, node UI, collaboration, and control blocks—so you can build workflow-driven products on top of your existing backend.

Start here

React SDK

Render the editor, wire up collaboration, and integrate with your app

Execution Adapter

Bring your own runtime (Temporal, queues, Lambdas) and stream run state into Linkage

Node Registry

Define and upload node schemas so Linkage can render inputs/outputs and blocks

CLI Reference

Scaffold a frontend integration and upload a node registry

What Linkage does

Workflow UI SDK: a production-ready editor built on @xyflow/react
Collaboration: presence + cursors (via Liveblocks under the hood)
Control blocks: opinionated building blocks (if/for/each, etc.)
Smart inputs: typed forms powered by your uploaded node schema

Quick Start

1) Scaffold (recommended)

npm install -g @linkage-open/cli

linkage init my-workflow-app
cd my-workflow-app

2) Upload your node registry

linkage config set-api-key
linkage upload ./registry.ts

3) Render the editor

import "@linkage-open/lib/styles.css";

import { ClientProvider, StandaloneEditor } from "@linkage-open/lib/react";

export function WorkflowEditor() {
  return (
    <ClientProvider
      config={{
        clientAppId: process.env.NEXT_PUBLIC_LINKAGE_CLIENT_APP_ID!,
        clientAppSecret: process.env.NEXT_PUBLIC_LINKAGE_CLIENT_APP_SECRET!,
        userId: process.env.NEXT_PUBLIC_LINKAGE_USER_ID!,
        workflowId: "workflow_123",
      }}
    >
      <StandaloneEditor
        buildConfig={{
          schemaVersion: "1.0.0",
          controlBlocks: true,
          stemNode: true,
        }}
      />
    </ClientProvider>
  );
}

React SDK for editor setup and hooks
Node Registry for defining/uploading nodes and schemas
CLI for scaffolding and uploading