hc-mail

Documentation

Hack Club Mail, from the terminal.

hc-mail is a command-line viewer for Hack Club Mail. It lets you browse letters and packages, search your full catalog live, and open detailed tracking history without leaving your shell.

crates.io GitHub Create API key 
$ cargo install hc-mail
$ hc-mail

Install

Install the latest published release from crates.io with Cargo. 

cargo install hc-mail

On first launch, the app asks for a Hack Club Mail API key and stores it locally so you do not need to enter it again.

Usage

Start the app

hc-mail

Log out

hc-mail --logout

Set a color theme

hc-mail --set-theme red

Available built-in themes are cyan, red, green, blue, purple, and yellow.

Features

  • Paginated mail list with five items per page.
  • Live search across the full loaded catalog with s.
  • Letter and package detail views inside the terminal.
  • Persistent API key storage.
  • Built-in saved color themes.

Keyboard controls

  • Left and right arrow keys move between pages.
  • Number keys open the matching item on the current page.
  • s enters live search mode.
  • q quits.

Configuration

hc-mail stores its configuration in a standard per-user config directory.

  • macOS: ~/Library/Application Support/hc-mail/config.toml
  • Linux: ~/.config/hc-mail/config.toml
  • Windows: %APPDATA%\hc-mail\config.toml

To generate a Hack Club Mail API key, visit mail.hackclub.com/my/api_keys.