Bitfield Docs

Bitfield is a plug-in runtime and database for founders who want their product to get huge and cannot afford to slow down when plans change.

Start here if you are trying to decide what Bitfield is, whether to try it, or what to build first. The best path is not to read every page in order. Pick the job you have right now.

Understand it, try it, build a first screen, check proof, or manage access.

→

Use the page that matches your job instead of hunting through the whole docs tree.

→

Move into Runtime Kit, Build, Activation, Concepts, or Proof after the first result is clear.

Pick the page that matches the job in front of you. Each path says what it helps you do next.

Choose your path

I am curious. Start with What is Bitfield?. You will get the product model before seeing code.

I want to try it. Start with Get your key, then open Quickstart.

I want the first visible result. Use Quickstart. It shows the read hook, request function, expected result, and first failures.

I want to build a real screen. Use Package to screen, then copy a Runtime Kit Cookbook recipe.

I want to check the speed claim. Start with How Bitfield is this fast, then read the Benchmark ledger.

What Bitfield does for your first product

Bitfield gives your product one durable place to store what happened and one runtime that can load the pieces you plug in around it. You can start small, add more later, and keep the structure from turning into a pile of direct dependencies.The first product path looks like this:

Step	You do	Bitfield gives you
Account	Create an account and get key access.	A customer-owned activation path for your devices.
Runtime Kit	Add the public Runtime Kit surface.	One read hook and one request function for app code.
Package	Declare records, package-owned bytes, or callable targets.	A boundary around the product pieces you want to plug in.
Surface	Render prepared data and send named requests.	A screen that can grow without importing private package setup.
Device	Activate the devices you actually use.	A way to run locally without treating every install like a new product.

Common first wrong turns

Wrong turn	Why it hurts	Go here instead
Reading only the proof pages first	You see numbers before the product model	What is Bitfield?
Starting in API reference	You see exact facts before the first journey	Quickstart
Building a custom shell first	You skip the public Runtime Kit path	Package to screen
Guessing how devices work	Account access and active devices get confused	Get your key

New to Bitfield: What is Bitfield?
Ready to try it: Get your key
Ready to make the first app call: Quickstart
Want a complete Runtime Kit example: Runtime Kit Cookbook
Need to understand pricing words: Active devices
Checking the speed claim: How Bitfield is this fast

Get moving

Understand

Bitfield Docs

Choose your path

What Bitfield does for your first product

Common first wrong turns

Next

​Choose your path

​What Bitfield does for your first product

​Common first wrong turns

​Next

Choose your path

What Bitfield does for your first product

Common first wrong turns

Next