Home

Awesome

git-ssb

Git repos on secure-scuttlebutt (SSB).

This package includes:

Install

npm install -g git-ssb

Usage

You can use a ssb:// remote like any other git remote. A repo on SSB is identified by a message ID. To create a new git repo on SSB, use the command git ssb create. You can only push to SSB git repos that you created, not ones created by other users.

Examples

Publish an existing repo to SSB:

cd repo
git ssb create ssb my-cool-repo
git push --tags ssb master

Clone a repo from SSB:

git clone ssb://<msgId> repo

Fork a git-ssb repo you have already cloned:

cd repo
git ssb fork mine
# edit and commit, then push changes:
git push mine

Run the web server for browsing repos:

git ssb web

Configuration

As with patchwork, git-ssb reads the ssb_appname environment variable when deciding what scuttlebot instance to connect to. git-ssb also uses git's config to get the appname if the environment variable is not set. To make it so a repo only gets used in your testing environment, you can configure the repo as follows:

git config ssb.app_name test

License

Copyright (c) 2016 Charles Lehner

Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.

DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.