Quickstart

Quickstart

Five minutes from nothing to a live subscription. Every path below drives the same local HTTP server; pick the client you will actually use.

The shape of every quickstart

any init  ──▶  any run  ──▶  POST /v1/spaces  ──▶  POST …/objects  ──▶  POST …/objects/query  ──▶  POST …/objects/query/subscribe
 (account)     (server)      (a space)             (an object)          (a snapshot)               (snapshot + live deltas)

1. Install the binary and create an account. The mnemonic prints once — back it up.
2. Run the server: any run listens on http://127.0.0.1:7001.
3. Create a space — the unit of sharing and encryption.
4. Create an object with a type bound and a name.
5. Query the space's objects collection — an indexed read on your disk.
6. Subscribe — the same query, plus added / updated / removed frames over SSE for as long as the connection is open.

Everything you write is on your machine the moment the request returns; sync to other devices and members happens in the background (Local-first).

Before you start

any init                     # prints the mnemonic to stderr — save it
any run                      # foreground; leave it running in this terminal
any status                   # in another terminal: {"status":"ok", …}

Note. A binary with no network configured joins the production any-sync network. To experiment without touching it, point ANY_NETWORK_NODECONF_PATH at a staging or local nodeconf first — see Networks.

Pick a client