git-remote-blossom

This program lets you push git repositories onto nostr relays + blossom servers.

It produces kind 30618 events on the relay that is specified in NIP-34.

This is Proof of Concept code for the following reasons:

• It supports a single blossom server.
• It supports a single nostr relay.
• It supports a single repo owner.
• It is relatively but not prohibively slow. The initial cloning of large projects can take a while, but everyday work is fine.

Usage (PoC)

For now, the nostr relay and the blossom server must be manually set in git config:

git config --global --add nostr.relay wss://your.relay.org
git config --global --add nostr.blossom https://your.blossom.org:3000

If you want to push, set your secret key as hex or nsec in nostr.sec or nostr.nsec:

 git config --global --add nostr.sec 1  # This is a test key with npub=npub10xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqpkge6d

Now you can use the blossom:// scheme in your git remote URLs.

git remote add blossom blossom://<npub>/<project>
git push origin blossom  # Use -v to see what's going on under the hood.

The repository is created automatically the first time you push.

Install

$ pip install git+https://github.com/lez/git-remote-blossom

The executable `git-remote-blossom` should be now in your PATH.

Notes, bugs

• --force-with-lease is not supported yet.
• packing git objects is not supported (as far as I know). This would make a huge improvement on speed.
• shallow cloning is not supported.
• progress bar is not very helpful when cloning.
• you should run git gc --aggressive regularly.
• This project is based on git-remote-dropbox from Anish Athalye.
• Make sure you do not leave your nsec in your shell history in order to not leak it accidentally in a screenshare session.

Design

To read about the design of git-remote-blossom, see DESIGN.rst file. This could be especially useful if you're thinking about contributing to the project.

Future Plans

Planned remote URL formats:

• blossom://[email protected]/project
• blossom://nprofile.../project
• blossom://nevent...
• blossom://npub/relay/project

The bootstrap relay will be read either from the relay list in the nip-05 json or decoded from nprofile or nevent "relay" field or straight from the URL.

Also, deeper NIP-34 integration is planned.

Contributing

Currently github's issue tracking is used for reporting bugs and discussing feature requests. If you want to join development, contact me at the npub npub1elta7cneng3w8p9y4dw633qzdjr4kyvaparuyuttyrx6e8xp7xnq32cume.

License

Copyright (c) 2015-2019 Anish Athalye. Released under the MIT License. Copyright (c) 2024 Lez nostr:npub1elta7cneng3w8p9y4dw633qzdjr4kyvaparuyuttyrx6e8xp7xnq32cume.