Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heapwolf/peerchan
Fully decentralized p2p IRC for your terminal
https://github.com/heapwolf/peerchan
chat irc p2p peer peerlinks
Last synced: about 2 months ago
JSON representation
Fully decentralized p2p IRC for your terminal
- Host: GitHub
- URL: https://github.com/heapwolf/peerchan
- Owner: heapwolf
- Created: 2020-04-26T09:38:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-02T21:42:27.000Z (over 2 years ago)
- Last Synced: 2024-11-01T18:37:29.830Z (about 2 months ago)
- Topics: chat, irc, p2p, peer, peerlinks
- Language: JavaScript
- Homepage:
- Size: 2.94 MB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SYNOPSIS
A terminal based client for the peerlinks protocol.
- Fully peer to peer
- Multiline input editing
- Command autocomplete
- Customizable color scheme
- Buffer scrollback
- Create channels
- Request and accept invites
# INSTALL
```sh
npm install peerchan -g
```
# GETTING STARTED
- Launch the app by typing `peerchan` from your terminal.
- Create an identity by typing `/id `.
- Make a request to join someone's channel by typing `/r` or
create your own channel by typing `/create `.
# CONFIG
Optional example config stored in `~/.peerchan.json`.
```js
{
"bg": 255,
"fg": 234,
"comment": { // system comments
"fg": 246,
"bg": 255
},
"prompt": { // the text message input
"bg": 4,
"fg": 15
},
"timestamp": { // message timestamp
"fg": 244,
"bg": 255
},
"status": { // the status bar at the top
"fg": 4,
"bg": 15
},
"prefix": "▌", // prefix system comments
"scrollback": 3, // scrollback rate
"id": "heapwolf" // your default id
}
```
# DEBUGGING
This has been tested on node `12.16.3 LTS`, but latest, `14.1.0` seems
to have some issues.
In terminal window A...
```sh
DEBUG_COLORS=false DEBUG='peerlinks:*' INST=0 node ./bin/peerchan.js
```
In terminal widow B...
```sh
DEBUG_COLORS=false DEBUG='peerlinks:*' INST=1 node ./bin/peerchan.js
```
In terminal window C...
```sh
tail -f ./peerchan.log
```