https://github.com/stan-smith/ironotes
TUI journal written in Rust, with fuzzy searching through your ramblings.
https://github.com/stan-smith/ironotes
Last synced: 3 months ago
JSON representation
TUI journal written in Rust, with fuzzy searching through your ramblings.
- Host: GitHub
- URL: https://github.com/stan-smith/ironotes
- Owner: stan-smith
- Created: 2025-11-10T12:08:54.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-11-10T12:36:35.000Z (9 months ago)
- Last Synced: 2026-03-30T16:42:06.579Z (4 months ago)
- Language: Rust
- Size: 21.5 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ironotes - A Simple Journal So I Actually Take Notes
I suck at taking notes, I try using paper and then I need to move it to my desktop to work on what I've written, I end up opening random text editors to take down notes.
### This simplifies that.
Each day I open ironotes, it sees there are no entries for today, so it starts a new file as DD-MM-YY.
I then happily work on this until I realise I need another note for the day, perhaps an idea has come to mind.
I then press CTRL+N, which opens a new document, saves my current one then I start typing away.
"But wait!" I hear you cry, "what if I need to search my notes?"
Well my friend, if you press CRTL+F you can fuzzy search through all your notes, you can then CRTL+UP CTRL+DOWN, to navigate the results, then CTRL+L to load the selected doc as shown below:
### Why Rust?
I'm learning it, I needed a note taking app. That's all there is to it, do what you want with it.
The emphasis being on "I'm learning it" if you want a feature, cool, go ahead and write it, if I also want it then I'll probably do it.
## Usage:
```
wget https://github.com/stan-smith/ironotes/releases/download/0.1.0/ironotes
sudo chmod +x ironotes
./ironotes
```
### Build from SRC:
Install Cargo
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Clone repo:
```
git clone https://github.com/stan-smith/ironotes
cd ironotes
cargo build --release
./target/release/ironotes
```
You will be asked which dir you want your files to be stored in, this by default is $HOME/Documents/ironotes
You can drop other MD docs in here if you want and they will also be searchable.
## Key bindings:
I wanted everything to be keyboard controlled, I will likely implement this to be changeable soon:
