git ssb

1+

mixmix / scuttle-shell



Tree: 3679979ba56d151dcd46c62a817946d0f5ed53fe

Files: 3679979ba56d151dcd46c62a817946d0f5ed53fe / README.md

1157 bytesRaw

Hermie The Crab

Scuttle Shell

This is a Secure Scuttlebutt system tray application. It provides an always-running sbot for your local system.

This app also setups itself as a Native Host App that can be used by authorized Firefox Add-ons such as Patchfox.

Install globally

$ npm install -g scuttle-shell

or if you cloned this repo (run from the repo folder itself):

$ npm install -g

You can run the app by executing scuttleshell on your terminal.

Setup

This application is built with NodeJS. To set it up run:

$ npm install

This should set it up. If anything fails you can check your setup with

Checking your setup

Depending on your running operating system, you can check the configuration using:

$ npm run check

or

$ npm run check-win

Running Setup (again)

If anything went wrong during the setup or if you rename the folder this app is in, you can redo the setup with:

$ npm install

Built with git-ssb-web