Manage a personal knowledge base
Find a file
2021-09-14 08:36:39 +02:00
entries Add XML 2021-09-14 08:36:39 +02:00
.gitignore Make simple arg parsing 2021-02-14 14:46:08 +01:00
know.py Make entry dir a global var 2021-02-19 20:13:28 +01:00
README.md Add do_add 2021-02-15 16:52:26 +01:00

know - Manage a personal knowledge base

Why

Whenever I run accros a concept I don't understand (mostly acronyms, but it can be whatever), I'd like to be able to do one of two things:

  • Look it up easily
  • Add it to a TODO list so that I can be reminded of what I need to learn.

The database consists of individual text files located in keywords.

Getting started

My database is in this repo, but a new database can be created with $ know init.

$ git clone https://git.tunuifranken.info/flyingscorpio/know.git
$ ln -rs know/know.py ~/.local/bin/know
$ know init

This is assuming ~/.local/bin/ is in your PATH.

Usage

$ know dhcp

If the entry dhcp is present in the database, it will be displayed. Otherwise, it will be added and will open your editor for further editing.

If you want to edit an entry that already exists, you can either:

  • edit it directly
  • $ know edit dhcp

You can also use $ know add dhcp to quickly add an empty entry (todo list for example).