https://github.com/teamtype/teamtype
Peer-to-peer, editor-agnostic collaborative editing of local text files.
https://github.com/teamtype/teamtype
automerge collaboration collaborative-editing crdt local-first peer-to-peer plugin synchronization
Last synced: 2 months ago
JSON representation
Peer-to-peer, editor-agnostic collaborative editing of local text files.
- Host: GitHub
- URL: https://github.com/teamtype/teamtype
- Owner: teamtype
- License: agpl-3.0
- Created: 2024-01-18T14:06:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-29T17:36:54.000Z (2 months ago)
- Last Synced: 2026-03-29T19:34:42.029Z (2 months ago)
- Topics: automerge, collaboration, collaborative-editing, crdt, local-first, peer-to-peer, plugin, synchronization
- Language: Rust
- Homepage: https://teamtype.github.io/teamtype/
- Size: 3.29 MB
- Stars: 1,762
- Watchers: 13
- Forks: 45
- Open Issues: 102
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-iroh - Teamtype - Editor-agnostic, real-time collaborative editing of local text files. (Collaboration and Productivity)
README
*Multiplayer mode for your text editor!*
> [!NOTE]
> This project used to be called "Ethersync" until October 2025. See [this PR](https://github.com/teamtype/teamtype/pull/436) for our motivation.
Teamtype 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!
## Features
- 👥 Edit files at the same time, across different text editors
- 📍 See your peers' cursors and selections
- 🗃️ Work on entire projects, the way you're used to
- 🔒 Encrypted peer-to-peer connections, no need for a server
- ✒️ Local-first: You always have full access, even offline
- 🧩 [Simple JSON-RPC protocol](https://teamtype.github.io/teamtype/editor-plugin-dev-guide.html) for writing new editor plugins
We also maintain a list of [other collaborative text-editing software](https://teamtype.github.io/teamtype/related-projects.html).
## What Teamtype is not
We 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.
We're just a bunch of people building something we want to see in the world.
## 🚦 Project status
We're currently maintaining Teamtype in our free time. We're often using it for pair programming ourselves, but there's still some [bugs](https://github.com/teamtype/teamtype/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+%28label%3Abug+OR+type%3ABug%29) to be aware of.
## 📥 Installation
### 1. Install the `teamtype` command
Teamtype works on Linux, macOS, Android, and on the Windows Subsystem for Linux.
Binary releases
The [releases on GitHub](https://github.com/teamtype/teamtype/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)):
- `x86_64-unknown-linux-musl` for Linux
- `universal-apple-darwin` for macOS
- `aarch64-unknown-linux-musl` for Android (use a terminal emulator like [Termux](https://termux.dev))
Arch Linux
```
sudo pacman -S teamtype
```
Homebrew
```
brew install teamtype
```
Nix
To put `teamtype` in your PATH temporarily, run:
```
nix shell nixpkgs#teamtype
```
Make sure to also have it in your PATH when you run the editors, or install it to your environment in your preferred way.
Via Cargo
```bash
cargo install --locked teamtype
```
### 2. Install an editor plugin
- [Neovim](https://github.com/teamtype/teamtype-nvim)
- VS Code/Codium: Install the "Teamtype" extension from the marketplace
## 📖 Basic usage
In the directory you want to share:
```
$ teamtype share
To connect to you, another person can run:
teamtype join 5-hamburger-endorse
Peer connected: adfa90edd932732ddf242f24dc2dcd6156779e69966d432fcb3b9fe3ae9831ab
```
Another person, in a separate directory (also works on the same computer):
```
$ teamtype join 5-hamburger-endorse
Derived peer from join code. Storing in config (overwriting previous config).
Storing peer's address in .teamtype/config.
Connected to peer: 5e6b787fff79074735eb9b56939269100de1e37bc7f7a4d29c277cc24f7ee53d
```
The directories are now connected, and changes will be synced instantly. You can open text files (using editors with a Teamtype plugin), and start collaborating in real time! :sparkles:
## 🎓 Learn more
- Learn more about Teamtype in [the documentation](https://teamtype.github.io/teamtype).
- 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.
- Watch a (German) [1-hour talk](https://media.ccc.de/v/2024-355-ethersync-echtzeit-kollaboration-in-deinem-texteditor-) given at MRMCD 2024.
## 🏘️ Community projects
Plugins:
- @schrieveslaach is maintaining a [plugin for Jetbrains IDEs](https://github.com/teamtype/teamtype-jetbrains)
- [TeXstudio](https://www.texstudio.org) has a [Teamtype integration](https://texstudio-org.github.io/editing.html#collaborative-editing-pair-programming)
Work-in-progress plugins:
- @sohalt's [Emacs plugin](https://github.com/sohalt/ethersync.el)
- @hvergara's [Obsidian plugin](https://github.com/critica-tech-lab/pasta-obsidian)
- @winniehell's [web editor](https://github.com/teamtype/teamtype-web)
- [Emacs plugin](https://github.com/teamtype/teamtype/tree/emacs-plugin)
- @thwischm's [Kakoune plugin](https://github.com/thwischm/kak-ethersync)
Bridges:
- [Hedgedoc bridge prototype](https://github.com/teamtype/teamtype/tree/hedgedoc-prototype/daemon)
- @dglittle's [Braid bridge](https://github.com/braid-org/braid-ethersync)
- [LSP bridge](https://github.com/teamtype/teamtype-lsp)
- @3timeslazy's [LSP bridge](https://github.com/nonscalable/teamtype-lsp/tree/main/crates/teamtype-lsp) (see this [discussion](https://github.com/teamtype/teamtype/discussions/440))
## 🔨 Contributing
We'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. We have a [CONTRIBUTING.md](CONTRIBUTING.md) file that gives more guidance.
If you're interested in building new editor plugins, read the [editor plugin development guide](https://teamtype.github.io/teamtype/editor-plugin-dev-guide).
For more information about Teamtype's design, refer to the list of [decision records](docs/decisions/).
If you find bugs, please [open an issue](https://github.com/teamtype/teamtype/issues) on Github!
## ☎️ Contact
Feel free to [join us on Zulip](https://teamtype.zulipchat.com) to ask us anything! Other good channels:
- Mastodon: [@teamtype@fosstodon.org](https://fosstodon.org/@teamtype)
- Email: teamtype@zormit.de
## 💚 Thanks
Teamtype received funding from [NLNet](https://nlnet.nl)'s [NGI0 Core Fund](https://nlnet.nl/core/) throughout 2024.
Thanks 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.
Teamtype is based on [Automerge](https://automerge.org), [Iroh](https://www.iroh.computer), and [Magic Wormhole](https://magic-wormhole.readthedocs.io).
And finally, thanks to everyone who helped us beta-test, or reported issues!
## 📜 License
This 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.
This project is [REUSE](https://reuse.software) compliant, see the headers of each file for licensing information.