{"id":30009742,"url":"https://github.com/ethersync/ethersync","last_synced_at":"2025-10-20T20:50:39.711Z","repository":{"id":217897009,"uuid":"745032548","full_name":"ethersync/ethersync","owner":"ethersync","description":"Editor-agnostic, real-time collaborative editing of local text files.","archived":false,"fork":false,"pushed_at":"2025-07-27T13:35:14.000Z","size":2523,"stargazers_count":392,"open_issues_count":80,"forks_count":12,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-07-27T14:17:55.399Z","etag":null,"topics":["automerge","collaboration","collaborative-editing","crdt","local-first","peer-to-peer","plugin","synchronization"],"latest_commit_sha":null,"homepage":"https://ethersync.github.io/ethersync/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethersync.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-01-18T14:06:09.000Z","updated_at":"2025-07-27T03:31:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"e2841e79-8b5b-4d06-99cd-19241c7b1a57","html_url":"https://github.com/ethersync/ethersync","commit_stats":null,"previous_names":["ethersync/ethersync"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/ethersync/ethersync","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersync%2Fethersync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersync%2Fethersync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersync%2Fethersync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersync%2Fethersync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethersync","download_url":"https://codeload.github.com/ethersync/ethersync/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersync%2Fethersync/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268883500,"owners_count":24323148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-05T02:00:12.334Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automerge","collaboration","collaborative-editing","crdt","local-first","peer-to-peer","plugin","synchronization"],"created_at":"2025-08-05T11:02:32.589Z","updated_at":"2025-10-20T20:50:39.690Z","avatar_url":"https://github.com/ethersync.png","language":"Rust","funding_links":[],"categories":["Collaboration","Rust"],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: 2024 blinry \u003cmail@blinry.org\u003e\nSPDX-FileCopyrightText: 2024 zormit \u003cnt4u@kpvn.de\u003e\n\nSPDX-License-Identifier: CC-BY-SA-4.0\n--\u003e\n\n# 🍃 Ethersync\n\n*Multiplayer mode for your text editor!*\n\nEthersync enables real-time collaborative editing of local text files. You can use it for pair programming or note-taking, for example. It's the missing real-time complement to Git!\n\n![Demo video for how to make a connection and of collaborating in Neovim](https://files.blinry.org/ethersync-share-join-demo.gif)\n\n## Features\n\n- 👥 Edit files at the same time, across different text editors\n- 📍 See your peers' cursors and selections\n- 🗃️ Work on entire projects, the way you're used to\n- 🔒 Encrypted peer-to-peer connections, no need for a server\n- ✒️ Local-first: You always have full access, even offline\n- 🧩 [Simple JSON-RPC protocol](https://ethersync.github.io/ethersync/editor-plugin-dev-guide.html) for writing new editor plugins\n\n## What Ethersync is not\n\nWe are not a company, and don't sell anything. We don't require you to create an account. We don't have access to your data, and don't use it to train AI algorithms. We don't serve you ads, and don't track you.\n\nWe're just a bunch of people building something we want to see in the world.\n\n## 🚦 Project status\n\nThe project is under active development right now. We use it every day, but there's still some [bugs](https://github.com/ethersync/ethersync/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+%28label%3Abug+OR+type%3ABug%29) to be aware of.\n\n## 📥 Installation\n\n### 1. Install the `ethersync` command\n\nEthersync works on Linux, macOS, Android, and on the Windows Subsystem for Linux.\n\n\u003cdetails\u003e\n\u003csummary\u003eBinary releases\u003c/summary\u003e\n\nThe [releases on GitHub](https://github.com/ethersync/ethersync/releases/latest) come with precompiled static binaries. Download one and put it somewhere in your shell's [`PATH`](https://en.wikipedia.org/wiki/PATH_(variable)):\n\n- `x86_64-unknown-linux-musl` for Linux\n- `universal-apple-darwin` for macOS\n- `aarch64-unknown-linux-musl` for Android (use a terminal emulator like [Termux](https://termux.dev))\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eArch Linux\u003c/summary\u003e\n\n```\nsudo pacman -S ethersync\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eNix\u003c/summary\u003e\n\nTo put `ethersync` in your PATH temporarily, run:\n\n```\nnix shell nixpkgs#ethersync\n```\n\nMake sure to also have it in your PATH when you run the editors, or install it to your environment in your preferred way.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eVia Cargo\u003c/summary\u003e\n\n```bash\ncargo install ethersync\n```\n\u003c/details\u003e\n\n### 2. Install an editor plugin\n\n- [Neovim](https://github.com/ethersync/ethersync-nvim)\n- VS Code/Codium: Install the \"Ethersync\" extension from the marketplace\n\n## 📖 Basic usage\n\nIn the directory you want to share:\n\n```\n$ ethersync share\n\n    To connect to you, another person can run:\n\n    ethersync join 5-hamburger-endorse\n\nPeer connected: adfa90edd932732ddf242f24dc2dcd6156779e69966d432fcb3b9fe3ae9831ab\n```\n\nAnother person, in a separate directory (also works on the same computer):\n\n```\n$ ethersync join 5-hamburger-endorse\n\nDerived peer from join code. Storing in config (overwriting previous config).\nStoring peer's address in .ethersync/config.\nConnected to peer: 5e6b787fff79074735eb9b56939269100de1e37bc7f7a4d29c277cc24f7ee53d\n```\n\nThe directories are now connected, and changes will be synced instantly. You can open text files (using editors with an Ethersync plugin), and start collaborating in real time! :sparkles:\n\n## 🎓 Learn more\n\n- Learn more about Ethersync in [the documentation](https://ethersync.github.io/ethersync).\n- Watch a [10-minute talk](https://fosdem.org/2025/schedule/event/fosdem-2025-4890-ethersync-real-time-collaboration-in-your-text-editor-/) given at FOSDEM 2025.\n- Watch a (German) [1-hour talk](https://media.ccc.de/v/2024-355-ethersync-echtzeit-kollaboration-in-deinem-texteditor-) given at MRMCD 2024.\n\n## 🚧 Community projects\n\n(These are all work-in-progress!)\n\n- @schrieveslaach's [Jetbrains plugin](https://github.com/ethersync/ethersync-jetbrains)\n- @sohalt's [Emacs plugin](https://github.com/sohalt/ethersync.el)\n- @winniehell's [web editor](https://github.com/ethersync/ethersync-web)\n\n## 🔨 Contributing\n\nWe'd love to receive your patches and other contributions! Small patches are very welcome as PRs. Before starting to implement a new big feature, please briefly [check in with us](#contact) so we can discuss how it fits in with our ideas for the project.\n\nIf you're interested in building new editor plugins, read the [editor plugin development guide](https://ethersync.github.io/ethersync/editor-plugin-dev-guide).\nFor more information about Ethersync's design, refer to the list of [decision records](docs/decisions/).\n\nIf you find bugs, please [open an issue](https://github.com/ethersync/ethersync/issues) on Github!\n\n## ☎️ Contact\n\nFeel free to [open a discussion on Github](https://github.com/ethersync/ethersync/discussions) to ask us anything! Other good channels:\n\n- Mastodon: [@ethersync@fosstodon.org](https://fosstodon.org/@ethersync)\n- Email: \u003cspan\u003ee\u003cspan title=\"ihate@spam.com\u0026lt;/span\u0026gt;\"\u003et\u003c/span\u003ehersync\u003c/span\u003e@zormit\u003ci title=\"\u0026lt;/i\u0026gt;mailto:\"\u003e.\u003c/i\u003ede\n\n## 💚 Thanks\n\nEthersync received funding from [NLNet](https://nlnet.nl)'s [NGI0 Core Fund](https://nlnet.nl/core/) throughout 2024.\n\nThanks to the [Prototype Fund](https://www.prototypefund.de/) and the [Federal Ministry of Research, Technology and Space](https://www.bmbf.de/EN/) for funding this project in 2025.\n\n\u003ca href=\"https://nlnet.nl/\"\u003e\u003cimg src=\"https://upload.wikimedia.org/wikipedia/en/a/a4/NLnet_Foundation_logo.svg\" alt=\"Logo of the NLnet Foundation\" style=\"height: 70px;\"\u003e\u003c/a\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n\u003ca href=\"https://prototypefund.de/en/\"\u003e\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/b/ba/Prototype_Fund_Logo_2025.svg\" alt=\"Logo of the Prototype Fund\" style=\"height: 70px;\"\u003e\u003c/a\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n\u003ca href=\"https://okfn.de/en/\"\u003e\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/4/4d/Open_Knowledge_Foundation_Deutschland_Logo.svg\" alt=\"Logo of the Open Knowledge Foundation Germany\" style=\"height: 100px;\"\u003e\u003c/a\u003e\n\u0026nbsp;\u0026nbsp;\n\u003ca href=\"https://www.bmbf.de/EN/\"\u003e\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/d/df/BMFTR_Logo.svg\" alt=\"Logo of the German Federal Ministry of Research, Technology and Space\" style=\"height: 110px;\"\u003e\u003c/a\u003e\n\nEthersync is based on [Automerge](https://automerge.org), [Iroh](https://www.iroh.computer), and [Magic Wormhole](https://magic-wormhole.readthedocs.io).\n\nAnd finally, thanks to everyone who helped us beta-test, or reported issues!\n\n## 📜 License\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\n\nThis project is [REUSE](https://reuse.software) compliant, see the headers of each file for licensing information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersync%2Fethersync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethersync%2Fethersync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersync%2Fethersync/lists"}