- Shell 68.1%
- PowerShell 13.1%
- Go Template 9.9%
- Lua 8.9%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014UrrXre2kaDrtkenwEYEaH |
||
| config | ||
| docs | ||
| home | ||
| scripts | ||
| .gitignore | ||
| CLAUDE.md | ||
| CONTEXT.md | ||
| QUESTIONS.md | ||
| README.md | ||
| setup.ps1 | ||
| setup.sh | ||
| TODO.md | ||
| update.ps1 | ||
| update.sh | ||
🚀 Meine Cross-Platform Dotfiles
Dieses Repository enthält meine automatisierten Konfigurationsdateien (Dotfiles) und Installationsskripte für eine moderne, einheitliche Terminal-Umgebung auf Linux, macOS und Windows.
Das Setup ist zu 100 % XDG-konform, hält das Home-Verzeichnis sauber und installiert fehlende Abhängigkeiten vollautomatisch. Unterstützt werden Debian/Ubuntu (apt), Arch (pacman), Fedora/Fedora Asahi Remix (dnf), NixOS (nix-env), macOS (Homebrew) und Windows (winget).
Alle Tools nutzen ein einheitliches Farbschema: Catppuccin Mocha.
🛠️ Enthaltene Tools
Immer installiert (Core):
- Shell: Zsh (inkl.
zsh-autosuggestions,zsh-history-substring-search&zsh-syntax-highlighting, Tab-Vervollständigung, History mit Zeitstempeln) +fzffürStrg+R/Strg+T - Terminal-Multiplexer: Tmux (Maus-Support, Vim-Keybindings im Copy-Mode,
escape-time 0für lagfreies Neovim,h/j/k/l-Pane-Navigation,<prefix>+rzum Neuladen, sowietpm-Plugins:tmux-resurrect/tmux-continuumfür Session-Persistenz,tmux-yankfür Zwischenablage,tmux-prefix-highlightfür sichtbares Prefix-Feedback) - Editor: Neovim (Lua Config mit
lazy.nvim: Telescope-Fuzzy-Finder, Treesitter — beide leichtgewichtig und immer dabei; Plugin-Versionen perlazy-lock.jsonim Repo festgeschrieben) - Git:
pullper Rebase,fetch.prune,push.autoSetupRemote,zdiff3-Konflikte,histogram-Diffs,rerere; Credential-Helper je Rechner (macOS-Schlüsselbund, libsecret am Linux-Desktop, sonst 8 h im RAM) in~/.config/git/credential.gitconfig
Optional wählbar (siehe Optionale Komponenten):
- ls-Ersatz: Eza (mit Farben & Icons)
- Filebrowser: Yazi (rasend schnell, in Rust — auf manchen Distros per Cargo/Rust kompiliert) inkl. Vorschau-Tools (ffmpeg, poppler, 7z, jq, fd, ripgrep, chafa)
- Prompt: Starship (Git-Status im Prompt, dieselbe Config für Zsh und PowerShell — ersetzt beide handgeschriebenen Prompts, sobald installiert)
- Neovim LSP/Autocomplete:
lua_ls+bashlsvia Mason, Autocompletion (nvim-cmp) — bewusst NICHT im Core, dabashlsnode/npmbraucht (wird nur mit dieser Komponente mitinstalliert) und Mason/LSP eher für Arbeits-/Coding-Rechner sinnvoll ist als für schlanke Server. Ohne diese Komponente bleibt Neovim ein einfacher Editor mit Fuzzy-Finder & Syntax-Highlighting.
Alle drei Prompt-Varianten (Starship sowie die handgeschriebenen Zsh-/PowerShell-Fallbacks) markieren root/Administrator-Sessions farblich (rot statt blau) – siehe Abschnitt "Wichtige Hinweise nach der Installation" (Punkt 5) unten, damit das auch nach sudo -i sichtbar bleibt.
Windows-Support: Nativer PowerShell-Support mit Zsh-ähnlichem Prompt & Aliasen
⚡ Installation (One-Liner)
Wähle einfach das Skript für dein jeweiliges Betriebssystem.
Bei einem Domain-/Instanz-Wechsel: Die Repo-URL steht dreifach hartkodiert (hier in den One-Linern, in
setup.shund insetup.ps1) – alle drei Stellen anpassen, sieheQUESTIONS.mdI1.
🪟 Windows (Natives PowerShell)
Das Windows-Setup nutzt winget, um Tools zu installieren, und verknüpft ein Zsh-ähnliches Profil für deine PowerShell. Öffne eine PowerShell und führe aus:
Invoke-RestMethod "https://forge.voidborn.xyz/Endoxx/dotfiles/raw/branch/main/setup.ps1" | Invoke-Expression
(Tipp: Für das volle Unix-Erlebnis mit echter Zsh und Tmux unter Windows empfehlen wir die Nutzung von WSL. Führe in WSL einfach den Linux-Befehl aus!)
🐧 Linux & 🍏 macOS
Das Setup erkennt automatisch dein Betriebssystem, nutzt APT, Pacman oder installiert Homebrew (auf dem Mac). Fehlende moderne Tools werden bei Bedarf automatisch über Cargo/Rust installiert. Führe in deinem Terminal aus:
curl -sL "https://forge.voidborn.xyz/Endoxx/dotfiles/raw/branch/main/setup.sh" | bash
🖥️ Server (headless)
Auf Servern ohne grafische Oberfläche wird das Terminal-Profil/Nerd-Font-Setup automatisch übersprungen (erkannt über $DISPLAY/$WAYLAND_DISPLAY). Läuft das Skript ganz ohne TTY (z. B. via unattended Provisioning), wird das komplette optionale Post-Setup übersprungen statt bei einer Eingabe zu hängen. Manuell erzwingen lässt sich das mit:
curl -sL "https://forge.voidborn.xyz/Endoxx/dotfiles/raw/branch/main/setup.sh" | bash -s -- --headless
Läuft das Skript als root in einem Container (kein sudo vorhanden), wird das automatisch erkannt und sudo weggelassen.
Frische Minimal-Server-Images (v. a. Debian netinst) haben oft gar keine UTF-8-Locale (LANG=C) – Umlaute/Icons erscheinen dann als _/? (z. B. in tmux). Das Setup erkennt das automatisch und richtet en_US.UTF-8 ein (auf NixOS nur ein Hinweis, dort gehört das in configuration.nix).
🌀 Ausgabe & Fortschritt
Standardmäßig läuft ein kleiner Spinner mit, solange im Hintergrund installiert/kompiliert wird (Paketmanager, Cargo-Fallback für Eza/Yazi/Starship) – ohne das wirkt gerade eine Cargo-Kompilierung leicht wie ein Hänger, obwohl noch gearbeitet wird. Für die volle Rohausgabe:
curl -sL "https://forge.voidborn.xyz/Endoxx/dotfiles/raw/branch/main/setup.sh" | bash -s -- --verbose
Der Cargo-Fallback (Eza/Yazi/Starship, falls nicht paketiert) kann auf kleineren Servern 15–30+ Minuten dauern. Die Kern-Funktionalität (Zsh, Tmux, Neovim, Symlinks, Standard-Shell) wird bewusst vor diesem Schritt eingerichtet, sodass ein Abbruch dort nicht die Grundfunktionalität verhindert. Trotzdem empfehlenswert: das Setup in einer tmux-Session starten, damit ein SSH-Verbindungsabbruch die Kompilierung nicht killt:
tmux new -s setup
curl -sL "https://forge.voidborn.xyz/Endoxx/dotfiles/raw/branch/main/setup.sh" | bash
# bei Verbindungsabbruch: neu einloggen, dann "tmux attach -t setup"
Ein erneutes dotfiles update (bzw. update-dotfiles) holt fehlende Komponenten automatisch nach, falls der Cargo-Teil doch mal unterbrochen wird.
🧩 Optionale Komponenten
Zsh, Tmux und Neovim (Basis-Editor ohne LSP) werden immer installiert. Eza, Yazi, Starship und Neovim-LSP sind optional (Yazi ist auf manchen Distros nicht paketiert, Starship auf Debian/Ubuntu nicht - beide fallen dann auf Cargo/Rust-Kompilierung zurück):
- Interaktiv: Beim ersten
setup.sh-Lauf wird nachgefragt (y/n). - Explizit per Flag:
curl -sL ".../setup.sh" | bash -s -- --with=eza,yazi,starship,nvim-lsp # oder: --with=all / --with=none - Per Umgebungsvariable (z. B. für automatisiertes Server-Provisioning):
DOTFILES_COMPONENTS=eza,yazi,starship,nvim-lsp - Nicht-interaktiv ohne Vorgabe (z. B. Server-Skript ohne TTY): es wird nur der Core installiert.
- Nachträglich ändern:
dotfiles update --with=eza,yazi,starship,nvim-lspinstalliert fehlende Komponenten nach und merkt sich die Auswahl ($XDG_STATE_HOME/dotfiles/components, maschinenlokal, nicht Teil des Git-Repos). Neovim liest dieselbe Datei beim Start selbst aus (kein Neustart des Setups nötig, nur Neovim neu starten).
🎨 Farbschema anpassen
Alle Farben (nvim, tmux, Yazi, Konsole, Windows Terminal) kommen aus einer Datei: config/theme/catppuccin-mocha.palette. Nach einer Änderung dort:
bash scripts/render-theme.sh # Unix - rendert alle *.tmpl-Dateien neu
. scripts\Render-Theme.ps1 # Windows - für den Windows-Terminal-Teil
Die erzeugten Dateien danach wie gewohnt committen und pushen.
🔄 Die dotfiles-CLI (Unix)
Nach der Installation steht ein einheitlicher Befehl zur Verfügung (~/.local/bin/dotfiles, per Symlink aus scripts/dotfiles):
dotfiles help # Übersicht aller Befehle
dotfiles check-updates # Nur prüfen, ob neue Commits verfügbar sind
dotfiles update # Auf den neuesten Stand bringen (Pakete, Symlinks, Post-Setup)
dotfiles reconfigure # Wie 'update', fragt aber alle Post-Setup-Schritte erneut ab
dotfiles uninstall # Symlinks/Caches entfernen (fragt nach Repo & Paketen)
dotfiles reinstall # Kompletter Neuanfang: uninstall + frischer Klon/Setup
Das alte update-dotfiles funktioniert weiterhin – es ruft update.sh bewusst direkt auf (nicht über dotfiles update), damit es auch dann noch greift, wenn der dotfiles-Befehl selbst mal nicht im PATH ist. Flags werden durchgereicht, update-dotfiles --reconfigure tut also dasselbe wie dotfiles reconfigure. Neu ist vor allem dotfiles uninstall/reinstall, falls mal etwas gründlich zurückgesetzt werden muss.
Die optionalen Post-Setup-Fragen (Git-Identität, Terminal/Fonts, SSH-Key, Root-Setup) werden bei dotfiles update nur einmal gestellt – die Antwort wird gemerkt ($XDG_STATE_HOME/dotfiles/post-setup-done). Erneut abfragen: dotfiles reconfigure.
dotfiles uninstall entfernt alle gesetzten Symlinks (stellt dabei gesicherte .bak-Dateien wieder her), Plugin-Caches und den gemerkten Zustand. Fragt zusätzlich, ob auch das Repo-Verzeichnis und installierte Pakete entfernt werden sollen. Rührt nie an: SSH-Keys (~/.ssh/id_ed25519) und deine Git-Identität (~/.config/git/identity.gitconfig) – das sind echte Nutzerdaten, kein generierter Zustand.
📂 Verzeichnisstruktur
Das Repository ist stark modular aufgebaut:
setup.sh/setup.ps1- Die initialen One-Liner-Einstiegspunkte.scripts/- OS-spezifische Installationslogik, Symlink-Skripte und der Theme-Renderer.config/- Alle Konfigurationen, die nach~/.config/verlinkt werden (XDG-konform).config/theme/enthält die Farbpalette,*.tmpl-Dateien sind Templates (siehe Farbschema anpassen).home/- Dateien, die zwingend im Home-Verzeichnis liegen müssen (z. B..zshenv, SSH-Config).
📖 Gebrauchsanweisung
Wie benutzt man das alles eigentlich – welche Plugins/Keybindings hat Zsh, Tmux, Neovim & Co.? Steht in docs/, pro Tool eine Seite.
📋 Projekt-Dokumentation
Wer am Repo selbst arbeitet (statt es nur zu benutzen), findet die Hintergründe hier:
| Datei | Inhalt |
|---|---|
CONTEXT.md |
Entscheidungsprotokoll – warum das Setup so aufgebaut ist (Theming, Komponenten-System, Server-Tauglichkeit) |
TODO.md |
Was ansteht, was zuletzt behoben wurde, was bewusst zurückgestellt ist |
QUESTIONS.md |
Offene Fragen, die vor der nächsten Änderung geklärt sein sollten |
CLAUDE.md |
Arbeitsanweisungen für Claude Code |
⚠️ Wichtige Hinweise nach der Installation
- Terminal Neustart: Melde dich nach der ersten Installation einmal ab und wieder an (oder starte das Terminal neu), damit alle Umgebungsvariablen greifen.
- Nerd Fonts: Damit die Icons in
ezaundyazikorrekt angezeigt werden, muss auf dem lokalen Rechner (bzw. in deinem Terminal-Emulator) ein Nerd Font installiert und aktiviert sein. - Git Identity: Wird beim (optionalen) Post-Setup interaktiv abgefragt und landet in
~/.config/git/identity.gitconfig– nicht in der getracktenconfig/git/config, damitgit pullnie mit deiner lokalen Identität kollidiert. Manuell setzen geht mit:git config --file ~/.config/git/identity.gitconfig user.name "Dein Name" git config --file ~/.config/git/identity.gitconfig user.email "deine@email.de" - SSH-Keys: Private SSH-Schlüssel (
id_ed25519) sind nicht Teil dieses Repositories und müssen manuell nach~/.ssh/kopiert werden. - Root-Konto:
sudo -i/su -landet in root's eigener Shell (/root), in der diese Dotfiles standardmäßig nicht verlinkt sind – u.a. der rote Root-Indikator im Prompt (siehe unten) greift dort sonst nie. Das (optionale) Post-Setup fragt daher zusätzlich, ob Zsh, Tmux und Neovim (nur Core, kein Eza/Yazi/Starship) auch für root eingerichtet werden sollen. Manuell nachholen:bash scripts/setup-root.sh.