# git-remote-ssb

A [git remote helper][] for ssb:// URLs. It lets you use git repos over [secure-scuttlebutt][].

`git-remote-ssb` supports fetching from and pushing to ssb git repos.

This package also includes a command-line tool `git-ssb` for doing things with
ssb git repos.

## Install

```
npm install -g git-remote-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
    git push ssb

Clone a repo from SSB:

    git clone ssb://<msgId> repo

## Configuration

As with [patchwork][], `git-remote-ssb` reads the `ssb_appname`
environmental variable when deciding what scuttlebot instance to connect to.
`git-remote-ssb` also uses [git's config][git config] to configure the
scuttlebot client. To make it so a repo only gets
used in your [testing environment][patchwork-testing], you can configure the
repo as follows:

    git config ssb.app_name test

[secure-scuttlebutt]: https://github.com/ssbc/secure-scuttlebutt
[git remote helper]: http://git-scm.com/docs/git-remote-helpers
[git config]: http://git-scm.com/docs/git-config
[patchwork]: https://github.com/ssbc/patchwork
[patchwork-testing]: https://github.com/ssbc/patchwork/blob/3f6d2d60b66361c3c926ff0a9e81847e71c8cfdd/docs/TESTING.md

## 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.