runflow-js

The JavaScript surface for Runflow — SDK, embeddable Studio, and server proxy.

Packages

Package	Description
@runflow-io/sdk	Typed HTTP client for the Runflow API. Isomorphic — runs in Node, Bun, Deno, browsers, workers.
@runflow-io/studio	Embeddable Studio UI. Drop into any website via <script> tag or npm install.
@runflow-io/proxy	Web Standards proxy handler for forwarding browser calls to the Runflow API with your secret key server-side.

Quick start

Embed Studio on your site (the 3-line integration):

bun add @runflow-io/studio @runflow-io/proxy

// app/api/runflow/[...path]/route.ts (Next.js App Router)
import { runflowProxy } from "@runflow-io/proxy";
export const { GET, POST } = runflowProxy({ apiKey: process.env.RUNFLOW_API_KEY! });

<div id="studio"></div>
<script type="module">
  import { mount } from "@runflow-io/studio";
  mount("#studio");
</script>

Repository layout

runflow-js/
├── packages/
│   ├── sdk/         → @runflow-io/sdk
│   ├── studio/      → @runflow-io/studio
│   └── proxy/       → @runflow-io/proxy
├── examples/
│   └── e2e-proof/                end-to-end integration test
└── tooling/
    └── tsconfig/                 shared TS presets

Development

bun install
bun run build      # build all packages
bun run test       # run all tests
bun run typecheck  # type-check all packages
bun run lint       # biome check

Add a changeset for every user-visible change:

bun changeset

License

MIT