stable

Start here

Install, create a vault, opt into your first service.

Reading this on GitHub? The links below are site paths and resolve only on the hosted docs — read these pages at noy-db.lanna.ai/start.

Four steps to a running, encrypted, zero-knowledge document store — proof included:

  1. Install — npm create noy-db@latest, or add @noy-db/hub by hand and create your first Noydb instance. No storage backend required to start.
  2. Your first vault — open a vault, create a typed collection, put a record, and run a basic query.
  3. Your first service — opt into one with*() service (history) and see what it adds.
  4. See the ciphertext — persist to disk and open the stored file: the store holds only ciphertext.

Once you've got a vault running, jump into the Orientation map to pick the rest of the capabilities your app needs and land on the exact pages for them.