40 lines
No EOL
1.3 KiB
Markdown
40 lines
No EOL
1.3 KiB
Markdown
# brainlet-cli
|
|
|
|
a better (unofficial) frontend for brainlet
|
|
|
|
# Requirements
|
|
You should use a terminal supporting [VT100 escape codes](https://www.climagic.org/mirrors/VT100_Escape_Codes.html) and supporting [24-bit colors](https://en.wikipedia.org/wiki/ANSI_escape_code#24-bit).
|
|
|
|
If you have a modern terminal, they probably have it.
|
|
|
|
Any operating systems not using Linux are not supported.
|
|
# Installation
|
|
```
|
|
git clone --depth=1 --recurse-submodules https://git.hippoz.xyz/hiimgoodpack/brainlet-cli.git
|
|
cd brainlet-cli
|
|
pushd brainlet-lib
|
|
npm install
|
|
popd
|
|
npm install
|
|
```
|
|
|
|
# Usage
|
|
```
|
|
node index.js <server>
|
|
```
|
|
|
|
# Commands
|
|
## Normal commands
|
|
| Name | Description |
|
|
| :------: | :---------------------------------------------- |
|
|
| quit | Exits the client |
|
|
| signup | Creates an account |
|
|
| login | Logs into an account and connects to the server |
|
|
| ls | Lists categories |
|
|
| join | Joins a category |
|
|
| dump | (Debug) Prints user information |
|
|
|
|
## Chat commands
|
|
| Name | Description |
|
|
| :------: | :---------------------------------------------- |
|
|
| /leave | Leaves the channel without telling the server | |