How basecamp/omakub works
Project type and purpose
• Omakub is a CLI-based system configurator and installer for Ubuntu.
• It’s built entirely with shell scripts and organized as an opinionated, plugin-style toolset to bootstrap a modern web-dev workstation in one command.
File structure
• Top-level “bin/omakub” and “install.sh” act as entrypoints.
• “install/” contains categorized installers (desktop, terminal, optional, required).
• “uninstall/” mirrors install for cleanup.
• “migrations/” scripts upgrade older Omakub installs.
• “configs/”, “themes/”, “defaults/”, “applications/” hold payloads and configuration templates.
• “EXTENSIONS.md” lists community add-ons; “version” tracks the tool’s release.
Key README insights
• Single command invocation that delegates to the orchestrator.
• Opinionated default settings but extensible via extras and extensions.
• Shells, editors, apps, theming, and system preferences.
Main components and their interactions
a. Orchestration Layer
– CLI entrypoint (boot.sh / bin/omakub)
– install.sh (master script)
– migrations runner (executes “migrations/*.sh” if version has changed)
b. Module Layer
– Desktop installers (install/desktop/*)
– Terminal installers (install/terminal/*)
– Optional feature installers (nested under “optional/”)
– Uninstallers (“uninstall/…”)
– Application scripts (applications/*.sh)
– Config loaders (configs/, defaults/)
– Theme applier (themes/)
c. External-systems Layer
– Package managers (apt, flatpak)
– GNOME settings (gsettings)
– Third-party CLIs (gum, fzf, lazygit, etc.)
– Shell (bash, zsh), terminal emulator (Alacritty), editor (Neovim), code editor (VSCode)
Architectural patterns and design principles
• Modular plugin pattern: each installer or config file is its own script or directory.
• Layered orchestration: entrypoint → version check/migrations → install modules → config/theme apply → exit.
• Convention-over-configuration: directory naming maps to functional phases automatically.
• Idempotent scripts: modules can be re-run without side-effects (leveraging checks inside each .sh).