How akitaonrails/omakub-mj works
Project type and purpose
• This is a CLI-driven, opinionated bootstrap/automation tool for turning a fresh Manjaro GNOME install into a fully-configured web-development workstation.
• It consists entirely of shell scripts, configuration files, themes, migrations and small “application‐wrapper” scripts.
File structure
• Top-level orchestrator:
– boot.sh: downloads & kicks off the installer
– install.sh: entry point for all install sequences
• Installation modules (install/):
– install/desktop/: desktop-app installers & settings
– install/terminal/: CLI-tool installers & settings
– install/first-run-choices.sh, check-version.sh, etc.
• Configuration modules:
– configs/: concrete config files for Alacritty, Neovim, Zsh, VSCode, Ulauncher, etc.
– defaults/: baseline “defaults” for Bash, Zsh, xcompose
• Theme modules:
– themes/: per-theme subfolders containing theme-specific configs/scripts
– set-* scripts to apply a theme globally
• Applications wrappers (applications/ & bin/):
– applications/*.sh: short launcher scripts for installed apps
– bin/: utility scripts (omakub, omakub-sub) for driving menus, font sizes, installer tasks
• Migration scripts:
– migrations/*.sh: idempotent scripts to migrate existing installs to new versions
• Uninstaller:
– uninstall/*.sh: reverse of install for apps, languages, Docker, shell prompt, etc.
Readme insights
• Single‐command “boot” → orchestrator runs installer → installs packages, applies configs, sets themes.
• Integrates external systems: pacman/Docker/flatpak, GNOME settings, Zellij, Neovim, Atuin.
Main components & interactions
a. Core orchestrator
• boot.sh/download pipeline → install.sh
• check-version → first-run choices
b. Install modules
• Desktop installers → GNOME apps + settings
• Terminal installers → CLI tools + shell libs
• Each installer invokes specific scripts under install/desktop or install/terminal
c. Config & defaults application
• Post-install, copy or symlink configs/ & defaults/ into $HOME/.config or shell rc files
d. Themes
• Developer selects theme → calls set-chrome, set-gnome, set-vscode, etc.
• Scripts under themes/* orchestrate per-component theming
e. Migration
• On each run, detect version change → execute pending migrations/*.sh
f. Uninstaller
• mirror image of installers to remove packages and revert configs
g. Application wrappers & utilities
• invoked by user for quick access or further configuration
Architectural patterns & principles
• Modular directories by concern (install, config, theme, migrations, uninstall)
• Orchestrator + plugins pattern: installer calls sub-scripts like plugins
• Idempotence: each script can be re-run safely
• Convention over configuration: fixed layout under configs/ and themes/