8000 GitHub - crueber/dotfiles: A set of vim, zsh, git, and tmux configuration files. · GitHub
[go: up one dir, main page]

Skip to content
crueberPublic

About

A set of vim, zsh, git, and tmux configuration files.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

dotfiles

Personal dotfiles managed with GNU Stow. Each top-level directory is a stow package that mirrors the structure of $HOME. Running install.sh symlinks everything into place and safely backs up any pre-existing files that would conflict.

Requirements

Required

Tool Purpose
bash 4+ Install and helper scripts
stow Symlink management
git Version control
find / sort / awk Used by install script

Strongly Recommended

Tool Purpose
mise Runtime version manager (replaces nvm, rbenv, etc.)
oh-my-posh Shell prompt
neovim Editor (nvim)
lsd Modern ls replacement
bat Modern cat replacement
lazygit Terminal UI for git
btop System monitor
fastfetch System info display
opencode AI coding assistant
superfile Terminal file manager (spf)
rustnet Network monitoring TUI
herdr Terminal workspace manager for AI coding agents
tea Gitea CLI (tea-cli on Debian/Ubuntu)
gh-dash GitHub dashboard TUI (gh extension)

check_deps.sh verifies what is and isn't installed and can install missing tools automatically. install.sh runs it automatically before stowing; you can also run it standalone:

Installation

# 1. Clone the repo
git clone git@github.com:crueber/dotfiles.git ~/.dotfiles
cd ~/.dotfiles

# 2. Stow all packages (runs check_deps.sh first)
./install.sh

# Optional: check/install dependencies on their own
./check_deps.sh          # interactive
./check_deps.sh --yes    # auto-install everything without prompts

install.sh is safe to re-run at any time. It will never silently overwrite existing files — conflicts are renamed to <original>.bak.<timestamp> before stowing.

How It Works

Stow Layout

Each top-level directory is a stow package. The directory tree inside it mirrors $HOME, so stow knows exactly where to create symlinks:

dotfiles/
├── bin/
│   └── bin/          → ~/bin/
├── git/
│   ├── .gitconfig    → copied to ~/.gitconfig if absent
│   └── .gitignore    → copied to ~/.gitignore if absent
├── agents/
│   └── .agents/      → ~/.agents/
├── config/
│   └── .config/      → ~/.config/
├── oh-my-posh/
│   └── .oh-my-posh/  → ~/.oh-my-posh/
└── zsh/
    ├── .zshrc        → ~/.zshrc
    └── .zsh_aliases  → ~/.zsh_aliases

> **Note on `bin/bin/` double-nesting:** Stow would normally symlink the entire `bin/` package directory as `~/bin`. The inner `bin/bin/` nesting causes stow to instead create `~/bin/` as a real directory and symlink each script individually inside it. This is intentional — it keeps `~/bin/` as a real directory that can safely contain non-stow-managed files alongside the symlinked scripts.

### install.sh

The install script does the following:

1. Copies `git/.gitconfig` and `git/.gitignore` into `$HOME` only if they don't already exist (the `git/` directory is not stowed)
2. Runs `stow --dry-run` to detect conflicts without making any changes
3. Parses the dry-run output to find exactly which files would conflict
4. Renames only those conflicting files to `<path>.bak.<timestamp>`
5. Runs `stow -R` (restow) to apply all packages

Backups are timestamped so re-runs never clobber previous backups. Symlinks that already point into the repo are skipped.

### check_deps.sh

Checks for all required and recommended tools. Detects the available package manager (Homebrew, apt, pacman) and can install anything missing. Accepts `--yes` to skip confirmation prompts.

```bash
./check_deps.sh        # interactive
./check_deps.sh --yes  # auto-install all missing tools

Package Details

zsh/

  • .zshrc — Initializes oh-my-posh with the blue-owl-custom theme, activates mise, sets EDITOR/VISUAL to nvim, configures PATH for ~/bin and opencode.
  • .zsh_aliases — vim/n → nvim, ll, .., ... are always set; ls=lsd, lg=lazygit, and tea=tea-cli only when the tool exists; bat=batcat only when batcat exists and bat doesn't (Debian/Ubuntu).

Local overrides: Create ~/.zshrc.local for machine-specific settings (tokens, private paths, etc.). It is sourced automatically if it exists and is excluded from git via .gitignore.

git/

  • .gitconfig — User info, push default (current), useful aliases (aa, ap, ci, co, st, rebase-origin), zdiff3 conflict style, and a commit message template.
  • .gitignore — Global ignores: .DS_Store, editor swap files, common Rails and macOS artifacts.

These are copied, not symlinked, and only when no file already exists at the target — machine-specific git config is never overwritten.

agents/

  • .agents/skills/ — Shared agent skills (e.g. show-me), symlinked to ~/.agents/skills/ so they're available across systems.

oh-my-posh/

Four prompt themes are included. The active theme is set in .zshrc:

File Notes
blue-owl-custom.omp.json Active — customized version of blue-owl
blue-owl.omp.json Upstream base theme
microverse-power.omp.json Alternative
tiwahu.omp.json Alternative

To switch themes, update the --config path in zsh/.zshrc.

config/

Mirrors ~/.config. In addition to lsd (config.yaml enables color always with a custom theme; colors.yml is the 256-color palette), it carries configs for htop, btop, lazygit, mise (runtime tool declarations incl. oh-my-pi/omp and opencode), opencode, and the nvim/ LazyVim config. Machine-specific or secret-bearing paths are gitignored: git credential helpers (.config/git/), gh hosts.yml, tea, systemd user units, go telemetry.

bin/

Scripts symlinked into ~/bin/ and available on $PATH:

Script Description
aaxtractor.sh Convert Audible .aax/.aaxc files to .m4b
align.sh Library: right_aligned() helper for terminal output (source, don't execute)
convert.sh Batch convert .aax → .m4b via ffmpeg
get-gh-repos-for.sh Clone or pull all repos for a GitHub user or org
gh-web.sh Open the current repo's GitHub page in Brave Browser
git-churn.sh Show most frequently changed files across all git history
port-kill.sh Kill the process listening on a given TCP port
port-what.sh Show the process listening on a given TCP port
sync-to-git.sh Initialize/auto-commit a Syncthing-managed directory as a git repo
update-repos.sh Pull master or main for every git repo in subdirectories
xlsx-to-csv.sh Convert .xlsx to .csv using Nushell

aaxclean-cli note: This binary is no longer vendored in the repo. Download the appropriate build for your platform from the aaxclean-cli releases page and place it in ~/bin/ manually.

Adding a New Package

  1. Create a top-level directory named after the package (e.g., ssh/)
  2. Inside it, recreate the path structure as it should appear under $HOME (e.g., ssh/.ssh/config)
  3. Re-run ./install.sh — the new package is picked up automatically

Secrets and Local Overrides

Never commit secrets or machine-specific configuration. Use ~/.zshrc.local instead:

# ~/.zshrc.local  (not tracked in git)
export GH_TOKEN="your-token-here"
export SOME_API_KEY="..."

The .gitignore at the repo root excludes zsh/.zshrc.local and .zshrc.local to prevent accidental commits.

About

A set of vim, zsh, git, and tmux configuration files.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages

0