Knowledge Base
This is a NodeJS app, that helps to save useful information during your life. You can store your newly earned knowledge and links and assign tags to these entries. Later when you want to retrieve the information you can just query to db of your entries.
Fully working proof of concept is availible on this branch: https://github.com/michaelKurowski/knowledge-base/tree/poc-first-iteration
Master branch is only for well engineered version.
Usage
The main command is called knowledge-base
but you can also use kb
alias.
- Add new entry WIP
kb --entry "Put not here"
orkb -e "Put note here"
KB then will ask you for categories. You can specify them by putting words separated by spaces:Links Tutorials
. KB then ask you for query keywords that will help to find it laterJavaScript TypeScript WebDevelopment
- Add new category WIP
kb --category "PutNameOfCategoryHere"
orkb -c "PutNameOfCategoryHere"
KB then will ask for aliases for your new categories so they'll be easier to access. - List all entries by category name WIP
kb --list "CategoryOne CategoryTwo"
orkb -l CategoryOne CategoryTwo
- Query your knowledge database WIP
kb --query "Phrase"
orkb -q "Phrase"
- Edit entry WIP
kb --edit-entry ID
orkb -ee
You'll then be prompted to edit info in the following sequence:- Content
- Categories
- Keywords
- Edit category WIP
kb --edit-category CategoryName
orkb -ec CategoryName
. You'll be then prompted to entry new category key and aliases.
- Delete entry WIP
kb --delete-entry ID
orkb -de ID
- Delete category WIP
kb --delete-category CategoryName
orkb -dc CategoryName
Examples
Let's say that I want to save an url to some cool Gimp tutorials.
- I add new tags to my kb:
kb --category JavaScript
KB asks me to choose aliases for my new category:JS EcmaScript ES
- I add a new entry:
kb --entry "https://somePlatform/sometutorial/blahblahblah"
Kb asks me to choose categories:js
Kb asks me to choose tags that I might later use to find that information:understanding promises
- I want to find my entry back:
kb --query "js promises"
Query is rather intelligent and will take into account categories and their aliases, entry content and tags.
Instalation
There are 2 quickiest ways to install the package
From npm: npm install name-in-npm-repository -g
From git: npm install https://url.to/this/repository -g
Roadmap
- Fully working Proof of Concept
- Functionality described in this README
- Autocomplete for tags
- Add ability to store knowledge online