Risu Note CLI 🐿️
Risu Note is a local-first, terminal-based note-taking application designed for developers. It features Vim-like keybindings, robust offline capabilities, and optional End-to-End (E2E) encrypted synchronization.
✨ Features
- Local-First & Offline by Default: Risu runs 100% locally upon installation. All data is stored in your local SQLite database (
~/.risu/local.db), ensuring zero latency and full privacy without any internet connection. - vim-like Navigation: Navigate and edit notes without leaving the keyboard.
- Optional Cloud Sync: Securely sync your notes across devices with our End-to-End (E2E) encrypted service.
- Early Access Offer: We are currently offering free access to the Pro plan (E2E Sync) for the first 100 users!
- E2E Encryption: Sync uses Argon2id for key derivation and ChaCha20Poly1305 for encryption. The server never sees your plain text.
- Secure Architecture: Authentication tokens and passphrases are strictly managed (local file with 600 permissions).
- Cross-Platform: Runs on macOS, Linux, and Windows.
📦 Prerequisites
While Risu runs on any standard terminal, we highly recommend using a Nerd Font (e.g., Hack Nerd Font, JetBrainsMono Nerd Font) to correctly display the beautiful icons in the UI. Without it, some icons may not render, though functionality remains unaffected.
🚀 Installation
From Crates.io
The easiest way to install Risu is via crates.io:
From Source
Ensure you have Rust installed.
📖 Usage
Run the application:
Key Bindings (Basic)
j/k(or Up/Down): Navigate listEnter: Open note in Editor (Normal Mode)i: Open note in Editor (Insert Mode)n: Create new note (starts in Insert Mode)d: Delete note (with confirmation)/: Search / Filter notesCtrl+g: Show Status Pane (from List Mode)Esc: Back to List (Auto-saves changes)Ctrl+s: Force Save / Sync
🔐 Security & Privacy
Risu Note prioritizes your privacy.
- No Plaintext Sync: Data is encrypted on your device before it touches the network.
- Zero Knowledge: We cannot recover your data if you lose your passphrase.
See our Privacy Policy and Terms of Service for details.
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
📄 License
This project is licensed under the MIT License.