Skip to content
This repository has been archived by the owner on Jul 11, 2019. It is now read-only.

Latest commit

 

History

History
76 lines (51 loc) · 2.13 KB

README.md

File metadata and controls

76 lines (51 loc) · 2.13 KB
Raw

friends-cli

P2P chat powered by webrtc in a terminal

npm travis david

This project is alpha quality. You probably only want to use this if you like to send pull requests fixing things :)

How it works

See our site.

Install

npm install --global friends

Run

friends

Options

friends --help

Friends - P2P chat powered by webrtc in a terminal
Usage:
  friends <flags>
Flags:
  -v  --version   Show current version
  -h, --help      Show usage information

  Flags (advanced):
      --hub     Use an alternate signalhub server
      --mem     Use in-memory database (no messages saved to disk)

Usage

GitHub Login

Friends currently uses your git and github configuration for authentication.

If you don't already have a public key on GitHub and corresponding private key on your machine, you'll need to set that up first. Make sure your github username is also set, using git config --global github.user yourusername.

If you're having trouble getting this part to work, do this to get debug information:

$ npm i github-current-user -g
$ DEBUG=* github-current-user

and then report an issue.

Note: DSA keys are not supported. You should switch to RSA anyway for security reasons.

If it can't verify you, try doing ssh-add ~/.ssh/id_rsa. Your key should show up when you run ssh-add -l.

Contributing

Contributions welcome! Please read the contributing guidelines before getting started.

License

MIT