bltz-0.2.0 is not a library.
Bltz
A fast terminal email client written in Rust.
Screenshots
Screenshots coming soon
Features
- Multi-account support - Manage multiple email accounts simultaneously
- OAuth2 & password authentication - Secure login with Gmail OAuth2 device flow or traditional passwords
- Vim-style keybindings - Navigate efficiently with familiar Vim motions (Arrow key mode also available)
- Email threading - Conversations grouped intelligently by Message-ID and subject
- Fast full-text search - Search across all your emails
- Offline caching - SQLite-backed cache for fast access
- Desktop notifications - Get notified of new emails
- Secure credential storage - Passwords stored in system keyring
- AI features (optional) - Email summarization and grammar polish via OpenRouter
Installation
Pre-built Binaries
Download the latest release from the Releases page.
# Linux x86_64
# macOS x86_64
Cargo Install
Build from Source
Package Managers
- Homebrew:
brew install bltz(coming soon) - AUR:
yay -S bltz(coming soon)
Configuration
Bltz stores its configuration at ~/.config/bltz/config.toml.
Initial Setup
Run the setup wizard to configure your first account:
Manual Configuration
Create ~/.config/bltz/config.toml:
[]
= "vim" # or "arrows"
= "dark" # or "light"
[[]]
= "Personal"
= "you@gmail.com"
= "imap.gmail.com"
= 993
= "smtp.gmail.com"
= 587
= "oauth2" # or "password"
See config.example.toml for a complete example.
AI Features (Optional)
AI features are disabled by default. To enable email summarization and grammar polish:
[]
= "sk-or-v1-..." # OpenRouter API key
= true
= true
= "anthropic/claude-3-haiku" # Optional, this is the default
Usage
Debug Mode
RUST_LOG=debug
Logs are written to ~/.config/bltz/bltz.log.
Keybindings
Navigation (Vim Mode)
| Key | Action |
|---|---|
j / k |
Navigate down / up |
h / l |
Collapse / expand thread |
g / G |
Go to top / bottom |
Ctrl+d / Ctrl+u |
Page down / up |
Enter |
Open email |
Esc |
Back |
q |
Quit |
Tab / Space |
Toggle thread |
[ / ] |
Switch accounts |
b |
Folder picker |
/ |
Search |
: |
Command mode |
. |
Help |
Actions
| Key | Action |
|---|---|
c |
Compose new email |
r |
Reply |
a |
Reply all |
f |
Forward |
d |
Delete |
m |
Toggle read / unread |
s |
Toggle star |
S |
View starred emails |
Ctrl+r |
Refresh |
u |
Undo |
B |
Contacts |
AI Features
| Key | Action | Context |
|---|---|---|
T |
Toggle AI summary | Reader |
Ctrl+t |
Summarize thread | Reader |
Ctrl+p |
Polish text | Composer |
Enter |
Accept polish | Polish preview |
Esc |
Reject polish | Polish preview |
File Locations
| File | Location |
|---|---|
| Configuration | ~/.config/bltz/config.toml |
| Log file | ~/.config/bltz/bltz.log |
| Cache database | ~/.local/share/bltz/cache.db |
| Credentials | System keyring |
Contributing
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
Security
For security vulnerabilities, please see SECURITY.md.
License
This project is licensed under the MIT License - see the LICENSE file for details.