| Name | git-withme JSON |
| Version |
25.8.0
JSON |
| download |
| home_page | None |
| Summary | Encrypted, peer-to-peer Git for two+ people. |
| upload_time | 2025-08-02 02:00:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | The MIT License (MIT)
Copyright (c) 2023 meejah
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
cryptography
infosec
magic-wormhole
privacy
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Git With Me
I have a Git repository and I want to collaborate with others.
We do not have a public server, and do not wish to use existing hosting services.
``git withme`` provides a way for a single host to invite numerous peers with short, one-time secure codes.
The peers connect directly via [Dilated Magic Wormhole channels](https://meejah.ca/blog/fow-wormhole-forward), allowing collaborators to ``git clone git://localhost/<repo-name>``.
- Git: https://git.sr.ht/~meejah/git-withme
- Releases: https://pypi.org/project/git-withme/
## Motivational Example
I have created a Git repository:
$ mkdir ~/src/gwm
$ cd ~/src/gmw
$ echo "Git With Me" > README
$ git add README
$ git commit -m "begin"
Now chatting with a friend, I invite them to collaborate.
In its own shell, I run the hosting service; this will connect to the public Magic Wormhole mailbox server.
$ cd ~/src/gwm
$ git withme
Hosting /home/meejah/src/gwm (via bare repo /tmp/tmpx_y7q2iq/gitwithme_remote)
╭───────────────────────────────────────────────────────────────╮
│ Hosting: /home/mike/src/git-withme │
│ Git WithMe is now running. To push code to all peers, use: │
│ git push gitwithme │
│ ...and to receive code from a peer who has pushed, use: │
│ git pull gitwithme main │
│ The temporary bare repository we created will be deleted when │
│ this process is terminated. │
│ │
│ N -- create new peer │
│ Q -- quit, terminate all peers │
╰───────────────────────────────────────────────────────────────╯
Peers
┌────────────────────────────────────────────┐
│ Invite code: 4-quux-foo │
│ run "git-withme accept 4-quux-foo" to join │
└────────────────────────────────────────────┘
I now send the code ``4-quux-foo`` to my friend.
On their computer, they run the "accept" command (with the secret code) to begin collaborating.
$ git withme --repo ~/src/gwm accept 4-quux-foo
welcome ws://relay.magic-wormhole.io:4000/v1
Peer has connected.
git:
git: Cloning into '~/src/gwm'...
git:
You can now use normal git commands in ~/src/gwm
"git pull": update from the host
"git push": push changes to the host
Meanwhile, I should see something like this on my side:
┌──────────────────────────────────────────────────────┐
│ Connected (for 58 seconds). 🙂 (last 58 seconds ago) │
└──────────────────────────────────────────────────────┘
As long as both of these shells -- the one on my computer, and the one on my friend's -- remain running they forward end-to-end encrypted traffic between our two computers.
This means that my friend can pull (and push) code; we can use Git somewhat normally.
When the host terminates, the bare repository in $TMPDIR is removed.
# One-Time Codes
Malicious actors (even the Mailbox server, if malicious or compromised) get a single guess at breaking the code; if they are wrong, the mailbox is destroyed and the legitimate recipient will notice (they get a "crowded" error).
This gives us an identity-free, long-lived connection -- so long as we keep our shells running, we can put our laptops to sleep or otherwise move networks (note that if **both** sides are disconnected for more than 10 minutes, the connection will be terminated).
# How to Install
``git withme`` is a Git extension written in Python.
To "install" it, the ``git-withme`` script needs to be somewhere on your ``PATH`` (for ``git withme`` to work).
I recommend using a "virtualenv" or "venv" to install into, or you can try ``pip install --user git-withme`` if that works for your platform.
For a "venv":
$ python -m venv ~/gwm-venv
$ ~/gwm-venv/bin/pip install git+https://git.sr.ht/~meejah/git-withme
$ export ~/gwm-venv/bin:$PATH
$ git withme --help
Raw data
{
"_id": null,
"home_page": null,
"name": "git-withme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "cryptography, infosec, magic-wormhole, privacy",
"author": null,
"author_email": "meejah <meejah@meejah.ca>",
"download_url": "https://files.pythonhosted.org/packages/fe/8a/ee70aa3c1806cb582b336b5541cbf3dc8d3810ee2475f488c687a453dcdf/git_withme-25.8.0.tar.gz",
"platform": null,
"description": "# Git With Me\n\nI have a Git repository and I want to collaborate with others.\nWe do not have a public server, and do not wish to use existing hosting services.\n\n``git withme`` provides a way for a single host to invite numerous peers with short, one-time secure codes.\nThe peers connect directly via [Dilated Magic Wormhole channels](https://meejah.ca/blog/fow-wormhole-forward), allowing collaborators to ``git clone git://localhost/<repo-name>``.\n\n\n\n- Git: https://git.sr.ht/~meejah/git-withme\n- Releases: https://pypi.org/project/git-withme/\n\n\n## Motivational Example\n\nI have created a Git repository:\n\n $ mkdir ~/src/gwm\n $ cd ~/src/gmw\n $ echo \"Git With Me\" > README\n $ git add README\n $ git commit -m \"begin\"\n\nNow chatting with a friend, I invite them to collaborate.\nIn its own shell, I run the hosting service; this will connect to the public Magic Wormhole mailbox server.\n\n $ cd ~/src/gwm\n $ git withme\n Hosting /home/meejah/src/gwm (via bare repo /tmp/tmpx_y7q2iq/gitwithme_remote)\n \u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n \u2502 Hosting: /home/mike/src/git-withme \u2502\n \u2502 Git WithMe is now running. To push code to all peers, use: \u2502\n \u2502 git push gitwithme \u2502\n \u2502 ...and to receive code from a peer who has pushed, use: \u2502\n \u2502 git pull gitwithme main \u2502\n \u2502 The temporary bare repository we created will be deleted when \u2502\n \u2502 this process is terminated. \u2502\n \u2502 \u2502\n \u2502 N -- create new peer \u2502\n \u2502 Q -- quit, terminate all peers \u2502\n \u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n Peers\n \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n \u2502 Invite code: 4-quux-foo \u2502\n \u2502 run \"git-withme accept 4-quux-foo\" to join \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\nI now send the code ``4-quux-foo`` to my friend.\nOn their computer, they run the \"accept\" command (with the secret code) to begin collaborating.\n\n $ git withme --repo ~/src/gwm accept 4-quux-foo\n welcome ws://relay.magic-wormhole.io:4000/v1\n Peer has connected.\n git:\n git: Cloning into '~/src/gwm'...\n git:\n You can now use normal git commands in ~/src/gwm\n \"git pull\": update from the host\n \"git push\": push changes to the host\n\nMeanwhile, I should see something like this on my side:\n\n \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n \u2502 Connected (for 58 seconds). \ud83d\ude42 (last 58 seconds ago) \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\nAs long as both of these shells -- the one on my computer, and the one on my friend's -- remain running they forward end-to-end encrypted traffic between our two computers.\nThis means that my friend can pull (and push) code; we can use Git somewhat normally.\n\nWhen the host terminates, the bare repository in $TMPDIR is removed.\n\n\n# One-Time Codes\n\nMalicious actors (even the Mailbox server, if malicious or compromised) get a single guess at breaking the code; if they are wrong, the mailbox is destroyed and the legitimate recipient will notice (they get a \"crowded\" error).\nThis gives us an identity-free, long-lived connection -- so long as we keep our shells running, we can put our laptops to sleep or otherwise move networks (note that if **both** sides are disconnected for more than 10 minutes, the connection will be terminated).\n\n\n# How to Install\n\n``git withme`` is a Git extension written in Python.\nTo \"install\" it, the ``git-withme`` script needs to be somewhere on your ``PATH`` (for ``git withme`` to work).\n\nI recommend using a \"virtualenv\" or \"venv\" to install into, or you can try ``pip install --user git-withme`` if that works for your platform.\nFor a \"venv\":\n\n $ python -m venv ~/gwm-venv\n $ ~/gwm-venv/bin/pip install git+https://git.sr.ht/~meejah/git-withme\n $ export ~/gwm-venv/bin:$PATH\n $ git withme --help\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)\n \n Copyright (c) 2023 meejah\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Encrypted, peer-to-peer Git for two+ people.",
"version": "25.8.0",
"project_urls": {
"Homepage": "https://sr.ht/~meejah/git-withme/",
"Issues": "https://todo.sr.ht/~meejah/git-withme",
"Repository": "https://git.sr.ht/~meejah/git-withme"
},
"split_keywords": [
"cryptography",
" infosec",
" magic-wormhole",
" privacy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bbc19ae4f2a030e5adbfd20b2e8a2e9f797f1698d16e4852c172b725d41d96c5",
"md5": "025d2a69a5bee061d21c226a39a495a1",
"sha256": "ae818047e117d8975432dd51204ffb9da2a1040bdafab3a49b0fe071e51c40d7"
},
"downloads": -1,
"filename": "git_withme-25.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "025d2a69a5bee061d21c226a39a495a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 11686,
"upload_time": "2025-08-02T02:00:33",
"upload_time_iso_8601": "2025-08-02T02:00:33.434426Z",
"url": "https://files.pythonhosted.org/packages/bb/c1/9ae4f2a030e5adbfd20b2e8a2e9f797f1698d16e4852c172b725d41d96c5/git_withme-25.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fe8aee70aa3c1806cb582b336b5541cbf3dc8d3810ee2475f488c687a453dcdf",
"md5": "545765914020346d237eb788f9d7ede8",
"sha256": "75cbb2d7b79375f331a10569095686ba5ceaa6818dcbc9ac140fd3f1e60f4713"
},
"downloads": -1,
"filename": "git_withme-25.8.0.tar.gz",
"has_sig": false,
"md5_digest": "545765914020346d237eb788f9d7ede8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18390,
"upload_time": "2025-08-02T02:00:34",
"upload_time_iso_8601": "2025-08-02T02:00:34.411126Z",
"url": "https://files.pythonhosted.org/packages/fe/8a/ee70aa3c1806cb582b336b5541cbf3dc8d3810ee2475f488c687a453dcdf/git_withme-25.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-02 02:00:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "git-withme"
}
