{ "slug": "persist/quickstart", "title": "Persist Quickstart", "description": "Install the Persist SDK and create your first store in under a minute.", "url": "https://cuitty.com/docs/persist/quickstart", "markdown_url": "https://cuitty.com/docs/persist/quickstart.md", "json_url": "https://cuitty.com/docs/persist/quickstart.json", "frontmatter": { "title": "Persist Quickstart", "description": "Install the Persist SDK and create your first store in under a minute.", "order": 1, "section": "Persist", "updatedAt": "2026-05-12" }, "headings": [ { "depth": 1, "slug": "persist-quickstart", "text": "Persist Quickstart" }, { "depth": 2, "slug": "install", "text": "Install" }, { "depth": 2, "slug": "create-a-store", "text": "Create a store" }, { "depth": 2, "slug": "basic-crud", "text": "Basic CRUD" }, { "depth": 2, "slug": "enable-sync", "text": "Enable sync" }, { "depth": 2, "slug": "enable-encryption", "text": "Enable encryption" } ], "body_markdown": "# Persist Quickstart\n\n## Install\n\n```bash\n# npm\nnpm install @cuitty/persist\n\n# bun\nbun add @cuitty/persist\n\n# pnpm\npnpm add @cuitty/persist\n```\n\n## Create a store\n\n```ts\nimport { createStore } from \"@cuitty/persist\";\n\nconst store = await createStore({\n name: \"my-app\",\n adapter: \"sqlite\",\n path: \"./data/my-app.db\",\n});\n```\n\n## Basic CRUD\n\n```ts\n// Put a record\nawait store.records.put(\"users/alice\", {\n name: \"Alice\",\n role: \"admin\",\n});\n\n// Get a record\nconst alice = await store.records.get(\"users/alice\");\n\n// List records by prefix\nconst users = await store.records.list(\"users/\");\n\n// Delete a record\nawait store.records.delete(\"users/alice\");\n```\n\n## Enable sync\n\nAdd a `sync` block to push local writes to a remote backend automatically. Writes never block -- sync runs in the background.\n\n```ts\nconst store = await createStore({\n name: \"my-app\",\n adapter: \"sqlite\",\n path: \"./data/my-app.db\",\n sync: {\n remote: \"postgres\",\n strategy: \"last-write-wins\",\n },\n});\n```\n\nSee [Sync & Conflict Resolution](/docs/persist/sync) for strategies and conflict handling.\n\n## Enable encryption\n\nSet `encrypt: true` to encrypt all data before it leaves the device. The sync server never sees plaintext.\n\n```ts\nconst store = await createStore({\n name: \"my-app\",\n adapter: \"sqlite\",\n path: \"./data/my-app.db\",\n encrypt: true,\n sync: {\n remote: \"postgres\",\n strategy: \"last-write-wins\",\n },\n});\n```\n\nSee [End-to-End Encryption](/docs/persist/encryption) for key management and zero-knowledge architecture.", "body_html": "

Persist Quickstart

\n

Install

\n
# npm\nnpm install @cuitty/persist\n\n# bun\nbun add @cuitty/persist\n\n# pnpm\npnpm add @cuitty/persist
\n

Create a store

\n
import { createStore } from \"@cuitty/persist\";\n\nconst store = await createStore({\n  name: \"my-app\",\n  adapter: \"sqlite\",\n  path: \"./data/my-app.db\",\n});
\n

Basic CRUD

\n
// Put a record\nawait store.records.put(\"users/alice\", {\n  name: \"Alice\",\n  role: \"admin\",\n});\n\n// Get a record\nconst alice = await store.records.get(\"users/alice\");\n\n// List records by prefix\nconst users = await store.records.list(\"users/\");\n\n// Delete a record\nawait store.records.delete(\"users/alice\");
\n

Enable sync

\n

Add a sync block to push local writes to a remote backend automatically. Writes never block — sync runs in the background.

\n
const store = await createStore({\n  name: \"my-app\",\n  adapter: \"sqlite\",\n  path: \"./data/my-app.db\",\n  sync: {\n    remote: \"postgres\",\n    strategy: \"last-write-wins\",\n  },\n});
\n

See Sync & Conflict Resolution for strategies and conflict handling.

\n

Enable encryption

\n

Set encrypt: true to encrypt all data before it leaves the device. The sync server never sees plaintext.

\n
const store = await createStore({\n  name: \"my-app\",\n  adapter: \"sqlite\",\n  path: \"./data/my-app.db\",\n  encrypt: true,\n  sync: {\n    remote: \"postgres\",\n    strategy: \"last-write-wins\",\n  },\n});
\n

See End-to-End Encryption for key management and zero-knowledge architecture.

", "links_out": [ "/docs/persist/sync", "/docs/persist/encryption" ] }