dzdidi b24fd86a47 installation guide
Signed-off-by: dzdidi <deniszalessky@gmail.com>
2023-08-18 15:12:48 +02:00
2023-08-07 22:18:05 +02:00
2023-08-16 16:40:49 +02:00
2023-08-15 17:45:05 +02:00
2023-08-07 22:18:05 +02:00
2023-08-07 22:18:05 +02:00
2023-08-18 15:12:48 +02:00

gitpear - 🍐2🍐 transport for git

CLI, Daemon and Remote helper for git. It is based on holepunch for networking and data sharing.

gitpear creates local bare repository in application directory (default ~/.gitpear/<repository name>), adds it as a git remote in corresponding repository with name pear. So just like in traditional flow doing git push origin, here we do git push pear. Upon each push gitpear regenerates pack files that are shared in ephemeral hyperdrive.

To enable clone or fetch or pull using git <clone|fetch|pull> pear:<public key>/<repo name>. It implements git remote helper that uses hyperswarm for networking in order to directly connect to peer. After connection is initialized it sends RPC request to retrieve list of repositories, clone corresponding pack files and unpack them locally.

Installation

It is necessary for corresponding binaries to be in $PATH, thus gitpear needs to be installed globally

From remote

npm install -g git@github.com:dzdidi/gitpear.git

From local

git clone git@github.com:dzdidi/gitpear.git
cd gitpear
npm link

NOTE: application home directory will be created in ~/.gitpear - this may require sudo

All data will be persisted in application directory (default ~/.gitpear). To change it. Provide environment variable GIT_PEAR

  • gitpear daemon <-s, --start | -k, --stop> - start or stop daemon

  • gitpear key - print out public key. Share it with your peers so that they can do git pull pear:<public key>/<repo name>

  • gitpear init [-s, --share] <path> - It will create bare repository of the same name in application directory (default ~/.gitpear/). It will add git remote in current repository with name pear. So just like in traditional flow doing git push orign, here we do git push pear. By default repository will not be shared. To enable sharing provide -s or call gitpear share <path> later

  • gitpear share <path> - makes repository sharable

  • gitpear unshare <path> - stop sharing repository

  • gitpear list [-s, --shared] - list all or (only shared) repositories

Description
No description provided
Readme 592 KiB
Languages
JavaScript 91.6%
Shell 5.8%
Dockerfile 1.3%
Nix 1.3%