https://github.com/qompassai/qonfig
Qonfig: A Quality Dotfile Manager
https://github.com/qompassai/qonfig
Last synced: about 1 month ago
JSON representation
Qonfig: A Quality Dotfile Manager
- Host: GitHub
- URL: https://github.com/qompassai/qonfig
- Owner: qompassai
- License: agpl-3.0
- Created: 2025-07-24T01:10:43.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-01-19T06:20:06.000Z (5 months ago)
- Last Synced: 2026-01-19T14:13:16.401Z (4 months ago)
- Language: Python
- Size: 360 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-AGPL
- Citation: CITATION.cff
- Zenodo: .zenodo.json
Awesome Lists containing this project
README
Qompass AI Qonfig
A Quality Dotfile Manager
▶️ Qompass AI Quick Start
```sh
curl -fsSL https://raw.githubusercontent.com/qompassai/qonfig/main/scripts/quickstart.sh | sh
```
📄 We advise you read the script BEFORE running it 😉
#!/usr/bin/env bash
# /qompassai/qonfig/scripts/quickstart.sh
# Qompass AI Qonfig Quickstart
# Copyright (C) 2025 Qompass AI, All rights reserved
####################################################
set -Eeuo pipefail
INSTALL_DIR="${HOME}/.local/bin"
QONFIG_SCRIPT="bin/qonfig"
SCRIPT_NAME="qonfig"
USE_SYMLINK=false
echoerrcolor() {
if (($colors)); then
case $1 in
none)
str="\e[0;37m"
;;
green)
str="\e[0;32m"
;;
red)
str="\e[0;31m"
;;
blue)
str="\e[1;34m"
;;
darkcyan)
str="\e[0;36m"
;;
darkgreen)
str="\e[1;32m"
;;
darkred)
str="\e[1;31m"
;;
magenta)
str="\e[0;35m"
;;
darkmagenta)
str="\e[1;35m"
;;
esac
echo -ne $str >&2
fi
}
echoerrnocolor() {
if (($colors)); then
echo -ne "\e[0m" >&2
fi
}
echoerr() {
if [ $# -gt 1 ]; then
color=$1
shift
echoerrcolor $color
fi
echo "$@" >&2
if [ $color ]; then
echoerrnocolor
fi
}
printferr() { printf "$@" >&2; }
$(which git >&/dev/null)
if [ $? -eq 1 ]; then
echoerr red "Git not found! Confirm it is indeed installed and reachable."
exit
fi
appendshell() {
case "$1" in
start)
add='echo "Setting up Qonfig. Please do not ^C." >&2;'
;;
mkprefix)
add="mkdir -p $2; cd $2;"
;;
gitinit)
add='git init;'
;;
gitaddsub)
add='git submodule add https://github.com/qompassai/qonfig;'
;;
gitignoredirty)
add='git config -f .gitmodules submodule.qonfig.ignore dirty;'
;;
gitinstallinstall)
add='cp qonfig/tools/git-submodule/install .;'
;;
ensureparentdirs)
add="mkdir -p $2; rmdir $2;"
;;
mv)
add="mv $2 $3;"
;;
echoconfig)
add='echo -e "'$2'" >> '$3';'
;;
runinstaller)
add='./install;'
;;
gitsetname)
if (($3)); then
global=' --global '
else
global=' '
fi
add='git config'$global'user.name "'$2'";'
;;
gitsetemail)
if (($3)); then
global=' --global '
else
global=' '
fi
add='git config'$global'user.email "'$2'";'
;;
gitinitialcommit)
add='git add -A; git commit -m "Initial commit";'
;;
esac
setupshell=$setupshell' '$add
}
testmode=0
verboseconf=0
dumpconf=0
preview=1
colors=0
while [ $# -ne 0 ]; do
case "$1" in
test)
testmode=1
echoerr darkcyan "Test mode enabled."
;;
no-test)
testmode=0
echoerr darkcyan "Test mode disabled."
;;
verbose-config)
verboseconf=1
echoerr darkcyan "Verbose configuration file active."
;;
no-verbose-config)
verboseconf=0
echoerr darkcyan "Concise configuration file active."
;;
dump-config)
dumpconf=1
echoerr darkcyan "Will dump config to stdout."
;;
no-dump-config)
dumpconf=0
echoerr darkcyan "Will not dump config to stdout."
;;
preview)
preview=1
echoerr darkcyan "Will show commands to be executed."
;;
no-preview)
preview=0
echoerr darkcyan "Will not show commands to be executed."
;;
colors)
colors=1
echoerr darkcyan "Will print with colors."
;;
no-colors)
colors=0
echoerr darkcyan "No color."
;;
*)
echoerr red "Unfamiliar configuration option"
;;
esac
shift
done
paths=(
"$HOME/.Xdefaults"
"$HOME/.Xmodmap"
"$HOME/.Xresources"
"$HOME/.bash_aliases"
"$HOME/.bash_logout"
"$HOME/.bash_profile"
"$HOME/.bashrc"
"$HOME/.conkyrc"
"$HOME/.gitconfig"
"$HOME/.i3"
"$HOME/.i3status.conf"
"$HOME/.profile"
"$HOME/.ssh/config"
"$HOME/.tmux.conf"
"$HOME/.vimperatorrc"
"$HOME/.vimrc"
"$HOME/.vim/vimrc"
"$HOME/.xinitrc"
"$HOME/bin"
"${XDG_CONFIG_HOME:-$HOME/.config}/awesome"
"${XDG_CONFIG_HOME:-$HOME/.config}/dmenu"
"${XDG_CONFIG_HOME:-$HOME/.config}/i3"
"${XDG_CONFIG_HOME:-$HOME/.config}/obmenu-generator"
"${XDG_CONFIG_HOME:-$HOME/.config}/openbox"
"${XDG_CONFIG_HOME:-$HOME/.config}/pianobar"
"${XDG_CONFIG_HOME:-$HOME/.config}/redshift"
"${XDG_CONFIG_HOME:-$HOME/.config}/tint2"
"${XDG_CONFIG_HOME:-$HOME/.config}/vimprobable"
"$HOME/.zprofile"
"$HOME/.zshenv"
"$HOME/.zshrc"
)
setupshell=''
dotclean=''
dotlink=''
dotshell=''
installerrun=1
echoerr blue "Welcome to the Qonfig generator"
echoerr blue "Please be aware that if you have a complicated setup, you may need more customization than this script offers."
echoerr
echoerr blue "At any time, press ^C to quit. No changes will be made until you confirm."
echoerr
appendshell start
prefix="{$HOME}/.dotfiles"
prefixfull="${prefix/\~/${HOME}}"
if ! [ -d "$prefixfull" ]; then
echoerr darkcyan "${prefix} is not in use."
else
echoerr darkcyan "${prefix} exists and may have another purpose than ours."
fi
while true; do
read -r -p "Where do you want your dotfiles repository to be? ($prefix) " answer
if [ -z "$answer" ]; then
break
else
echoerr red "FEATURE NOT YET SUPPORTED."
echoerr red "Sorry for misleading you."
echoerr
fi
done
appendshell mkprefix "$prefix"
appendshell gitinit
while true; do
read -p "Shall we add Qonfig as a submodule (default)? (Y/n) " answer
if [ -z "$answer" ]; then
answer='y'
fi
case "$answer" in
Y* | y*)
echoerr green "Will do."
appendshell gitaddsub
appendshell gitignoredirty
appendshell gitinstallinstall
break
;;
N* | n*)
echoerr darkgreen "Okay, I shall not. You will need to manually set up your install script."
installerrun=0
break
;;
*)
echoerr red "Answer not understood: ${answer}"
;;
esac
done
while true; do
read -p "Do you want Qonfig to clean ~/ of broken links added by Qonfig (recommended) (Y/n) " answer
if [ -z "$answer" ]; then
answer='y'
fi
case "$answer" in
Y* | y*)
echoerr green "I will ask Qonfig to clean."
dotclean="- clean: ['~']"
break
;;
N* | n*)
echoerr darkgreen "Not asking Qonfig to clean."
break
;;
*)
echoerr red "Only Y/y/N/n are accepted as answers, please try again: ${answer}"
;;
esac
done
declare -a linksection
declare -i i
for item in ${paths[*]}; do
fullname="${item/\~/$HOME}"
if [ -h $fullname ]; then
continue
fi
if [ -f $fullname ] || [ -d $fullname ]; then
while true; do
read -p "I found ${item}, do you want to Qonfig it? (Y/n) " answer
if [ -z "$answer" ]; then
answer='y'
fi
case "$answer" in
Y* | y*)
linksection[$i]=$item
i=$i+1
echoerr green "Qonfigured!"
break
;;
N* | n*)
echoerr darkgreen "Not added to Qonfig."
break
;;
*)
echoerr red "Answer not understood: ${answer}"
;;
esac
done
fi
done
dotlink='- link:'
newline='\n'
hspace='\x20\x20\x20\x20'
for item in ${linksection[*]}; do
fullname="${item/\~/$HOME}"
firstdot=$(echo "$item" | sed -n "s/[.].*//p" | wc -c)
firstslash=$(echo "$item" | sed -n "s/[/].*//p" | wc -c)
if [ -d $fullname ]; then
itempath=$item'/'
else
itempath=$item
fi
if [[ $firstdot -gt $firstslash ]]; then
itempath=${itempath:$firstdot}
else
itempath=${itempath:$firstslash}
fi
nextslash=$(echo "$itempath" | sed -n "s/[/].*//p" | wc -c)
if [[ $nextslash -gt 0 ]]; then
entryisdir='true'
else
entryisdir='false'
fi
if (("$verboseconf")); then
new_entry=$newline$hspace$item':'
new_entry=$new_entry$newline$hspace$hspace'path: '$itempath
new_entry=$new_entry$newline$hspace$hspace'create: '$entryisdir
new_entry=$new_entry$newline$hspace$hspace'relink: false'
new_entry=$new_entry$newline$hspace$hspace'force: false'
elif [[ $entryisdir = 'false' ]]; then
new_entry=$newline$hspace$item': '$itempath
else
new_entry=$newline$hspace$item':'
new_entry=$new_entry$newline$hspace$hspace'path: '$itempath
new_entry=$new_entry$newline$hspace$hspace'create: '$entryisdir
fi
appendshell ensureparentdirs $itempath
appendshell mv $item $itempath
dotlink="$dotlink$new_entry"
done
export qonfigyaml="$dotclean$newline$newline$dotlink$newline$newline$dotshell"
appendshell echoconfig "$qonfigyaml" 'qonfig.yaml'
getgitinfo=0
gitinfoglobal=0
if (("$installerrun")); then
$(git config user.name >&/dev/null && git config user.email >&/dev/null)
if [ $? -ne 0 ]; then
echoerr darkred "Please note you do not have a name or email set for git."
echoerr darkred "I shall not be able to commit unless you set the missing variables."
while [ 1 ]; do
read -p "Do you want to set them? (Y/n) " answer
if [ -z "$answer" ]; then
answer='y'
fi
case "$answer" in
Y* | y*)
getgitinfo=1
break
;;
N* | n*)
echoerr darkgreen "Okay, I shall not."
getgitinfo=0
installerrun=0
break
;;
*)
echoerr red "Answer not understood: ${answer}"
;;
esac
done
while [ 1 ]; do
read -p "Do you want these settings to be global? (Y/n) " answer
if [ -z "$answer" ]; then
answer='y'
fi
case "$answer" in
Y* | y*)
echoerr green "Adding --global to the set commands."
gitinfoglobal=1
break
;;
N* | n*)
echoerr green "Okay, I shall make them local."
gitinfoglobal=0
break
;;
*)
echoerr red "Answer not understood: ${answer}"
;;
esac
done
fi
fi
if (("$getgitinfo")); then
$(git config user.name >&/dev/null)
if [ $? -ne 0 ]; then
gitname="FirstName LastName"
else
gitname="$(git config user.name)"
fi
$(git config user.email >&/dev/null)
if [ $? -ne 0 ]; then
gitemail="FirstName.LastName@example.com"
else
gitemail="$(git config user.email)"
fi
read -p "What do you want for your git name? [${gitname}]" answer
if [ -z "$answer" ]; then
answer="$gitname"
fi
gitname="$answer"
read -p "What do you want for your git email? [${gitemail}]" answer
if [ -z "$answer" ]; then
answer="$gitemail"
fi
gitemail="$answer"
appendshell gitsetname "$gitname" $gitinfoglobal
appendshell gitsetemail "$gitemail" $gitinfoglobal
fi
while (($installerrun)); do
read -p "Shall I run the installer? (Necessary to git commit) (Y/n) " answer
if [ -z "$answer" ]; then
answer='y'
fi
case "$answer" in
Y* | y*)
echoerr green "Will do."
appendshell runinstaller
break
;;
N* | n*)
echoerr darkgreen "Okay, I shall not. You will need to take care of that yourself."
installerrun=0
break
;;
*)
echoerr red "Answer not understood: ${answer}"
;;
esac
done
while (($installerrun)); do
read -p "Shall I make the initial commit? (Y/n) " answer
if [ -z "$answer" ]; then
answer='y'
fi
case "$answer" in
Y* | y*)
echoerr green "Will do."
appendshell gitinitialcommit
break
;;
N* | n*)
echoerr darkgreen "Okay, I shall not. You will need to take care of that yourself."
break
;;
*)
echoerr red "Answer not understood: ${answer}"
;;
esac
done
echoerr
if (($dumpconf)); then
echo -e "$dotlink"
echoerr
fi
echoerr magenta "The below are the actions that will be taken to setup Qonfig."
if (($testmode)); then
echoerr darkmagenta "Just kidding. They won't be."
fi
if (($preview)); then
printferr "\n${setupshell//; /;\\n}\n\n" # place newline after each command for printing
warningmessage='If you do not see a problem with the above commands, press enter. '
else
warningmessage=''
fi
echoerrcolor darkred
read -p "${warningmessage}This is your last chance to press ^C before actions are taken that should not be interrupted. "
echoerrnocolor
if ! (($testmode)); then
eval $setupshell
fi
function info() {
printf "\033[1;32m[info]\033[0m %s\n" "$*"
}
function error() {
printf "\033[1;31m[error]\033[0m %s\n" "$*" >&2
exit 1
}
function check_dependencies() {
command -v python3 >/dev/null || error "python3 is required"
}
function find_repo_root() {
git rev-parse --show-toplevel 2>/dev/null || pwd
}
function install_qonfig() {
REPO_ROOT=$(find_repo_root)
QONFIG_SRC="${REPO_ROOT}/${QONFIG_SCRIPT}"
[[ -f "${QONFIG_SRC}" ]] || error "Missing Qonfig at ${QONFIG_SRC}"
mkdir -p "${INSTALL_DIR}"
local target="${INSTALL_DIR}/${SCRIPT_NAME}"
if $USE_SYMLINK; then
ln -sf "${QONFIG_SRC}" "${target}"
info "Symlinked qonfig → ${target}"
else
cp "${QONFIG_SRC}" "${target}"
chmod +x "${target}"
info "Copied Qonfig to ${target}"
fi
info "Qonfig installed to ${target}"
}
function main() {
check_dependencies
install_qonfig
}
main "$@"
Or, View
the quickstart script.
🧭 About Qompass AI
Matthew A. Porter
Former Intelligence Officer
Educator & Learner
DeepTech Founder & CEO
Publications
Developer Programs
[](https://developer.nvidia.com/)
[](https://developers.facebook.com/)
[](https://hackerone.com/phaedrusflow)
[](https://huggingface.co/qompass)
[](https://dev.epicgames.com/)
Professional Profiles
Social Media
🔥 How Do I Support
🏛️ Qompass AI Pre-Seed Funding 2023-2025
🏆 Amount
📅 Date
RJOS/Zimmer Biomet Research Grant
$30,000
March 2024
Pathfinders Intern
Program
View on LinkedIn
$2,000
October 2024
🤝 How To Support Our Mission
[](https://github.com/sponsors/phaedrusflow)
[](https://patreon.com/qompassai)
[](https://liberapay.com/qompassai)
[](https://opencollective.com/qompassai)
[](https://www.buymeacoffee.com/phaedrusflow)
🔐 Cryptocurrency Donations
**Monero (XMR):**
42HGspSFJQ4MjM5ZusAiKZj9JZWhfNgVraKb1eGCsHoC6QJqpo2ERCBZDhhKfByVjECernQ6KeZwFcnq8hVwTTnD8v4PzyH
📋 Copy Address
Funding helps us continue our research at the intersection of AI, healthcare, and education
Frequently Asked Questions
### Q: How do you mitigate against bias?
**TLDR - we do math to make AI ethically useful**
### A: We delineate between mathematical bias (MB) - a fundamental parameter in neural network equations - and
algorithmic/social bias (ASB). While MB is optimized during model training through backpropagation, ASB requires
careful consideration of data sources, model architecture, and deployment strategies. We implement attention
mechanisms for improved input processing and use legal open-source data and secure web-search APIs to help mitigate
ASB.
[AAMC AI Guidelines | One way to align AI against
ASB](https://www.aamc.org/about-us/mission-areas/medical-education/principles-ai-use)
### AI Math at a glance
## Forward Propagation Algorithm
$$
y = w\_1x\_1 + w\_2x\_2 + ... + w\_nx\_n + b
$$
Where:
* $y$ represents the model output
* $(x\_1, x\_2, ..., x\_n)$ are input features
* $(w\_1, w\_2, ..., w\_n)$ are feature weights
* $b$ is the bias term
### Neural Network Activation
For neural networks, the bias term is incorporated before activation:
$$
z = \sum\_{i=1}^{n} w\_ix\_i + b
$$
$$
a = \sigma(z)
$$
Where:
* $z$ is the weighted sum plus bias
* $a$ is the activation output
* $\sigma$ is the activation function
### Attention Mechanism- aka what makes the Transformer (The "T" in ChatGPT) powerful
* [Attention High level overview video](https://www.youtube.com/watch?v=fjJOgb-E41w)
* [Attention Is All You Need Arxiv Paper](https://arxiv.org/abs/1706.03762)
The Attention mechanism equation is:
$$
\text{Attention}(Q, K, V) = \text{softmax}\left( \frac{QK^T}{\sqrt{d\_k}} \right) V
$$
Where:
* $Q$ represents the Query matrix
* $K$ represents the Key matrix
* $V$ represents the Value matrix
* $d\_k$ is the dimension of the key vectors
* $\text{softmax}(\cdot)$ normalizes scores to sum to 1
### Q: Do I have to buy a Linux computer to use this? I don't have time for that!
### A: No. You can run Linux and/or the tools we share alongside your existing operating system:
* Windows users can use Windows Subsystem for Linux [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
* Mac users can use [Homebrew](https://brew.sh/)
* The code-base instructions were developed with both beginners and advanced users in mind.
### Q: Do you have to get a masters in AI?
### A: Not if you don't want to. To get competent enough to get past ChatGPT dependence at least, you just need a
computer and a beginning's mindset. Huggingface is a good place to start.
* [Huggingface](https://docs.google.com/presentation/d/1IkzESdOwdmwvPxIELYJi8--K3EZ98_cL6c5ZcLKSyVg/edit#slide=id.p)
### Q: What makes a "small" AI model?
### A: AI models ~=10 billion(10B) parameters and below. For comparison, OpenAI's GPT4o contains approximately 200B parameters.
What a Dual-License Means
### Protection for Vulnerable Populations
The dual licensing aims to address the cybersecurity gap that disproportionately affects underserved populations. As
highlighted by recent attacks\[1], low-income residents, seniors, and foreign language
speakers face higher-than-average risks of being victims of cyberattacks. By offering both open-source and
commercial licensing options, we encourage the development of cybersecurity solutions that can reach these
vulnerable groups while also enabling sustainable development and support.
### Preventing Malicious Use
The AGPL-3.0 license ensures that any modifications to the software remain open source, preventing bad actors from
creating closed-source variants that could be used for exploitation. This is especially crucial given the rising
threats to vulnerable communities, including children in educational settings. The attack on Minneapolis Public
Schools, which resulted in the leak of 300,000 files and a $1 million ransom demand, highlights the importance of
transparency and security\[8].
### Addressing Cybersecurity in Critical Sectors
The commercial license option allows for tailored solutions in critical sectors such as healthcare, which has seen
significant impacts from cyberattacks. For example, the recent Change Healthcare attack\[4] affected millions of Americans and caused widespread disruption for hospitals and
other providers. In January 2025, CISA\[2] and FDA\[3]
jointly warned of critical backdoor vulnerabilities in Contec CMS8000 patient monitors, revealing how medical
devices could be compromised for unauthorized remote access and patient data manipulation.
### Supporting Cybersecurity Awareness
The dual licensing model supports initiatives like the Cybersecurity and Infrastructure Security Agency (CISA)
efforts to improve cybersecurity awareness\[7] in "target rich" sectors, including
K-12 education\[5]. By allowing both open-source and commercial use, we aim to
facilitate the development of tools that support these critical awareness and protection efforts.
### Bridging the Digital Divide
The unfortunate reality is that too many individuals and organizations have gone into a frenzy in every facet of our
daily lives\[6]. These unfortunate folks identify themselves with their talk of "10X"
returns and building towards Artificial General Intelligence aka "AGI" while offering GPT wrappers. Our dual
licensing approach aims to acknowledge this deeply concerning predatory paradigm with clear eyes while still
operating to bring the best parts of the open-source community with our services and solutions.
### Recent Cybersecurity Attacks
Recent attacks underscore the importance of robust cybersecurity measures:
* The Change Healthcare cyberattack in February 2024 affected millions of Americans and caused significant
disruption to healthcare providers.
* The White House and Congress jointly designated October 2024 as Cybersecurity Awareness Month. This designation
comes with over 100 actions that align the Federal government and public/private sector partners are taking to help
every man, woman, and child to safely navigate the age of AI.
By offering both open source and commercial licensing options, we strive to create a balance that promotes
innovation and accessibility. We address the complex cybersecurity challenges faced by vulnerable populations and
critical infrastructure sectors as the foundation of our solutions, not an afterthought.
### References
[1] International
Counter Ransomware Initiative 2024 Joint Statement
[2] Contec
CMS8000 Contains a Backdoor
[3] CISA,
FDA warn of vulnerabilities in Contec patient monitors
[4] The
Top 10 Health Data Breaches of the First Half of 2024
[5] CISA's K-12 Cybersecurity
Initiatives
[7] A
Proclamation on Cybersecurity Awareness Month, 2024
[8] Minneapolis school
district says data breach affected more than 100,000 people