# peerchat

> Peer-to-peer terminal chat

Latest version **0.1.5** (published 2022-03-22) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install peerchat
pnpm add peerchat
yarn add peerchat
bun add peerchat
```

Provides the commands `pchat`, `peerchat`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2022-03-22 |
| First published | 2022-01-28 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 12 |
| Unpacked size | 50 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Mykhailo Marynenko @0x77dev |
| Maintainers | 0x77 |
| Keywords | oclif, blessed, dstack, ipfs, libp2p, peer-to-peer, chat, zero-configuration |

## Links

- npm: https://www.npmjs.com/package/peerchat
- Repository: https://github.com/dstack-js/chat
- Issues: https://github.com/dstack-js/chat/issues
- npm.io page: https://npm.io/package/peerchat

## Dependencies (12)

- [tslib](https://npm.io/package/tslib.md) ^1
- [blessed](https://npm.io/package/blessed.md) ^0.1.81
- [graphql](https://npm.io/package/graphql.md) ^16.3.0
- [discord.js](https://npm.io/package/discord.js.md) ^13.6.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1
- [@dstack-js/lib](https://npm.io/package/@dstack-js/lib.md) ^0.2.33
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1
- [@dstack-js/ipfs](https://npm.io/package/@dstack-js/ipfs.md) ^0.2.33
- [@dstack-js/wrtc](https://npm.io/package/@dstack-js/wrtc.md) 0.4.8
- [graphql-request](https://npm.io/package/graphql-request.md) ^4.0.0
- [libp2p-websockets](https://npm.io/package/libp2p-websockets.md) ^0.16.2
- [libp2p-webrtc-star](https://npm.io/package/libp2p-webrtc-star.md) 0.20.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.1.5 (latest) — 2022-03-22
- 0.1.4 — 2022-02-13
- 0.1.3 — 2022-01-29
- 0.1.2 — 2022-01-29
- 0.1.1 — 2022-01-29
- 0.1.0 — 2022-01-29
- 0.0.3 — 2022-01-28
- 0.0.2 — 2022-01-28
- 0.0.1 — 2022-01-28
- 0.0.0 — 2022-01-28

## README

Peerchat
===============

Zero configuration peer-to-peer terminal chat with built-in end-to-end encryption working on [DStack](https://github.com/dstack-js/dstack)

[Checkout blog post for more info](https://dstack.dev/blog/peerchat)

[![asciicast](https://asciinema.org/a/465056.svg)](https://asciinema.org/a/465056)
[![dstack](https://dstack.dev/img/badge.svg)](https://dstack.dev)
[![Version](https://img.shields.io/npm/v/peerchat.svg)](https://npmjs.org/package/peerchat)
[![Downloads/week](https://img.shields.io/npm/dw/peerchat.svg)](https://npmjs.org/package/peerchat)
[![License](https://img.shields.io/npm/l/peerchat.svg)](https://github.com/dstack-js/chat/blob/master/package.json)

# Installing

```console
npm i -g peerchat
yarn global add peerchat
```

---

<!-- toc -->
* [Installing](#installing)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g peerchat
$ peerchat COMMAND
running command...
$ peerchat (-v|--version|version)
peerchat/0.1.5 darwin-arm64 node-v17.7.2
$ peerchat --help [COMMAND]
USAGE
  $ peerchat COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`peerchat [ROOM] [NICKNAME]`](#peerchat-room-nickname)
* [`peerchat discord [ROOM]`](#peerchat-discord-room)
* [`peerchat help [COMMAND]`](#peerchat-help-command)

## `peerchat [ROOM] [NICKNAME]`

Peer-to-peer terminal chat running on DStack

```
USAGE
  $ peerchat [ROOM] [NICKNAME]

ARGUMENTS
  ROOM      [default: dstack] chat room
  NICKNAME  your nickname

OPTIONS
  -v, --version  show CLI version

EXAMPLES
  $ peerchat
  $ peerchat [ROOM] [NICKNAME]
  $ peerchat dstack myCoolNickname
```

_See code: [src/commands/index.ts](https://github.com/dstack-js/chat/blob/v0.1.5/src/commands/index.ts)_

## `peerchat discord [ROOM]`

Peerchat/Discord relay

```
USAGE
  $ peerchat discord [ROOM]

ARGUMENTS
  ROOM  [default: dstack] chat room

OPTIONS
  -v, --version  show CLI version

EXAMPLES
  $ CHANNEL_ID="<discord channel id>" DISCORD_KEY="<discord bot token>" peerchat discord
  $ CHANNEL_ID="<discord channel id>" DISCORD_KEY="<discord bot token>" peerchat discord [ROOM]
  $ CHANNEL_ID="<discord channel id>" DISCORD_KEY="<discord bot token>" peerchat discord dstack
```

_See code: [src/commands/discord/index.ts](https://github.com/dstack-js/chat/blob/v0.1.5/src/commands/discord/index.ts)_

## `peerchat help [COMMAND]`

Display help for peerchat.

```
USAGE
  $ peerchat help [COMMAND]

ARGUMENTS
  COMMAND  Command to show help for.

OPTIONS
  -n, --nested-commands  Include all nested commands in the output.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/peerchat · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
