About

Notabena is a free and open source note-taking app, written in pure Rust. Join our Discord here!

Features

These are our current planned features. There's going to be a TUI and an app, but the features under Features are universal.

• Features
  • Simple note-taking
  • Encrypted notes
  • Simple Markdown support
  • Export & Share notes
  • Add tags to notes
  • Live-saving notes
  • Compatibility on the same device (GUI & CLI) and compatibility cross-device by account
    NOTE: Currently we have a simple PoC with basic prompts, but we're planning to support CLI flags like notabena --new/-n but if you run notabena, you'll get a full-fledged TUI
• GUI
  • Custom themes
  • Private vault: only accessible with PIN
  • Folders
  • Multiple note types which will be shown as text in the CLI
• Notabena Protocol
  • Collaboration
  • E2EE inspired by the Signal Protocol
  • .nb filetype for saving notes (encrypted)
  • Passkeys & encryption keys

Help us!

You can help us in different ways.
🐛 ・ Be a Bughunter: Search for bugs and file an issue if the output isn't as expected or if the program crashes.
🖥️ ・ Suggest features: File an issue (use the Suggest features issue template) and the devs will look into it.
🧹 ・ Fix issues: Are you a Rust developer and interested in the project: try to fix the issues and open a pull request! (Especially the ones tagged with good first issue)

Installation

There are a few different ways of installing Notabena:

• Recommended way: through SourceForge: https://sourceforge.net/projects/notabena/. This requires no knowledge or programs, but if you want to run it with notabena you'll need to add it to PATH manually. Is your architecture not in there? Consider building for all the versions and sending the binaries in our server.
• Package manager: currently, Notabena only supports Homebrew for MacOS and Linux. The formula is in chiissu/macchiato. More package managers will be added at stable.
  • (Still unsure? brew tap chiissu/macchiato && brew install notabena)
• The Rust way: if you have Rust installed, we recommend installing it through cargo (cargo install notabena). It will automatically be added to your PATH.

When running Notabena on Linux or macOS, you might encounter an error like this when running the file:
bash: /home/Your-Username/Downloads/Your-Notabena-Installation: Permission denied
To fix this issue, run the following command in your terminal:
Linux: chmod u+x /home/Your-Username/Downloads/Your-Notabena-Installation (filling in the blanks)
MacOS: chmod u+x /Users/Your-Username/Downloads/Your-Notabena-Installation (filling in the blanks)
The program should now run smoothly!

There are no issues known with Windows installation. If you get another error or similar bug, please open an issue.