GitHub - ravijanjam/qkw: Generalizing aliasing to simplify navigation, alias CLI command sequence nuances, annotate, add help-strings, etc (original) (raw)

QKW | Generalizing Aliasing

Simplify navigation, alias CLI command sequence nuances, annotate, add help-strings, etc¶

The purpose of this application is to tag anything with a label and, use it to retrieve the associated data for other applications. Data is stored as:

    <label> :
        <data>

        <help-string,annotation,stdout,etc>

    (or)

    <label>:<data>

Features

• Directory navigation: Use the bookmarked keys to hop across directories
• Assign tags/labels to programmable/non-programmable structures.
• Add a help-string or note with the associated data.
• Store, retrieve and search the data in a file rather than a executable script, formatted as a string.
• Clipboard: to store the stdout/stderr for inspection or analysis.
• Manage API distribution w/documentation: Easily share the functional blocks of your application like initialization, settings, etc by just sharing the database, where user is abstracted away from the details and focuses on using the functionality by mere execution of the tags.
• DevOps automation :
  • Rapidly create variations, and save them with a versioned tag.
  • Quickly test a set of commands with different options in different environments.
  • Replace shell/bash aliasing using qkw's dynamic tagging.
  • Similar functionality, but different command base/ options can be tagged with identical tags and executed.

For example:

In different linux flavors, one might be repeating identical functionality in different environments. One of the first things a user would like to do is to have their bashrc configured with their personal set of commands.

Sourcing the tags opensuse.bashrc, and ubuntu.bashrc would readily setup your environment. The data for OS specific environments are in the command tables.

Getting Started

Manual contains information about use cases, and all the available options.

QuickStart guide helps you get started with using the basic commands.

Installation (Ubuntu/Debian)

• download and install the deb package from relases.

dpkg -i qkw-.deb

or

apt install ./qkw-.deb

• Clone the repo

git clone https://github.com/ravijanjam/qkw.git cd qkw

• Install the dependencies

apt-get update apt-get install -y git gcc g++ pkg-config cmake make apt-get install -y libsqlite3-dev libyaml-cpp-dev

• To keep building simple, a python script is set up which checks for requirements (fmt,sqlite3,yaml), and a sanity check for required headers. Any errors will be in writen to the log file
• If necessary, modify the compile options OPTS_SQLITE_3,OPTS_YAML-CPP,OPTS_FMT in the Makefile, to point to the libs, and headers. There are subtle differences in libraries installed via lib as a dev package or via compiled libraries. pkg-config provided options can work as well.
• Get into the build directory, and follow instructions for installing the dependencies [fmt], and [yaml-cpp]
• Running checktools.py should download the github repos for fmt, and yaml into [build] directory. Check the log files in the same directory as the script executes or breaks

make build make install make clean

Set up the environment variable:

export QKW_CONFIG=~/.config/qkw/qkw-config.yaml

You can find an example template here.

It's recommended to place userdata.db in the ~/.local/share/qkw/ directory and reference it in the qkw-config.yaml file.

Start the program and check the default tables userdata.db has two tables dir_1, and cmd_1

get version info

qkw -v

list all tables

qkw -T -lA

man pages

man qkw

The basic tables used to store the data

• cmd :commands,scripts,etc with a note
• dir :directory paths

CMD tables

DIR tables

Category : CLI tools, productivity, bash utility, aliasing, labeling, sqlite, g++, commandline, documentation, docstring