sshChat-CLI/README.md

51 lines
1018 B
Markdown
Raw Normal View History

2023-01-08 22:03:13 -05:00
# SSH Chat
2023-01-08 22:13:10 -05:00
A Peer to Peer chat client using Hyper-Protocol
https://docs.holepunch.to/
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):
`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
2023-01-08 23:00:54 -05:00
\> command here - Send a command to your container
\> cd /to/path - change working directory
2023-01-08 22:03:13 -05:00
/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.