kb. A minimalist knowledge base manager

Purpose

Cheatsheets are helpful, especially everyone on a team is using the same cheatsheets.

Follow the instructions below to install:

kb (a command-line app for cheatsheets)
our shared collection of cheetsheets

Installation

Make sure you're running a current version of Python

python --version

If you don't have Python 3.6 or above installed, ask for help.

Step 1: Clone this repo and checkout the last stable release

In the local directory you use to store repos:

git clone git@github.com:ryandeussing/kb.git

Checkout the last stable release:

git checkout v0.1.6

☝️ important: only that version supports git sync

Step 2: Install the `kb` app dependencies

cd into the the kb directory you just cloned and then run the command for your operating system

A. On MacOS:

pip3 install -r requirements.txt

B. On RHEL CSB:

sudo pip3 install -r requirements.txt

Step 3: Install the `kb` app

Run the command for your operating system

A. On MacOS:

python setup.py install

B. On RHEL CSB:

sudo python setup.py install

Step 4: Make sure your PATH is setup

Quit and restart your terminal.

Then run the command

kb -h

If that doesn't print out a list of commands, ask for help.

Step 5: Setup and test sync

Remove any ~/.kb directory that may exist

rm -rf ~/.kb

Clone our shared cheatsheets into a ~/.kb directory

git clone git@github.com:ryandeussing/kbsync.git ~/.kb

Open a new terminal window and run

kb list

If you don't see a list of cheatsheets, ask for help.

Sync changes

kb sync pull

If you don't see Repository correctly synchronized from remote!, ask for help.

Usage

kb list will list the cheatsheets in the knowlege base

kb view 0 will print out the contents of the cheatsheet in position 0

Note, it may be useful to us kb in a separate terminal tab so cheatsheet content doesn't interrupt your terminal workflow.

COPYRIGHT

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/.

ryandeussing/kb