https://github.com/yetanothermechanicusenjoyer/rivet
A Terminal UI Discord Client in Rust
https://github.com/yetanothermechanicusenjoyer/rivet
api cargo crossterm discord discord-api good-first-contribution good-first-issue good-first-pr rust terminal tokio tui work-in-progress
Last synced: 5 months ago
JSON representation
A Terminal UI Discord Client in Rust
- Host: GitHub
- URL: https://github.com/yetanothermechanicusenjoyer/rivet
- Owner: YetAnotherMechanicusEnjoyer
- License: mit
- Created: 2025-10-13T15:19:28.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-01-20T11:02:26.000Z (5 months ago)
- Last Synced: 2026-01-20T20:16:24.285Z (5 months ago)
- Topics: api, cargo, crossterm, discord, discord-api, good-first-contribution, good-first-issue, good-first-pr, rust, terminal, tokio, tui, work-in-progress
- Language: Rust
- Homepage:
- Size: 3.01 MB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rivet
## Table of Content
- [About](#about)
- [Terms of Service Notice](#terms-of-service-notice)
- [Installation (AUR)](#installation-aur)
- [Installation (Binaries)](#installation-binaries)
- [Installation (Cargo)](#installation-cargo)
- [Dependencies](#dependencies)
- [Compilation from crates.io](#compilation-from-cratesio)
- [Compilation from source](#compilation-from-source)
- [Initialization](#initialization)
- [Usage](#usage)
- [Licence](#licence)
## About
> [!NOTE]
> A Terminal UI Discord Client in Rust.
> [!TIP]
> Having [NerdFonts](https://www.nerdfonts.com/) installed provides a better experiences with icons.
### Terms of Service Notice
>
> [!WARNING]
> Under no circumstances should you use a Discord User Token (also known as a self-bot token) with this software or any associated tools.
Discord's [Terms of Service (ToS)](https://discord.com/terms) explicitly and strictly prohibit the use of User Tokens for programmatic access or self-botting. Violation of these terms can lead to permanent termination of your Discord account.
> - **Do not use self-bots or user-bots.** Each account must be associated with a human, not a bot.
> Self-bots put strain on Discord’s infrastructure and our ability to run our services. For more information, you can read our Developer Policies [here](https://discord.com/developers/docs/policy).
The developers, contributors, and maintainers of this repository disclaim all liability and responsibility for any and all consequences that may arise from a user's decision to violate Discord's Terms of Service.
> [!CAUTION]
> We do not encourage, endorse, or support the use of User Tokens. đŸ˜‰
>
> The user assumes all risk for any account actions, bans, or penalties issued by Discord due to improper use of this software.
## Installation ([AUR](https://aur.archlinux.org/packages/rivetui))
> [!IMPORTANT]
> Make sure to have [YaY](https://github.com/Jguer/yay) installed.
```bash
yay -S rivetui
# or
yay -S rivetui-git
```
## Installation (Binaries)
> [!NOTE]
> Download the binaries from the [releases](https://github.com/YetAnotherMechanicusEnjoyer/Rivet/releases/)
## Installation ([Cargo](https://doc.rust-lang.org/cargo/))
### Dependencies
> [!IMPORTANT]
> Make sure to have [Rust](https://www.rust-lang.org/tools/install) installed.
### Compilation from [crates.io](https://crates.io/crates/rivetui)
> [!IMPORTANT]
> Make sure that `~/.cargo/bin` is in your PATH env variable.
```bash
cargo install rivetui
```
### Compilation from source
> [!NOTE]
> Clone the repo somewhere and compile the program.
```bash
git clone https://github.com/YetAnotherMechanicusEnjoyer/Rivet
cd Rivet/
cargo build --release
```
> [!TIP]
> Either execute the binary `./target/release/rivetui` or put it inside a directory included in your PATH env variable.
## Initialization
> [!NOTE]
> Either make a `.env` file at the root of the repository that contains the `DISCORD_TOKEN` variable, save it in your shell env or write it with the command.
> [!TIP]
> Exemple of a `.env` file :
```env
DISCORD_TOKEN="your-token-here"
```
> [!TIP]
> Exemple of a shell env variable :
```env
export DISCORD_TOKEN="your-token-here"
```
> [!TIP]
> Exemple of a command-line env variable :
```env
DISCORD_TOKEN="your-token-here" rivetui
```
## Usage
```bash
rivetui
```
or
```env
DISCORD_TOKEN="your-token-here" rivetui
```
## Licence
[](https://github.com/YetAnotherMechanicusEnjoyer/Rivet/blob/5392a5b9f8982187b02d11ccd94dcd952fee36b6/LICENSE)