![Hermie The Crab](/icon.png)

# Scuttle Shell 

This is a [Secure Scuttlebutt](http://scuttlebutt.nz) system tray application. It provides an always-running _sbot_ for your local system.

## 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](https://nodejs.org). 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
```