Garmelon/cove
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
TUI client for euphoria.leet.nu, a threaded real-time chat platform
512 commits 2 branches 20 tags 1.5 MiB
Find a file
Joscha 067389efa2 Move "Using cove" section to the top 
It is fairly important and easily missed if it is placed after the long
"Manual install" section. If I ever add easier ways to install cove
(like providing prebuilt binaries or packaging it on some package
managers), I might change this order again and refer to the "Using cove"
section in the top paragraph instead.
2022-09-01 21:09:25 +02:00
src Remove unnecessary mut-s 2022-08-30 17:32:57 +02:00
.gitignore Create project 2022-02-07 21:31:46 +01:00
Cargo.lock Extract links from message 2022-08-30 02:31:45 +02:00
Cargo.toml Extract links from message 2022-08-30 02:31:45 +02:00
CHANGELOG.md Add rooms keybindings around autojoin rooms 2022-08-30 15:09:06 +02:00
README.md Move "Using cove" section to the top 2022-09-01 21:09:25 +02:00
screenshot.png Add readme with screenshot and instructions 2022-08-06 00:27:30 +02:00

README.md

cove

Cove is a TUI client for euphoria.io, a threaded real-time chat platform.

A very meta screenshot

It runs on Linux, Windows and macOS.

Using cove

To start cove, simply run cove in your terminal. For more info about the available subcommands such as exporting room logs or resetting cookies, run cove --help.

If you delete rooms, cove's vault (the database it stores messages and other things in) won't automatically shrink. If it takes up too much space, try running cove gc and waiting for it to finish. This isn't done automatically because it can take quite a while.

Manual installation

This section contains instructions on how to install cove by compiling it yourself. It doesn't assume you know how to program, but it does assume basic familiarity with the command line on your platform of choice. Cove runs in the terminal, after all.

Installing rustup

Cove is written in Rust, so the first step is to install rustup. Either install it from your package manager of choice (if you have one) or use the installer.

Test your installation by running rustup --version and cargo --version. If rustup is installed correctly, both of these should show a version number.

Cove is designed on the current version of the stable toolchain. If cove doesn't compile, you can try switching to the stable toolchain and updating it using the following commands:

$ rustup default stable
$ rustup update

Installing cove

To install or update to the latest release of cove, run the following command:

$ cargo install --force --git https://github.com/Garmelon/cove --branch latest

If you like to live dangerously and want to install or update to the latest, bleeding-edge, possibly-broken commit from the repo's main branch, run the following command.

Warning: This could corrupt your vault. Make sure to make a backup before running the command.

$ cargo install --force --git https://github.com/Garmelon/cove

To install a specific version of cove, run the following command and substitute in the full version you want to install:

$ cargo install --force --git https://github.com/Garmelon/cove --tag v0.1.0