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.
It is necessary for corresponding binaries to be in $PATH
, thus gitpear needs to be installed globally.
NOTE: application home directory will be created in ~/.gitpear
- this may require sudo
.
git clone [email protected]:dzdidi/gitpear.git
cd gitpear
npm install
npm link
git clone [email protected]:dzdidi/gitpear.git
cd gitpear
npm install
npm nix
See ./result
- for binaries build by nix. To make the available add to path by running PATH="${PATH:+${PATH}:}${PWD}/result/bin/"
All data will be persisted in application directory (default ~/.gitpear
). To change it. Provide environment variable GIT_PEAR
git pear daemon <-s, --start | -k, --stop>
- start or stop daemongit pear key
- print out public key. Share it with your peers so that they can dogit pull pear:<public key>/<repo name>
git pear init [-s, --share [branch]]
- It will create bare repository of the same name in application directory (default ~/.gitpear/). It will add git remote in current repository with namepear
. So just like in traditional flow doinggit push orign
, here we dogit push pear
. By default repository will not be shared. To enable sharing provide-s | --share [branch]
(default branch to share is current) or callgitpear share
latergit pear share [-b, --branch [branch name (default: "_current_")] [-v, --visibility <private|public> (default: "public")]
- share current repository, if branch is not specified, default branch will be sharedgit pear unshare
- stop sharing current repositorygit pear list [-s, --shared]
- list all or (only shared) repositoriesgit pear list <url>
- list repositories of a peer
Support of push
capabilities only enabled for authenticated users. Currently supported authentications are based on:
To start daemon with authenticated support provide environment varibales GIT_PEAR_AUTH
with values nip98
or native
.
The nip98
also requires GIT_PEAR_AUTH_NSEC
with value of your NIP19 nsec.
For example:
GIT_PEAR_AUTH=nip98 GIT_PEAR_AUTH_NSEC=nsec.... git pear daemon -s
or
GIT_PEAR_AUTH=native git pear daemon -s
To manage access to repository use one or combination of the following commands, if path
is not provide the command will be executed in the current directory. For userId
use NIP19 npub.
git pear acl -u [command] -p <repo path or url (default ".")>
- ACL managegement of for users access in local or remote repo (requiresowner
permission for remote repositories)git pear acl -u list [userId] -p <repo path or url (default ".")>
- list repository visitbility and user's role (or roles of all users if userId is not provided)git pear acl add -u <userId:role> -p <repo path or url (default ".")>
- add user as a "role" to repository available roles areviewer
,contributor
,admin
,owner
. Roles exaplained:viewer
- can read all branches;contributor
- can edit all branches except protected (default master)admin
- can edit protected branchesowner
- can edit repo ack
git pear acl remove -u| <userId> -p <repo path or url (default ".")>
- revoke use access to repository.
It is possible to setup basic branch protection rules (master is proteted by default).
git pear acl -b [command] -p <repo path or url (deafult ".")
, same asgit pear branch list
- list protection rulesgit pear acl -b list
- git pear branch list .` - list protection rules;git pear acl -b add <branchName> <repo path or url (default ".")>
- mark branch as protected;git pear acl -b remove <branchName> <repo path or url (deafult ".")>
- unmark branch as protected;
Collaboration is possible with the following flow between Alice and Bob in a peer-to-peer manner.
- Both Alice and Bob have gitpear installed and Alice wants Bob to help her with repo Repo
- Alice steps are:
cd Repo
git pear init -s
git pear list -s
# outputs:
# Repo pear://<Alice public key>/Repo
- Bob's steps:
git clone pear://<Alice public key>/Repo
cd Repo
git pear init -s
git checkout -b feature
# implement feature
git commit -m 'done'
git push pear feature
git pear list
# outputs:
# Repo pear://<Bob public key>/Repo
- Alice's steps
git checkout master
git remote add bob pear://<Bob public key>/Repo
git fetch bob
git pull
git merge feature
git push pear master
- Bob's steps are
git checkout master
git fetch origin
git pull
Collaboration is possible with the following flow between Carol and Dave in a peer-to-peer manner.
Supported authentication methods are native
and nip98
. The nip98
authentication, requires environment variable GIT_PEAR_AUTH_NSEC
with nsec
- Start daemon
GIT_PEAR_AUTH='native' git pear daemon -s
- Go to repository
cd repo
- Initialize git pear repository
git pear init
- Share repository wit hviben visibility () - (default is
public
)
git pear share public
- Add Dave as a
contirbutor
. - List Dave's npub as a contributor
git pear acl add <Dave pub key hex>:contributor
- Retreive repo url and share it with Dave
git pear list -s
- Start daemon. This will be needed later for push. Not that no auth or sec are provided which means that push to this place will not be supportedd.
git pear daemon -s
- Clone repository. Authorization data and type are necesary for server (Carol) to grant corresponding access persmissions
GIT_PEAR_AUTH='native' git clone pear://<Carol's pub key hex>/<repo name>
- Do the necessary change in separate branch
git checkout -b feat/david
- do change
git add .
git commit -s -m 'made by David'
- Push branch to origin
GIT_PEAR_AUTH='native' git push origin feat/david
- For Carol the changes will arrive as branch
feat/david
into herpear
git fetch pear
- From there she can do
git diff pear/feat/david
orgit pull pear feat/david
... merge to master and push topear
Docker image automatically clones the repository and exposes it over http and pear.
Example:
git clone https://github.com/dzdidi/gitpear.git
cd gitpear
docker build -t gitpear .
docker run -it -p 80:80 -e REPO_URL=https://github.com/dzdidi/repo.git gitpear