Prerequisites

To use this dotfiles setup, you need to be able to get the repository onto your machine. You have several options:

1. Best: Use GitHub CLI (gh) with authentication
2. Good: Use git clone with SSH or HTTPS
3. Fallback: Download the ZIP file from GitHub and extract it to ~/dotfiles

The setup script will install git and other missing tools if needed.

Installation

Clone and run

With GitHub CLI (recommended)

gh repo clone zeachco/dotfiles ~/dotfiles && bash ~/dotfiles/setup.sh

With git clone

git clone git@github.com:zeachco/dotfiles.git ~/dotfiles && bash ~/dotfiles/setup.sh

Without git (fallback)

Download the repository ZIP, extract it to ~/dotfiles, then run:

bash ~/dotfiles/setup.sh

Update setup

you can just run dotfiles_update and it will reapply all changes and remove deprecated configs if any

Framework Desktop RGB dashboard

On Linux systems with framework_tool, setup builds the Rust RGB monitor and installs it as the privileged framework-rgb@<user>.service system daemon. The eight LEDs form a live dashboard:

0 Temperature   1 GPU load       2 CPU load       3 GPU power
4 RAM usage     5 Disk activity  6 Network traffic 7 llama.cpp

System resources use a light-blue → green → yellow → red gradient. Temperature maps 30–90°C; the remaining resources map idle to their configured maximum. The llama.cpp indicator is white when idle, fades toward red as slots fill, turns red at full capacity, flashes red/off when the router service is active but unavailable, and turns off when the router is stopped. The monitor polls llama.cpp every two seconds and system resources every eight seconds.

Useful commands:

systemctl status framework-rgb@"$USER".service
journalctl -u framework-rgb@"$USER".service -f

Optional environment overrides can be added to the system unit for MAX_TEMPERATURE_C (default 90), MAX_POWER_WATTS (120), MAX_DISK_MBPS (1000), and MAX_NETWORK_MBPS (1000).

Ubuntu special case

For ubuntu, it also installs omakub it's just too good to ignore, other OS manually installs the good parts of omakub that I want there like zellij, nvim, sh utils configs

Supports

• linux debian/arch based (with apt-get such as Ubuntu)
• linux debian/arch based (with pacman such as Manjaroo)
• maxos (with xcode)
• spin cloud debian-based server
• extensible by profile

Includes

How this repo works

The repository uses a profile-based approach for different environments. When you run setup.sh:

1. It automatically detects your operating system and environment (macOS, Arch, Debian, Ubuntu, Termux, etc.).
2. It first runs the common profile which installs the base set of tools and configurations using stow for symlinking configs/ into your $HOME.
3. It then runs the specific profile for your OS (e.g. variants/osx, variants/ubuntu).
4. Profiles use a helper script (utils.sh) to intelligently manage dependencies across OS package managers (apt, pacman, brew, pkg).
5. It safely injects a source hook into your shell's initialization file (~/.bashrc, ~/.zshrc, etc.) to load aliases, variables, and bash functions from .dotfiles_<variant>.
6. You can re-run the setup at any time safely to update or apply new configs.

Programing languages

Uses mise and devbox to control all envs for python, node, rust, go, etc...

Tools

• git config (auto config with email / name / rebase merge mode and vim editor)
• git aliases (ie gco and git co for git checkout) git aliases print the real command
• lunarvim (text editor)
• neovim (text editor)
• ligature nerd fonts
• fzf (fast file searching)
• zellij (terminal multiplexer with session and workspace management)
• g++ compiler

bash functions

• ipp - public ip print
• ipl - local ip print