qwtd

Quick, write that down! Simple terminal note taking to quickly write stuff down.

Installation

To install, clone from github and install it pip:

git clone https://github.com/aidnem/qwtd
cd qwtd
pip install -e .

Usage

To run qwtd, just call it from the commandline:

qwtd

This will open the UI, prompting you to select a note.

Editing

The editor uses VI key bindings (the current VI mode can be seen at the bottom of the screen, along with other helpful keyboard shortcuts).

Here are some frequently used shortcuts to get you started:

• Ctrl-Q - Save and exit
• Ctrl-W - Save
• Ctrl-O - Open a new note (must save first)
• Ctrl-A - (Press 3 times) Abort - Exit without saving
• Ctrl-D - Delete a note (moves the note to Deleted)

You can also open a (very barebones) commandline like in vim:

Press : and then use w (write), q (quit), q! (quit and discard changes). These commands can be composed: :wq<Enter> would save the note and quit.

Deleting and restoring notes

The currently open note can be deleted with Ctrl-D. This will schedule the note's permanent deletion 7 days (configurable) from the time of initial deletion. To restore a note that's been deleted, open the note (press Ctrl+O or restart QWTD) and then press Ctrl-R to restore it.

Note: Notes scheduled for deletion that have expired are permanently deleted the next time the app is opened. QWTD removes all notes that are deleted and have passed their expiration date on startup, immediately after initializing/ upgrading the database to the latest schema.

Exporting

By default, notes are stored in the user's home directory in a sqlite3 database called qwtd.db. At some point, you may want to export a note as plain text. To do so, open the note and press Ctrl+E.

Customizing database location

QWTD uses a configuration file in your home directory at ~/.config/qwtd.toml. This file is created automatically on app startup if it doesn't already exist.

To change where the database is stored, simply edit the db field. For example, someone using Syncthing may want store their notes in the sync folder. This could be accomplished like so:

db = "~/Sync/qwtd.db"

Customizing deletion time

After a note is deleted, it will be scheduled to permanently deleted. By default, this is scheduled for 7 days after the time of initial deletion. However, this can be configured with the days_to_delete field of the config.

This value accepts ints or floats:

days_to_delete = 7