nooklet

Docs

Start with the first page and read down, or jump to the part you need. Press / to search.

  1. What nooklet is

    A local-first outliner in the spirit of Logseq, built so AI agents can read and write your notes properly.

  2. Features

    A tour of what nooklet does today, with partial and missing pieces marked.

  3. How it works

    SQLite on every device, an append-only op log with hybrid logical clocks, last-writer-wins fields, fractional ordering, and a markdown mirror.

  4. Importing from Logseq

    Bring a Logseq graph into nooklet, from either the classic file-based Logseq or the newer database (DB) version, and what carries over from each.

  5. Sync, offline and conflicts

    What happens when a device goes offline, what the sync indicator means, how conflicts resolve, and how local-only and multiple graphs work.

  6. Getting started

    Download or build nooklet, run a server, open the web, desktop, iOS and experimental Android apps, and pair devices with tokens or a pairing link.

  7. Self-hosting

    Run the nooklet server behind Tailscale (recommended), in Docker or Kubernetes, or behind a public reverse proxy; back it up, upgrade it, and add semantic search with Ollama.

  8. Build and install nooklet on your iPhone

    Build nooklet with Xcode and install it on your own iPhone with a free Apple ID, connect it to your server, and debug it with Safari's Web Inspector.

  9. Security model

    What nooklet protects against, how tokens and scopes work, what the server trusts, and the recommended deployment.

  10. For AI agents

    Connect Claude Code, Cursor or any MCP client to nooklet, or call the HTTP API directly. Tools, tokens, the outline format and a worked example.

  11. Building from source and the toolchain

    The toolchain, the monorepo map, every build command and what it produces, the test layers, CI, and fixes for the build problems people have hit.

  12. FAQ and troubleshooting

    Fixes for the problems people hit in real testing, from secure-context errors and Host 403s to the iOS local-network prompt.