A minimalist knowledge base manager
kb. A minimalist knowledge base manager
Author: gnc firstname.lastname@example.org
Copyright: © 2020, gnc
kb is a text-oriented minimalist command line knowledge base manager. kb can be considered a quick note collection and access tool oriented toward software developers, penetration testers, hackers, students or whoever has to collect and organize notes in a clean way. Although kb is mainly targeted on text-based note collection, it supports non-text files as well (e.g., images, pdf, videos and others).
The project was born from the frustration of trying to find a good way to quickly access my notes, procedures, cheatsheets and lists (e.g., payloads) but at the same time, keeping them organized. This is particularly useful for any kind of student. I use it in the context of penetration testing to organize pentesting procedures, cheatsheets, payloads, guides and notes.
I found myself too frequently spending time trying to search for that particular payload list quickly, or spending too much time trying to find a specific guide/cheatsheet for a needed tool. kb tries to solve this problem by providing you a quick and intuitive way to access knowledge.
In few words kb allows a user to quickly and efficiently:
- collect items containing notes,guides,procedures,cheatsheets into an organized knowledge base;
- filter the knowledge base on different metadata: title, category, tags and others;
- visualize items within the knowledge base with (or without) syntax highlighting;
- grep through the knowledge base using regexes;
- import/export an entire knowledge base;
Basically, kb provides a clean text-based way to organize your knowledge.
To install the most recent stable version of kb just type:
pip install -U kb-manager
If you want to install the bleeding-edge version of kb (that may have some bugs) you should do:
git clone https://github.com/gnebbia/kb cd kb pip install -r requirements.txt python setup.py install
Tip for GNU/Linux and MacOS users: For a better user experience, also set the following kb bash aliases:
cat <<EOF > ~/.kb_alias alias kbl="kb list" alias kbe="kb edit" alias kba="kb add" alias kbv="kb view" alias kbd="kb delete --id" alias kbg="kb grep" alias kbt="kb list --tags" EOF echo "source ~/.kb_alias" >> ~/.bashrc source ~/.kb_alias
Tip for Windows users: Do not use notepad as %EDITOR%, kb is not compatible with notepad, a reasonable alternative is notepad++.
Please upgrade kb frequently by doing:
pip install -U kb-manager
A docker setup has been included to help with development.
To install and start the project with docker:
docker-compose up -d docker-compose exec kb bash
The container has the aliases included in its
.bashrc so you can use
kb in the running container as you would if you installed it on the
host directly. The
./docker/data directory on the host is bound to
/data in the container, which is the image's working directly also.
To interact with the container, place (or symlink) the files on your host
./docker/data directory, which can then be seen and used in
/data directory in the container.
A quick demo of a typical scenario using kb:
A quick demo with kb aliases enabled:
A quick demo for non-text documents:
List all artifacts contained in the kb knowledge base
kb list # or if aliases are used: kbl
List all artifacts containing the string "zip"
kb list zip # or if aliases are used: kbl zip
List all artifacts belonging to the category "cheatsheet"
kb list --category cheatsheet # or kb list -c cheatsheet # or if aliases are used: kbl -c cheatsheet
List all the artifacts having the tags "web" or "pentest"
kb list --tags "web;pentest" # or if aliases are used: kbl --tags "web;pentest"
List using "verbose mode"
kb list -v # or if aliases are used: kbl -v
Add a file to the collection of artifacts
kb add ~/Notes/cheatsheets/pytest # or if aliases are used: kba ~/Notes/cheatsheets/pytest
Add a file to the artifacts
kb add ~/ssh_tunnels --title pentest_ssh --category "procedure" \ --tags "pentest;network" --author "gnc" --status "draft"
Add all files contained in a directory to kb
kb add ~/Notes/cheatsheets/general/* --category "cheatsheet"
Create a new artifact from scratch
kb add --title "ftp" --category "notes" --tags "protocol;network" # a text editor ($EDITOR) will be launched for editing
Delete an artifact by ID
kb delete --id 2 # or if aliases are used: kbd 2
Delete multiple artifacts by ID
kb delete --id 2 3 4 # or if aliases are used: kbd 2 3 4
Delete an artifact by name
kb delete --title zap --category cheatsheet
View an artifact by id
kb view --id 3 # or kb view -i 3 # or kb view 3 # or if aliases are used: kbv 3
View an artifact by name
kb view --title "gobuster" # or kb view -t "gobuster" # or kb view gobuster
View an artifact without colors
kb view -t dirb -n
View an artifact within a text-editor
kb view -i 2 -e # or if aliases are used: kbv 2 -e
Editing artifacts involves opening a text editor. Hence, binary files cannot be edited by kb.
The editor can be set by the "EDITOR" environment variable.
Edit an artifact by id
kb edit --id 13 # or kb edit 13 # or if aliases are used: kbe 13
Edit an artifact by name
kb edit --title "git" --category "cheatsheet" # or kb edit -t "git" -c "cheatsheet" # or if git is a unique artifact kb edit git
Grep through artifacts
Grep through the knowledge base
kb grep "[bg]zip" # or if aliases are used: kbg "[bg]zip"
Grep (case-insensitive) through the knowledge base
kb grep -i "[BG]ZIP"
Grep in "verbose mode" through the knowledge base
kb grep -v "[bg]zip"
Import/Export/Erase a knowledge base
Export the current knowledge base
To export the entire knowledge base, do:
This will generate a .kb.tar.gz archive that can be later be imported by kb.
If you want to export only data (so that it can be used in other software):
kb export --only-data
This will export a directory containing a subdirectory for each category and within these subdirectories we will have all the artifacts belonging to that specific category.
Import a knowledge base
kb import archive.kb.tar.gz
NOTE: Importing a knowledge base erases all the previous data. Basically it erases everything and imports the new knowledge base.
Erase the entire knowledge base
kb supports custom templates for the artifacts. A template is basically a file using the "toml" format, structured in this way:
TITLES = [ "^#.*", "blue", ] WARNINGS = [ "!.*" , "yellow",] COMMENTS = [ ";;.*", "green", ]
Where the first element of each list is a regex and the second element is a color.
Note that by default an artifact is assigned with the 'default' template, and this template can be changed too (look at "Edit a template" subsection).
List available templates
To list all available templates:
kb template list
To list all the templates containing the string "theory":
kb template list "theory"
Create a new template
Create a new template called "lisp-cheatsheets", note that an example template will be put as example in the editor.
kb template new lisp-cheatsheets
Delete a template
To delete the template called "lisp-cheatsheets" just do:
kb template delete lisp-cheatsheets
Edit a template
To edit the template called "listp-cheatsheets" just do:
kb template edit lisp-cheatsheets
Add a template
We can also add a template from an already existing toml configuration file by just doing:
kb template add ~/path/to/myconfig.toml --title myconfig
Change template for an artifact
We can change the template for an existing artifact by ID by using the update command:
kb update --id 2 --template "lisp-cheatsheets"
Apply a template to all artifacts of a category
We can apply the template "lisp-cheatsheets" to all artifacts belonging to the category "lispcode" by doing:
kb template apply "lisp-cheatsheets" --category "lispcode"
Apply a template to all artifacts having zip in their title
We can apply the template "dark" to all artifacts having in their title the string "zip" (e.g., bzip, 7zip, zipper) by doing:
kb template apply "dark" --title "zip" --extended-match # or kb template apply "dark" --title "zip" -m
We can always have our queries to "contain" the string by using
--extended-match option when using
kb template apply.
Apply a template to all artifacts having specific properties
We can apply the template "light" to all artifacts of the category "cheatsheet" who have as author "gnc" and as status "OK" by doing:
kb template apply "light" --category "cheatsheet" --author "gnc" --status "OK"
If you want to upgrade kb to the most recent stable release do:
pip install -U kb-manager
If instead you want to update kb to the most recent release (that may be bugged), do:
git clone https://github.com/gnebbia/kb cd kb pip install --upgrade .
I am an independent developer working on kb in my free time, if you like kb and would like to say thank you, buy me a beer!
Copyright 2020 Giuseppe Nebbione.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size kb_manager-0.1.5-py2.py3-none-any.whl (55.5 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size kb-manager-0.1.5.tar.gz (82.3 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for kb_manager-0.1.5-py2.py3-none-any.whl