|
| 1 | +--- |
| 2 | +image: /img/qownnotes-tui.webp |
| 3 | +--- |
| 4 | + |
| 5 | +# QOwnNotes TUI |
| 6 | + |
| 7 | +[QOwnNotes TUI](https://github.com/qownnotes/qownnotes-tui) is a keyboard-first |
| 8 | +**terminal browser and editor** for local, QOwnNotes-compatible Markdown note folders. |
| 9 | +It can directly **use the note folders configured in QOwnNotes**, so you can start |
| 10 | +working with your existing notes right away. |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +- It uses the **note folders configured in QOwnNotes** and follows its note sorting settings |
| 15 | + (the QOwnNotes application database is opened read-only) |
| 16 | +- Notes can be **created, edited, searched, syntax-highlighted, renamed from their content**, |
| 17 | + and **safely deleted** from the terminal |
| 18 | +- Changes are **saved automatically** and external-change conflicts are detected |
| 19 | +- It supports **configurable themes**, **mouse controls**, **Nix**, and a **Home Manager module** |
| 20 | +- Shell completions can be generated for **Bash, Fish, Zsh**, and more |
| 21 | + |
| 22 | +## Installation |
| 23 | + |
| 24 | +Visit the [latest release page](https://github.com/qownnotes/qownnotes-tui/releases/latest) |
| 25 | +and download the version you need. |
| 26 | + |
| 27 | +::: tip |
| 28 | +If you are using [Nix](https://nixos.org/), you can build and run the application directly: |
| 29 | + |
| 30 | +```bash |
| 31 | +nix run github:qownnotes/qownnotes-tui -- --notes-dir ~/Notes |
| 32 | +``` |
| 33 | + |
| 34 | +The Nix package installs shell completions for Bash, Fish, and Zsh automatically. |
| 35 | +::: |
| 36 | + |
| 37 | +## Usage |
| 38 | + |
| 39 | +Open a note folder from the command line: |
| 40 | + |
| 41 | +```bash |
| 42 | +qownnotes-tui --notes-dir ~/Notes |
| 43 | +``` |
| 44 | + |
| 45 | +If no note folder is given, the application reads all configured note folders from |
| 46 | +QOwnNotes and initially opens the current folder. |
| 47 | + |
| 48 | +Some of the most important keys: |
| 49 | + |
| 50 | +| Key | Action | |
| 51 | +| --------------- | ------------------------------------- | |
| 52 | +| `j`, `k` | Move selection or scroll the viewer | |
| 53 | +| `h`, `l`, `Tab` | Switch panes | |
| 54 | +| `Enter` | Activate a note folder or open a note | |
| 55 | +| `n`, `Ctrl-n` | Create a timestamped note | |
| 56 | +| `d` | Delete a note after confirmation | |
| 57 | +| `e` | Edit the selected note | |
| 58 | +| `/` | Search note names and text | |
| 59 | +| `Ctrl-s` | Save the note | |
| 60 | +| `Esc` | Leave editor or return to note list | |
| 61 | +| `?` | Show help | |
| 62 | +| `q`, `Ctrl-c` | Quit | |
| 63 | + |
| 64 | +::: tip |
| 65 | +For more information, visit the |
| 66 | +[QOwnNotes TUI repository on GitHub](https://github.com/qownnotes/qownnotes-tui). |
| 67 | +::: |
0 commit comments