Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bitfield.so/llms.txt

Use this file to discover all available pages before exploring further.

Quickstart

​
Get from key to first call.

This is the short path. Get your key, activate a device, add Runtime Kit, then use the public app-facing surface.

​
1. Get your key

Start at Get your key. Your account portal is where you confirm your email, get access, manage active devices, and replace a device when you need to move a spot.

​
2. Add Runtime Kit

Runtime Kit is the customer-facing package that app code talks to. Your account portal gives the current install instructions for your account and environment.The public JavaScript surface is intentionally small:
import { sendRequestToBitfieldTarget } from '@bitfield/runtime-kit';
import { useBitfieldData } from '@bitfield/runtime-kit/react';

​
3. Read data in React

useBitfieldData(...) reads materialized data that Runtime Kit has already made available to your app.
import { useBitfieldData } from '@bitfield/runtime-kit/react';

export function InboxCount() {
  const inbox = useBitfieldData<{ id: string }[]>('inbox');

  if (inbox.loading) return <span>Loading</span>;
  if (inbox.error) return <span>Could not read inbox</span>;

  return <strong>{inbox.data?.length ?? 0}</strong>;
}

​
4. Send a request

sendRequestToBitfieldTarget(...) sends opaque request data to a Bitfield target and returns the reply. Your app does not need to know how the target is mounted.
import { sendRequestToBitfieldTarget } from '@bitfield/runtime-kit';

const reply = await sendRequestToBitfieldTarget({
  target,
  payload,
});
The app surface stays boring on purpose. The product can gain new storage paths, packages, devices, or slots without making every React component learn a new API.
Last modified on May 9, 2026