noteui¶
noteui is a terminal notes application for people who want the speed of a TUI while keeping their notes as normal files and directories.
It helps you browse, search, preview, organize, and edit notes without moving them into a database or a proprietary format.
New here?
Start with the tutorial pages. They are written for first-time users and walk through installation, first launch, and the most common workflows.
Try it in one command
Already installed noteui? Run noteui --demo to launch the UI against a
throwaway set of sample notes. Nothing touches your real notes directory.
See Demo mode for details.
Common tasks¶
- Install noteui and the sync helper: Installation
- Learn the core workflow: Getting started
- Customize appearance, preview, and keys: Configuration reference
- Set up SSH-based sync: Sync guide
- Isolate multiple workspaces from each other over sync: Per-workspace sync isolation
- Browse and restore note versions: Note version history
- Understand encrypted notes: Encrypted notes
- Recover remote-only or missing synced notes: Troubleshooting
Why use noteui?¶
- your notes stay as files on disk
- categories are just folders
- you can still use your own editor and sync tools
- the terminal UI adds search, preview, organization, and keyboard-first workflows
Choose your path¶
New users¶
Regular usage¶
Advanced usage¶
Exact reference¶
- Configuration reference
- Environment variables
- Storage and state
- Troubleshooting
- Docs maintenance
- FAQ
Core concepts¶
Notes are files¶
noteui works with real files on disk. Supported note formats are:
.md.txt.org.norg
Categories are folders¶
Subdirectories under the notes root become categories in the UI.
Temporary notes live under .tmp¶
Temporary notes are stored separately inside the notes root so they do not clutter your main note tree.
noteui stores UI state separately¶
Pins, collapsed categories, and sort mode are stored outside your notes so your content stays simple and portable.