sshChat-CLI/README.md
2023-01-08 23:00:54 -05:00

51 lines
1018 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# SSH Chat
A Peer to Peer chat client using Hyper-Protocol
https://docs.holepunch.to/
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.mjs`
This will give you a connection topic to share:
```
/sshChat ✦ node sshChat.mjs
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 working directory
/start - Start your container
/stop - Stop your container
/restart - restart your container
/stats - Get the containers stats
If a user does not login they will have a random annon1234 username.