sshChat-CLI/README.md

# SSH Chat

A Peer to Peer chat client using [Hyper-Protocol](https://docs.holepunch.to/)


A high-level API for finding and connecting to peers who are interested in a "topic." 

[@hyperswarm/dht](https://docs.holepunch.to/building-blocks/hyperswarm#dht): 

A DHT powering Hyperswarm. Through this DHT, each server is bound to a unique key pair, with the client connecting to the server using the server's public key.


[@hyperswarm/secretstream](https://docs.holepunch.to/building-blocks/hyperswarm#secretstream): 

Secretstream is used to securely create connections between two peers in Hyperswarm.

## What is HyperSwarm?
Hyperswarm allows you to find and connect to peers who are announcing a common "topic". The swarm topic can be anything. This means that, with Hyperswarm, you can discover and connect peers with a shared interest over a distributed network. As an example, we often use Hypercore's discovery key as the swarm topic for discovering peers to replicate with.
Once Hyperswarm has discovered peers, nodes in the DHT help those peers connect via a UDP-based hole-punching algorithm that's designed to work well in home networks.

https://docs.holepunch.to/building-blocks/hyperswarm

## Usage

To install:

`git clone git@git.codingvm.codes:snxraven/sshChat-CLI.git`

`cd sshChat-CLI`

`npm i`

To run a new topic (room):

`node sshchat.js`

This will give you a connection topic to share:

```
/sshChat ❯ ✦ node sshChat.js
joined topic: 6076c0903ad293e24c10fceb501fe7b02425f6d26c7a5b2d015abd07e3e6b17b
(Share this key to others so they may join.)
You are now in a chatroom for your topic, feel free to chat.
```


To connect to an altready made topic (room) pass the hash on start up:


`node sshchat.mjs 6076c0903ad293e24c10fceb501fe7b02425f6d26c7a5b2d015abd07e3e6b17b`

# Commands

\>login [API KEY] - Login to the API 

\> command here - Send a command to your container

\>cd /to/path - Change your working directory.

>start - Start your container

>stop - Stop your container

>restart - restart your container

>stats - Get the containers stats

! [prompt] - Send a prompt to GPT3

## Screenshots:

A simple convo:
![ScreenShot](https://media.discordapp.net/attachments/818514972610134069/1061846943556435978/Unsaved_Image_1.jpg?width=1215&height=660)

Running commands while logged in:
![ScreenShot](https://media.discordapp.net/attachments/818514972610134069/1061839208064495617/Unsaved_Image_1.jpg?width=1215&height=660)


If a user does not login they will have a random annon1234 username.
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
+								# SSH Chat
-												updating readme hahah last time

											
										
										
											2023-01-08 22:31:52 -05:00
+								A Peer to Peer chat client using [Hyper-Protocol](https://docs.holepunch.to/)
-												Adding links to Hypers docs

											
										
										
											2023-01-08 22:13:10 -05:00
-												updating readme

											
										
										
											2023-01-08 22:28:12 -05:00
-												updating readme hahah last time

											
										
										
											2023-01-08 22:31:52 -05:00
+								A high-level API for finding and connecting to peers who are interested in a "topic."
 								[@hyperswarm/dht](https://docs.holepunch.to/building-blocks/hyperswarm#dht):
 								A DHT powering Hyperswarm. Through this DHT, each server is bound to a unique key pair, with the client connecting to the server using the server's public key.
 								[@hyperswarm/secretstream](https://docs.holepunch.to/building-blocks/hyperswarm#secretstream):
 								Secretstream is used to securely create connections between two peers in Hyperswarm.
 								## What is HyperSwarm?
-												updating readme

											
										
										
											2023-01-08 22:28:12 -05:00
+								Hyperswarm allows you to find and connect to peers who are announcing a common "topic". The swarm topic can be anything. This means that, with Hyperswarm, you can discover and connect peers with a shared interest over a distributed network. As an example, we often use Hypercore's discovery key as the swarm topic for discovering peers to replicate with.
 								Once Hyperswarm has discovered peers, nodes in the DHT help those peers connect via a UDP-based hole-punching algorithm that's designed to work well in home networks.
 								https://docs.holepunch.to/building-blocks/hyperswarm
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
-												updating readme hahah last time

											
										
										
											2023-01-08 22:31:52 -05:00
+								## Usage
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
 								To install:
 								`git clone git@git.codingvm.codes:snxraven/sshChat-CLI.git`
 								`cd sshChat-CLI`
 								`npm i`
 								To run a new topic (room):
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								`node sshchat.js`
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
 								This will give you a connection topic to share:
 								```
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								/sshChat ❯ ✦ node sshChat.js
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
+								joined topic: 6076c0903ad293e24c10fceb501fe7b02425f6d26c7a5b2d015abd07e3e6b17b
 								(Share this key to others so they may join.)
 								You are now in a chatroom for your topic, feel free to chat.
 								```
 								To connect to an altready made topic (room) pass the hash on start up:
 								`node sshchat.mjs 6076c0903ad293e24c10fceb501fe7b02425f6d26c7a5b2d015abd07e3e6b17b`
 								# Commands
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								\>login [API KEY] - Login to the API
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								\> command here - Send a command to your container
-												fix readme

											
										
										
											2023-01-08 23:55:07 -05:00
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								\>cd /to/path - Change your working directory.
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								>start - Start your container
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								>stop - Stop your container
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								>restart - restart your container
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
-												Refreactor to add a command handler

											
										
										
											2023-01-11 15:48:57 -05:00
+								>stats - Get the containers stats
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
-												Adding in AI using the ! prefix

											
										
										
											2023-01-09 00:43:54 -05:00
+								! [prompt] - Send a prompt to GPT3
-												updating readme

											
										
										
											2023-01-08 22:23:46 -05:00
-												updating readme hahah last time

											
										
										
											2023-01-08 22:31:52 -05:00
+								## Screenshots:
-												updating readme

											
										
										
											2023-01-08 22:23:46 -05:00
 								A simple convo:
 								![ScreenShot](https://media.discordapp.net/attachments/818514972610134069/1061846943556435978/Unsaved_Image_1.jpg?width=1215&height=660)
 								Running commands while logged in:
 								![ScreenShot](https://media.discordapp.net/attachments/818514972610134069/1061839208064495617/Unsaved_Image_1.jpg?width=1215&height=660)
-												first commit

											
										
										
											2023-01-08 22:03:13 -05:00
+								If a user does not login they will have a random annon1234 username.