14.7K ·GitHub
What is this?
Automerge is a JavaScript library implementing a CRDT (Conflict-free Replicated Data Type) — a JSON-like document that multiple users can edit concurrently on their own copies, with all changes merging back together automatically without conflicts.
Automerge is a JavaScript library implementing a CRDT (Conflict-free Replicated Data Type) — a JSON-like document that multiple users can edit concurrently on their own copies, with all changes merging back together automatically without conflicts.How do I add it to my project?Install it with `npm install automerge` or `yarn add automerge`, then `require('automerge')` (or `import Automerge from 'automerge'` with ES2015/TypeScript). To work from source instead, clone the repo and run `yarn install`, `yarn test`, and `yarn build` to get a browser bundle in `dist/automerge.js`.
Install it with `npm install automerge` or `yarn add automerge`, then `require('automerge')` (or `import Automerge from 'automerge'` with ES2015/TypeScript). To work from source instead, clone the repo and run `yarn install`, `yarn test`, and `yarn build` to get a browser bundle in `dist/automerge.js`.Does it need any backend server or database to work?No — it's a pure client-side JavaScript library with no server requirement, only pulling in small helper packages (fast-sha256, pako, uuid) for hashing and compression.
No — it's a pure client-side JavaScript library with no server requirement, only pulling in small helper packages (fast-sha256, pako, uuid) for hashing and compression.Is this the version I should actually use today?No — this repo is deprecated. It was the original pure-JavaScript implementation, but all development has moved to a new Rust-based implementation that's easier to port to other platforms.
No — this repo is deprecated. It was the original pure-JavaScript implementation, but all development has moved to a new Rust-based implementation that's easier to port to other platforms.Does it work without a network connection?Yes — it's built offline-first: each user can keep editing their own local copy with no connectivity, and merges happen automatically once copies are synced back together.
Yes — it's built offline-first: each user can keep editing their own local copy with no connectivity, and merges happen automatically once copies are synced back together.What makes Automerge different from manually resolving merge conflicts?As a CRDT, its data structure is designed so concurrent edits always merge deterministically and automatically — there's no manual conflict resolution step needed, unlike regular merge tools.
As a CRDT, its data structure is designed so concurrent edits always merge deterministically and automatically — there's no manual conflict resolution step needed, unlike regular merge tools.Can I use TypeScript with Automerge?Yes — type definitions are bundled (`@types/automerge`), and the separate automerge-repo project provides a fuller set of TypeScript examples built on the newer implementation.
Yes — type definitions are bundled (`@types/automerge`), and the separate automerge-repo project provides a fuller set of TypeScript examples built on the newer implementation.Where should I look instead of this repo?The actively maintained successor is the Rust-based implementation at automerge.org, along with the automerge-repo project; this classic repo is kept around only for reference.
The actively maintained successor is the Rust-based implementation at automerge.org, along with the automerge-repo project; this classic repo is kept around only for reference.Which topics is it in?crdt, sync, webpack, concurrency, data-structures, offline-first, collaboration, json, distributed-systems, deprecated, local-first, npm
crdt, sync, webpack, concurrency, data-structures, offline-first, collaboration, json, distributed-systems, deprecated, local-first, npm