# omerxx/dotfiles architecture

> Architecture diagram of the GitHub repository omerxx/dotfiles, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/omerxx/dotfiles
- Repository: https://github.com/omerxx/dotfiles

## Overview

##### Project type and purpose
- This is a “dotfiles” repository whose sole purpose is to manage and version-control a user’s configuration files for many command-line tools and GUI utilities.
- The README confirms it: “Dotfiles symlinked on my machine. Install with stow: `stow .`.”

##### File structure
- At the top level you have:
- A folder per application/tool (e.g., nvim, tmux, zshrc, hammerspoon, sketchybar, skhd, etc.)
- Configuration for Nix (nix, nix-darwin)
- A global `.stowrc` and a `setup.sh` script
- Each folder holds that tool’s config, intended to be symlinked into `$HOME` or `~/.config`.
- The presence of `stow .` implies the architecture pattern: “one repo – many modules – one symlink manager.”

##### Detail
- `.stowrc` and `setup.sh` as configuration and orchestration elements.
- Distinguish between user-level provisioning (Stow) and OS-level provisioning (Nix).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer action
    Dev["Developer"]:::external -->|"git clone"| Repo["Dotfiles Repo"]:::repo

    %% Orchestration
    Repo --> Setup["setup.sh"]:::script
    Repo --> StowConfig[".stowrc"]:::script
    Setup -->|"invokes"| Stow["GNU Stow"]:::stow

    %% Modules and Symlinks
    subgraph "Modules" 
        direction TB
        Nvim["nvim Module"]:::module
        Tmux["tmux Module"]:::module
        Zsh["zshrc Module"]:::module
        Hs["hammerspoon Module"]:::module
        Sketchy["sketchybar Module"]:::module
        Skhd["skhd Module"]:::module
        Starship["starship Module"]:::module
        Atuin["atuin Module"]:::module
        Aerospace["aerospace Module"]:::module
        Ghostty["ghostty Module"]:::module
        Karabiner["karabiner Module"]:::module
        Nushell["nushell Module"]:::module
        SSH["ssh Module"]:::module
        Wezterm["wezterm Module"]:::module
        Zellij["zellij Module"]:::module
        NixUser["nix Module"]:::nix
        NixDarwin["nix-darwin Module"]:::nix
    end

    Stow -->|"stow <module>"| Nvim
    Stow --> Tmux
    Stow --> Zsh
    Stow --> Hs
    Stow --> Sketchy
    Stow --> Skhd
    Stow --> Starship
    Stow --> Atuin
    Stow --> Aerospace
    Stow --> Ghostty
    Stow --> Karabiner
    Stow --> Nushell
    Stow --> SSH
    Stow --> Wezterm
    Stow --> Zellij
    Stow --> NixUser

    %% FileSystem targets
    subgraph "File System" 
        direction TB
        Home["Home Directory (~/)"]:::fs
        Config["Config Directory (~/.config/)"]:::fs
    end

    Nvim -->|"symlinks to ~/.config/nvim"| Config
    Tmux -->|"symlinks to ~/.tmux"| Home
    Zsh -->|"symlinks to ~/.zshrc"| Home
    Hs -->|"symlinks to ~/.hammerspoon"| Config
    Sketchy -->|"symlinks to ~/.config/sketchybar"| Config
    Skhd -->|"symlinks to ~/.skhdrc"| Home
    Starship -->|"symlinks to ~/.config/starship"| Config
    Atuin -->|"symlinks to ~/.config/atuin"| Config
    Aerospace -->|"symlinks to ~/.config/aerospace"| Config
    Ghostty -->|"symlinks to ~/.config/ghostty"| Config
    Karabiner -->|"symlinks to ~/.config/karabiner"| Config
    Nushell -->|"symlinks to ~/.config/nushell"| Config
    SSH -->|"symlinks to ~/.ssh"| Home
    Wezterm -->|"symlinks to ~/.config/wezterm"| Config
    Zellij -->|"symlinks to ~/.config/zellij"| Config

    %% Nix Darwin system-level
    Repo --> NixDarwin
    NixDarwin -->|"darwin-rebuild"| Home

    %% Click events
    click Repo "https://github.com/omerxx/dotfiles/tree/master/./"
    click Setup "https://github.com/omerxx/dotfiles/blob/master/./setup.sh"
    click StowConfig "https://github.com/omerxx/dotfiles/blob/master/./.stowrc"
    click Nvim "https://github.com/omerxx/dotfiles/tree/master/./nvim"
    click Tmux "https://github.com/omerxx/dotfiles/tree/master/./tmux"
    click Zsh "https://github.com/omerxx/dotfiles/tree/master/./zshrc"
    click Hs "https://github.com/omerxx/dotfiles/tree/master/./hammerspoon"
    click Sketchy "https://github.com/omerxx/dotfiles/tree/master/./sketchybar"
    click Skhd "https://github.com/omerxx/dotfiles/tree/master/./skhd"
    click Starship "https://github.com/omerxx/dotfiles/tree/master/./starship"
    click Atuin "https://github.com/omerxx/dotfiles/tree/master/./atuin"
    click Aerospace "https://github.com/omerxx/dotfiles/tree/master/./aerospace"
    click Ghostty "https://github.com/omerxx/dotfiles/tree/master/./ghostty"
    click Karabiner "https://github.com/omerxx/dotfiles/tree/master/./karabiner"
    click Nushell "https://github.com/omerxx/dotfiles/tree/master/./nushell"
    click SSH "https://github.com/omerxx/dotfiles/tree/master/./ssh"
    click Wezterm "https://github.com/omerxx/dotfiles/tree/master/./wezterm"
    click Zellij "https://github.com/omerxx/dotfiles/tree/master/./zellij"
    click NixUser "https://github.com/omerxx/dotfiles/tree/master/./nix"
    click NixDarwin "https://github.com/omerxx/dotfiles/tree/master/./nix-darwin"

    %% Styles
    classDef external fill:#f9f,stroke:#333,stroke-width:2px;
    classDef repo fill:#bbf,stroke:#333,stroke-width:1px;
    classDef script fill:#afa,stroke:#333,stroke-width:1px;
    classDef stow fill:#8f8,stroke:#333,stroke-width:1px;
    classDef module fill:#aee,stroke:#333,stroke-width:1px;
    classDef fs fill:#ccc,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5;
    classDef nix fill:#fca,stroke:#333,stroke-width:1px;
```
