50 lines
2.2 KiB
Markdown
50 lines
2.2 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.
|
|
|
|
Your version of node should be >= 12.20.0
|
|
|
|
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 |
|
|
| /newline | Any occurance of /newline becomes a new line |
|
|
|
|
|
|
# Tests
|
|
## Markdown
|
|
```
|
|
__Markdown demo:__/newline**Bold and *italics in bold text* and back to bold** and some regular text/newline/newline> I found this software to be extremely helpful!/newline> **Just look at this quote on what this software does:/newline> > This software does something!/newline> > Just look at what this person said:/newline> > > I found this software to be extremely helpful!/newline> > > **Just look at this quote on what the software does:/newline> > > > *Maximum call stack size exceeded*/newline> > > I don't know what else could have been better!**/newline> > - Some random person/newline> I don't know what else could have been better!**/newline- Some random person/newline/newlineTry the software today!/newline
|
|
```
|