Ferronote Logo

Notes at the speed of thought β€” a blazing-fast terminal note-taking app inspired by Notational Velocity.

Ferronote is a Rust TUI application that brings the elegance and speed of Notational Velocity to the modern terminal. Search, create, and edit notes without ever touching the mouse. --- ## πŸ“š Documentation - 🌐 **[Project Website](https://tareqmy.github.io/ferronote/)** β€” Landing page with features, install instructions, and keybindings at a glance. - πŸ“– **[Philosophy & Features](docs/features.md)** β€” Modeless design, plain text storage, tags, wiki links, Vim editing, and custom themes. - πŸš€ **[Installation & Quick Start](docs/installation.md)** β€” Install via Shell/PowerShell scripts, Homebrew, Cargo, or Nix. - πŸ’» **[CLI Commands & Options](docs/cli.md)** β€” Command-line flags, custom directory flags, vault import/export, and trash management. - ⌨️ **[Keybindings Reference](docs/keybindings.md)** β€” Full list of keyboard shortcuts, Vim mode controls, navigation, and panel focus. - πŸ—οΈ **[Architecture & Structure](docs/architecture.md)** β€” The Elm Architecture (TEA) in Rust, dependencies, and source tree layout. - 🀝 **[Contributing Guide](CONTRIBUTING.md)** β€” Guidelines for opening issues and submitting pull requests. - πŸ—ΊοΈ **[Development Roadmap](ROADMAP.md)** β€” Project vision and upcoming features. --- Released under the [MIT License](LICENSE).