# acudworth3/dotfiles architecture

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

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

## Overview

##### Project type and purpose
- This is a personal “dotfiles” repository for configuring a developer workstation. It is not a traditional client-server or microservices app but a configuration-management toolset that:
- Manages shell configs (bash, fish)
- Sets up TUI tools (atuin, btop, htop, lazydocker, lazygit, yazi, exa, jqp)
- Provides an opinionated Neovim setup (plugins, LSP configuration)
- Configures shell prompt (starship) and terminal (Windows Terminal)

##### File structure
- Top-level directories each hold the config for one tool or environment:
- bash_config, fish, htop, btop, lazydocker, lazygit, starship, windows_terminal.json
- nvim (with init.lua, lua/) and accompanying plugin configs
- yazi (file-explorer flavors, keymap.toml, package.toml, theme.toml)
- Utility files:
- install.sh – bootstraps system-wide dependencies via apt, cargo, snap, git clone, curl
- .gitignore, README.md, .jqp.yaml, .stowrc
- Uses GNU Stow for symlinking “repo/config → ~/.config/toolname”

##### README for additional insights
- README explains how to:
- Run install.sh to install dependencies
- Use stow to symlink configurations into the user’s home directory
- Launch Neovim under this config (NVIM_APPNAME trick)
- How the repo, installation script, stow, package managers, and the user’s environment interact

##### Detail
- That stow reads its .stowrc to know which folders to link
- Detail the two shell init flows (bashrc sourcing, fish/conf.d)
- NVIM_APPNAME override for an isolated Neovim profile

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Source Repo
    subgraph "Git Dotfiles Repo"
        Repo["Git Dotfiles Repo"]:::source
        Install["install.sh"]:::orchestration
        Stowrc[".stowrc"]:::orchestration
        IP["installed_packages.txt"]:::external
        JQPConf[".jqp.yaml"]:::deployed
    end

    %% Package Managers Cluster
    subgraph "Package Managers"
        apt["apt"]:::pm
        cargo["cargo"]:::pm
        snap["snap"]:::pm
        gitclone["git clone"]:::pm
        curl["curl"]:::pm
    end

    %% Stow
    Stow["GNU Stow"]:::orchestration

    %% Home Directory Configs
    subgraph "Home Directory (~/.config)"
        bash["bash_config"]:::deployed
        fishcfg["fish/conf.d"]:::deployed
        atuincfg["atuin"]:::deployed
        nvimcfg["nvim"]:::deployed
        starshipcfg["starship"]:::deployed
        yazicfg["yazi"]:::deployed
        htopcfg["htop"]:::deployed
        btopcfg["btop"]:::deployed
        ldockcfg["lazydocker"]:::deployed
        lgitcfg["lazygit"]:::deployed
        windowscfg["windows_terminal.json"]:::deployed
        jqpcfg[".jqp.yaml"]:::deployed
    end

    %% Runtime Tools
    subgraph "Runtime Tools"
        Bash["Bash"]:::runtime
        Fish["Fish"]:::runtime
        Neovim["Neovim"]:::runtime
        Atuin["Atuin"]:::runtime
        htoptool["htop"]:::runtime
        btoptool["btop"]:::runtime
        lazygittool["lazygit"]:::runtime
        lazydockertool["lazydocker"]:::runtime
        yazitool["yazi"]:::runtime
        exa["exa"]:::runtime
        jqp["jqp"]:::runtime
    end

    %% Flows
    Repo -->|"invoke"| Install
    Install -->|"uses"| apt
    Install -->|"uses"| cargo
    Install -->|"uses"| snap
    Install -->|"uses"| gitclone
    Install -->|"uses"| curl
    Install -->|"reads"| Stowrc
    Install -->|"bootstraps"| Stow

    Stow -->|"symlinks"| bash
    Stow -->|"symlinks"| fishcfg
    Stow -->|"symlinks"| atuincfg
    Stow -->|"symlinks"| nvimcfg
    Stow -->|"symlinks"| starshipcfg
    Stow -->|"symlinks"| yazicfg
    Stow -->|"symlinks"| htopcfg
    Stow -->|"symlinks"| btopcfg
    Stow -->|"symlinks"| ldockcfg
    Stow -->|"symlinks"| lgitcfg
    Stow -->|"symlinks"| windowscfg
    Stow -->|"symlinks"| jqpcfg

    bash -->|"sources config"| Bash
    fishcfg -->|"loads env"| Fish
    starshipcfg -->|"custom prompt"| Bash
    starshipcfg -->|"custom prompt"| Fish
    atuincfg -->|"history management"| Atuin
    nvimcfg -->|"loads config"| Neovim
    yazicfg -->|"ui config"| yazitool
    htopcfg -->|"configures"| htoptool
    btopcfg -->|"configures"| btoptool
    ldockcfg -->|"configures"| lazydockertool
    lgitcfg -->|"configures"| lazygittool
    jqpcfg -->|"configures"| jqp

    %% Click Events
    click Repo "https://github.com/acudworth3/dotfiles/tree/main//"
    click Install "https://github.com/acudworth3/dotfiles/blob/main//install.sh"
    click Stowrc "https://github.com/acudworth3/dotfiles/blob/main//.stowrc"
    click IP "https://github.com/acudworth3/dotfiles/blob/main//installed_packages.txt"
    click JQPConf "https://github.com/acudworth3/dotfiles/blob/main//.jqp.yaml"
    click bash "https://github.com/acudworth3/dotfiles/tree/main//bash_config/"
    click fishcfg "https://github.com/acudworth3/dotfiles/tree/main//fish/"
    click atuincfg "https://github.com/acudworth3/dotfiles/tree/main//atuin/"
    click htopcfg "https://github.com/acudworth3/dotfiles/tree/main//htop/htoprc"
    click btopcfg "https://github.com/acudworth3/dotfiles/blob/main//btop/btop.conf"
    click ldockcfg "https://github.com/acudworth3/dotfiles/blob/main//lazydocker/config.yml"
    click lgitcfg "https://github.com/acudworth3/dotfiles/blob/main//lazygit/config.yml"
    click starshipcfg "https://github.com/acudworth3/dotfiles/blob/main//starship/starship.toml"
    click windowscfg "https://github.com/acudworth3/dotfiles/blob/main//windows_terminal.json"
    click nvimcfg "https://github.com/acudworth3/dotfiles/tree/main//nvim/"
    click yazicfg "https://github.com/acudworth3/dotfiles/tree/main//yazi/"

    %% Styles
    classDef source fill:#f96,stroke:#333,stroke-width:1px
    classDef orchestration fill:#9cf,stroke:#333,stroke-width:1px
    classDef pm fill:#a9f,stroke:#333,stroke-width:1px
    classDef deployed fill:#9f9,stroke:#333,stroke-width:1px
    classDef runtime fill:#ccc,stroke:#333,stroke-width:1px
    classDef external fill:#ddd,stroke:#333,stroke-width:1px
```
