Overview¶
Ærende is a small, python based note taking application. Works offline and in the terminal via a curses interface. Navigation via vim-esque keys. Designed to slot easily into my comm workspace alongside weechat and neomutt.
Installation¶
Ærende requires python >= 3.6.
Via The Repo¶
To install ærende from the repo, you can clone it and set up a clean environment
with virtualenv:
git clone git@github.com:Autophagy/aerende.git
cd aerende
virtualenv .venv -p python3.6
source .venv/bin/activate
Then, install the aerende package:
pip install -e .
You can now run aerende.
Creating, Editing and Deleting Notes¶
Notes can be created via n. The note editor prompt will open at the bottom,
requiring a note title, a // seperated list of note tags, and then the default
editor will open for the note’s content.
Editing a note is done via e. This will open the same note editor prompt, but
with the note’s current values autofilled.
The note editing prompt can be cancelled with esc.
Deleting a note is done via d.
A note’s priority can be increased with + and decreased with -. This
priority affects the sorting of notes, and notes with a priority of >= 10 are
considered high priority.
Configuration¶
The configuration file for ærende is located in ~/.andgeloman/aerende/config.yml.
Data Path Options¶
| Option | Description | Default |
|---|---|---|
| data_path | Path to note data yml file | ~/.andgeloman/aerende/data.yml |
Key Binding Options¶
| Option | Description | Default |
|---|---|---|
| next_note | Move the note focus down the list | j, down |
| previous_note | Move the note focus up the list | k, up |
| new_note | Create a new note | n |
| edit_note | Edit the focused note | e |
| delete_note | Delete the focused note | d |
| increment_note_priority | Increment the focused note’s priority. | + |
| decrement_note_priority | Decrement the focused note’s priority. | - |
Palette Options¶
Palette options are in the form of:
palette_name:
- foreground
- background
| Option | Description | Default |
|---|---|---|
| status_bar | Palette for the status bar | black, white |
| edit_bar | Palette for the note metadata edit bar. | black, light red |
| highlight_note | Palette for the currently focused note. | light blue, default |
| high_priority | Palette for a high priority (>= 10) note. | light red, default |