A tool for managing my collection of notes.
Find a file
Jonathan Hodgson 0ac730ca3c Adds pager option and uses $PAGER environment variable
Due to bat also reading the $PAGER environment variable, I first look to
see if bat is available. If it is, I use that. If it isn't, I use the
$PAGER environment variable. If that's not available, I use cat.

I also added the --editor flag to the help output which had clearly been
missed

Close #12
2020-12-22 08:58:53 +00:00
inc Adds pager option and uses $PAGER environment variable 2020-12-22 08:58:53 +00:00
kb Adds pager option and uses $PAGER environment variable 2020-12-22 08:58:53 +00:00
README.md This is the initial commit. See description for what currently works 2020-12-19 15:52:27 +00:00

Knowledge Base

This is a script that I use to manage my personal knowledge base. I have yet to find a tool that fits my requirements / desires so I decided to build one.

This is still in early stages of development so expect braking changes to come if you use it.

Goals

Mostly Plain Text

Most of my notes are currently in Markdown. This has a couple of advantages for me:

  • I can read them anywhere
  • I can version control them with Git

There may be some exceptions. I may wish to include links or images which I will version control with Git LFS; but for the most part, my notes are plain text.

Tags

Before starting this project, my notes were organised into folders. Unfortunately, this makes storing articles or notes that apply to different areas difficult. I would prefer a tag based system. This would allow a file to have multiple tags assigned to it.

Fast

I want to be able to retrieve my notes quickly by tag or by title. To do this, this tool will index notes using an SQLite database. This will not be version controlled.

Don't re-invent the wheel

I will be building on top of already great, fast tools such as RipGrep and FZF.