Note taking with version control
epistle /ɪˈpɪs(ə)l/ noun formal, humourous - A letter.
Take ad hoc notes using Vim. Save them in a remote Git repository. This supports sharing notes across devices.
Can be configured to use a private (or public) gist.
- Python 3.6
Both Vim and Git must be in your
$ pip install epistle
Or, clone this repo and run pip install directly:
$ git clone firstname.lastname@example.org:msharp/epistle.git $ pip install epistle/
Epistle is a command-line tool.
To create a new note:
$ epistle new my_note
This will open Vim, where you can compose the note. After you exit Vim, the note will be saved, added to the repo and pushed to the remote.
The following commands are available:
- list List available Epistles
- view View the contents of an Epistle
- new Create a new Epistle
- edit Edit an Epistle
- rename Rename an Epistle
- delete Delete an Epistle
- git Run
pullto the remote Git repository
epistle --help to see a list of available commands.
When you first run the
epsitle command, it will discover your Vim and ask for the clone URL of the remote repository you want to use.
It will then clone this repository and store the URL in its config.