ShareOut SDK

The browser SDK for ShareOut — the agentic publishing platform that turns ideas, data and reports into living web pages.

Use it inside a published ShareOut artifact to read and write data, sync in real time, store files, send email, and connect live data sources. The SDK auto-initializes inside an artifact, so your page can persist and collaborate with no backend of your own.

Install

The SDK is served live from ShareOut — no build step needed inside an artifact:

<script src="https://shareout.site/sdk/shareout.js"></script>

Or install the package to develop and type-check locally:

npm install @shareout/sdk

Quick start

const so = await ShareOut.create();

// Key–value JSON
await so.json.set('settings', { theme: 'dark' });
const settings = await so.json.get('settings');

// Tables
await so.table('tasks').insert({ title: 'Ship it', done: false });
const tasks = await so.table('tasks').all();

// Real-time collaboration (Y.js)
const doc = so.realtime('board');

Data stores

Store	What it does
so.json	Key–value JSON persistence
so.table(name)	Structured rows with query + editable grids
so.realtime(name)	Live collaborative documents (Y.js)
so.blobs	File / blob storage
so.email	Send email from an artifact
so.comments(name)	Threaded comments
so.sources	Connect live data (Sheets, Snowflake, Shopify, BigQuery and more)

See the full reference in the ShareOut Skill docs and at docs.shareout.site.

Develop

npm install
npm test          # vitest
npm run build     # tsup → cjs / esm / iife
npm run typecheck

License

MIT © ShareOut