Skip to content
Ravi J edited this page Dec 31, 2020 · 28 revisions

Use tags/labels to simplify navigation; store, retrieve, and search formatted data for an application

The application to which tagged data is to be passed to is purely arbitrary and is left to ones imagination

The data could be

  • code
  • notes
  • help-strings
  • long-lasting clipboard
  • etc

and the labels could be anything that's easy to recall, without any restriction to the characters that are allowed.

  • @w, if the user likes to store URLS
  • m.1,m.2,..., for a version of something
  • etc

The biggest advantage of having formatted data implies, it can be passed to macros or other applications to perform complex operations with a unique tag/label.

macro qkw-tag <options>

Examples:

While software manual pages have a lot of content, often times, a small subset of options is all that an end user needs on a daily basis. This is particularly true with scripting and programming where a set of structured block of code is to be saved along with a help-string. In the software domain, help-strings are really the key to recall what the block of code does saving a lot of time invested in discovering something that works.

Most of the modern backend utilities have too many options to play with. On a daily basis end-user might need only a fixed set of options with minimal number of variables. Hence, having a system that just lets you do that with a tag could be immensely useful.

Consider for example, the kubernetes commands

# 1
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'

# 2
kubectl config view -o jsonpath='{.users[?(@.name == "b2b")].user.password}'

# loading qkw with above commands and assigning aliases
# the variations are easy to recall
macro ke.pass # will execute 1
macro kb.pass # will execute 2

A user having to type the entire command is quite clumsy. Instead, an alias would do a job fine, and having a system of easy to recall aliases and their variations would save a lot of typing, and having to remember. The following two commands easen the burden of :

  • searching what's in an alias
  • getting the help-string
    • what the command does
    • how to use it
# search for the command
qkw -sC <string>

# execute the command
macro tag <options>

qkw helps with note-taking functional blocks of code, so that programmer can save things that were discovered when inspiration strikes and retrieve it in the future, and especially during the rapid-prototyping phase.

Having a system that helps store the content in a searchable format with help-strings would ensure the programmer is not loosing the time spent on discovering the pieces that are useful.

qkw helps simplify automation as well. A lot of functionality could be stored in file with almost negligible storage space, and executed in multiple environments without much change.

A wealth of environment specific functionality could be stored and executed by just copying the database and any binding programs/scripts to the new location

Clone this wiki locally