Package Exports
- @abide/abide/build
- @abide/abide/bundle/BundleMenu
- @abide/abide/bundle/BundleMenuItem
- @abide/abide/bundle/BundleWindow
- @abide/abide/bundle/bundled
- @abide/abide/bundle/onMenu
- @abide/abide/compile
- @abide/abide/mcp/createMcpServer
- @abide/abide/preload
- @abide/abide/resolver-plugin
- @abide/abide/server/AppModule
- @abide/abide/server/DELETE
- @abide/abide/server/GET
- @abide/abide/server/HEAD
- @abide/abide/server/InspectorContext
- @abide/abide/server/PATCH
- @abide/abide/server/POST
- @abide/abide/server/PUT
- @abide/abide/server/agent
- @abide/abide/server/appDataDir
- @abide/abide/server/cookies
- @abide/abide/server/env
- @abide/abide/server/error
- @abide/abide/server/json
- @abide/abide/server/jsonl
- @abide/abide/server/prompts/definePrompt
- @abide/abide/server/prompts/renderPromptTemplate
- @abide/abide/server/reachable
- @abide/abide/server/redirect
- @abide/abide/server/request
- @abide/abide/server/rpc/defineVerb
- @abide/abide/server/server
- @abide/abide/server/socket
- @abide/abide/server/sockets/defineSocket
- @abide/abide/server/sse
- @abide/abide/shared/HttpError
- @abide/abide/shared/cache
- @abide/abide/shared/createSubscriber
- @abide/abide/shared/health
- @abide/abide/shared/html
- @abide/abide/shared/log
- @abide/abide/shared/online
- @abide/abide/shared/page
- @abide/abide/shared/pending
- @abide/abide/shared/refreshing
- @abide/abide/shared/snippet
- @abide/abide/shared/trace
- @abide/abide/shared/url
- @abide/abide/shared/withJsonSchema
- @abide/abide/test/assertAgentFrameConformance
- @abide/abide/test/createScriptedSurface
- @abide/abide/test/createTestApp
- @abide/abide/tsconfig
- @abide/abide/ui-plugin
- @abide/abide/ui/dom/anchorCursor
- @abide/abide/ui/dom/appendSnippet
- @abide/abide/ui/dom/appendStatic
- @abide/abide/ui/dom/appendText
- @abide/abide/ui/dom/appendTextAt
- @abide/abide/ui/dom/applyResolved
- @abide/abide/ui/dom/attach
- @abide/abide/ui/dom/attr
- @abide/abide/ui/dom/awaitBlock
- @abide/abide/ui/dom/cloneStatic
- @abide/abide/ui/dom/each
- @abide/abide/ui/dom/eachAsync
- @abide/abide/ui/dom/hydrate
- @abide/abide/ui/dom/mount
- @abide/abide/ui/dom/mountChild
- @abide/abide/ui/dom/mountSlot
- @abide/abide/ui/dom/on
- @abide/abide/ui/dom/skeleton
- @abide/abide/ui/dom/switchBlock
- @abide/abide/ui/dom/text
- @abide/abide/ui/dom/tryBlock
- @abide/abide/ui/dom/when
- @abide/abide/ui/effect
- @abide/abide/ui/enterScope
- @abide/abide/ui/exitScope
- @abide/abide/ui/navigate
- @abide/abide/ui/outbox
- @abide/abide/ui/remoteProxy
- @abide/abide/ui/renderToStream
- @abide/abide/ui/router
- @abide/abide/ui/runtime/enterRenderPass
- @abide/abide/ui/runtime/exitRenderPass
- @abide/abide/ui/runtime/nextBlockId
- @abide/abide/ui/scope
- @abide/abide/ui/socketProxy
- @abide/abide/ui/startClient
- @abide/abide/ui/tail
Readme
abide
Write one function. Get a typed HTTP endpoint, a CLI, an MCP tool, and an OpenAPI operation — from the same line of code.
abide is a type-safe isomorphic framework built on web standards and Bun. You declare a verb once; the bundler swaps the runtime per side and projects that one declaration onto every surface — humans hit it over HTTP or the CLI, machines hit it over MCP, and you control which surfaces each verb exposes. It's a framework built for humans and machines.
- Zero runtime dependencies
- A single runtime (Bun) in every mode — dev, build, and compiled binary
Quick start
bunx abide scaffold my-app # scaffolds, installs, and starts the dev serverTo see every surface live, clone the repo and run the kitchen-sink example — each page is runnable and documented:
git clone https://github.com/briancray/abide
cd abide && bun install
cd examples/kitchen-sink && bun run devRPCs
An RPC is a handler wrapped by its HTTP method — one export per file under src/server/rpc/. The file path is the URL; the schema validates args and projects the MCP tool, CLI flags, and OpenAPI operation. Standard Schema is the contract: zod, valibot, and arktype work unadapted.
// src/server/rpc/getMessages.ts
import { GET } from '@abide/abide/server/GET'
import { json } from '@abide/abide/server/json'
import { z } from 'zod'
// query args arrive as strings — coerce in the schema
const inputSchema = z.object({ room: z.string(), limit: z.coerce.number().default(50) })
export const getMessages = GET(
async ({ room, limit }) => json(await db.recentMessages(room, limit)),
{ inputSchema },
)One declared verb fans out to every surface — this is the whole premise:
export const getMessages = GET(fn, { inputSchema })
│
┌───────────────┬────────────┼──────────────┬────────────────┐
SSR call browser fetch MCP tool CLI subcommand OpenAPI op
cache(fn)() fetch /rpc/... getMessages app get-messages /openapi.json
(in-process) (typed proxy) (read-only+schema) (schema→flags) (described)The same callable is consumed differently per side — cache(getMessages)({ room }) in-process, the swapped fetch in the browser, .raw(args) for a Response, .stream(args) for tail(). A schema gates the machine surfaces: it unlocks the CLI and (for read-only verbs) MCP; a mutating verb never auto-exposes to MCP — it needs an explicit clients: { mcp: true }. Per-verb timeout (504, on every surface) is distinct from the client-side ABIDE_CLIENT_TIMEOUT.
Query args travel as strings — use
z.coerce.*so numbers and booleans validate.
Sockets
One broadcast topic per file under src/server/sockets/. A Socket<T> is an isomorphic AsyncIterable<T> — every socket multiplexes onto one ws at /__abide/sockets. A schema validates publishes, infers the frame type, and flips on the MCP/CLI read faces.
// src/server/sockets/chat.ts
import { socket } from '@abide/abide/server/socket'
import { z } from 'zod'
const schema = z.object({ id: z.string(), from: z.string(), text: z.string(), at: z.number() })
// retain the last 100 frames, evict any older than an hour
export const chat = socket({ schema, tail: 100, ttl: 3_600_000 })
export type ChatMessage = z.infer<typeof schema>For clients that can't speak the ws multiplex, each socket has an HTTP face at /__abide/sockets/<name> — GET returns the retained tail, POST publishes (gated by clientPublish, off by default).
Components
Components are .abide files — valid HTML with <script>, native <template> control flow, {expr} bindings, and a component-scoped <style>. Reactive state is reached through scope() (scope().state(v), scope().computed(fn)); prop and effect are in scope without import. This page reads the verb above through cache(), tails the socket live, and exercises most of the template grammar:
<script>
import { cache } from '@abide/abide/shared/cache'
import { tail } from '@abide/abide/ui/tail'
import { getMessages } from '$server/rpc/getMessages.ts'
import { publishChat } from '$server/rpc/publishChat.ts'
import { chat } from '$server/sockets/chat.ts'
import Avatar from '$ui/Avatar.abide'
let room = prop('room') // typed via src/.abide/routes.d.ts
const history = scope().computed(() => cache(getMessages)({ room })) // SSR snapshot + reactive refetch
const latest = scope().computed(() => tail(chat)) // re-renders on every new frame
let from = scope().state('alice')
let text = scope().state('')
let filter = scope().state('all') // all | mine | others
let onlyUnread = scope().state(false)
async function send(event: SubmitEvent) {
event.preventDefault()
if (text.trim() === '') return
await publishChat({ from, text }) // server validates, then broadcasts
text = ''
}
</script>
<template name="message" args={m}> <!-- snippet: a reusable builder -->
<li class="row"><Avatar name={m.from} /> <strong>{m.from}</strong>: {m.text}</li>
</template>
<form onsubmit={send}>
<input bind:value={from} placeholder="you" />
<input bind:value={text} placeholder="say something…" />
<label><input type="checkbox" bind:checked={onlyUnread} /> unread only</label>
<fieldset>
<label><input type="radio" bind:group={filter} value="all" /> all</label>
<label><input type="radio" bind:group={filter} value="mine" /> mine</label>
</fieldset>
<button type="submit" disabled={text.trim() === ''}>send</button>
</form>
<template if={latest}>
<p class="ping">latest from <strong>{latest.from}</strong></p>
<template else>
<p class="ping muted">no live messages yet</p>
</template>
</template>
<template switch={filter}>
<template case={'mine'}><p>showing your messages</p></template>
<template default><p>showing every message</p></template>
</template>
<template await={history}>
<p>loading history…</p>
<template then="messages">
<ul>
<template each={messages} as="m" key="m.id">
{message(m)} <!-- render the snippet -->
</template>
</ul>
</template>
<template catch="err">
<p class="error">{err.message}</p>
</template>
</template>
<style>
.row { display: flex; gap: 0.5rem; }
.muted { color: #94a3b8; }
.error { color: #dc2626; }
</style>MIT