# lingjie00/cli_settings architecture

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

- Interactive diagram: https://gitdiagram.com/lingjie00/cli_settings
- Repository: https://github.com/lingjie00/cli_settings

## Overview

##### Project type and purpose
- This is a personal “dotfiles” repository—an open-source tool for managing and bootstrapping a developer’s CLI environment.
- Purpose: store all configuration files for various terminal tools (Neovim, fish shell, tmux, Yabai, Alacritty, etc.), and provide install/uninstall scripts to symlink these configs into a fresh machine.

##### File structure
- Top-level config directory:
- .config/alacritty – terminal emulator
- .config/fish – shell config (with plugins & functions)
- .config/i3, i3blocks – Linux window manager
- .config/kitty – another terminal emulator
- .config/limelight, rofi, skhd, yabai – macOS window management
- .config/nvim – Neovim editor and plugins (Lua config)
- .config/qutebrowser, zathura, w3m – CLI browsers/viewers
- Root-level dotfiles: .vimrc, .zshrc, .tmux.conf, .gitconfig
- Install tooling: Makefile, install, uninstall, homebrew.sh, install_neovim.sh
- Project scripts for data-science: read_excel.py, nb_clean, Python requirements
- Metadata: pyproject.toml, read_excel_requirements.txt

##### README for additional insights
- Describes the four core tools managed: Neovim, fish shell, tmux, Yabai
- Setup flow:
1) git clone the repo
2) run ./install which creates symbolic links to ~
- Notes on Python/Jupyter and R workflows (Jupytext, RStudio server)
- SSH config snippet management
- Common editor commands and build recipes

- Version Control & Bootstrap Scripts
- Symlink Manager
- Config Targets (shell, editor, WM, terminal emulators)
- External Services
- Host OS / Terminal
- install → symlink creation → config pickup
- shell startup → conda init
- editor → LSP & plugin subsystems
- user commands → external services (SSH, Jupyter)
- Scripts/orchestration
- Configuration directories
- Runtime applications
- External services/hosts

## Diagram (Mermaid)

```mermaid
flowchart TB
  subgraph "Version Control & Scripts"
    Git["GitHub Repo"]:::vc
    Make["Makefile"]:::script
    Install["install"]:::script
    Uninstall["uninstall"]:::script
    Homebrew["homebrew.sh"]:::script
    InstallNvim["install_neovim.sh"]:::script
  end

  subgraph "Symlink Manager"
    Symlink["Symlink Manager"]:::manager
  end

  subgraph "Config Targets"
    subgraph "Shells"
      Fish["Fish Shell Config"]:::config
      Zsh["Zsh Shell Config"]:::config
    end
    subgraph "Editors"
      Neo["Neovim Config"]:::config
      Vim["Vim Config"]:::config
    end
    Tmux["Tmux Config"]:::config
    subgraph "Window Managers"
      MacWM["macOS WM Config"]:::config
      LinuxWM["Linux WM Config"]:::config
    end
    subgraph "Terminal Emulators"
      Alac["Alacritty Config"]:::config
      Kitty["Kitty Config"]:::config
    end
    subgraph "CLI Browsers & Viewers"
      Qute["qutebrowser Config"]:::config
      Zath["Zathura Config"]:::config
      W3M["w3m Config"]:::config
    end
  end

  subgraph "External Services"
    Conda["Conda/Miniconda"]:::service
    Jupyter["Jupyter Server"]:::service
    RStudio["RStudio Server"]:::service
    SSH["SSH Hosts"]:::service
  end

  subgraph "Host OS"
    MacOS["macOS"]:::host
    Linux["Linux"]:::host
  end

  Git --> Make
  Make --> Install
  Make --> Uninstall
  Make --> Homebrew
  Make --> InstallNvim
  Install --> Symlink
  Uninstall --> Symlink
  Symlink --> Fish
  Symlink --> Zsh
  Symlink --> Neo
  Symlink --> Vim
  Symlink --> Tmux
  Symlink --> MacWM
  Symlink --> LinuxWM
  Symlink --> Alac
  Symlink --> Kitty
  Symlink --> Qute
  Symlink --> Zath
  Symlink --> W3M

  Conda --> Fish
  Conda --> Zsh
  Jupyter --"SSH tunnel"--> SSH
  RStudio --"SSH tunnel"--> SSH

  MacOS --> MacWM
  Linux --> LinuxWM

  click Git "https://github.com/lingjie00/cli_settings/blob/main/.gitconfig"
  click Make "https://github.com/lingjie00/cli_settings/tree/main/Makefile"
  click Install "https://github.com/lingjie00/cli_settings/tree/main/install"
  click Uninstall "https://github.com/lingjie00/cli_settings/tree/main/uninstall"
  click Homebrew "https://github.com/lingjie00/cli_settings/blob/main/homebrew.sh"
  click InstallNvim "https://github.com/lingjie00/cli_settings/blob/main/install_neovim.sh"
  click Fish "https://github.com/lingjie00/cli_settings/blob/main/.config/fish/config.fish"
  click Zsh "https://github.com/lingjie00/cli_settings/blob/main/.zshrc"
  click Neo "https://github.com/lingjie00/cli_settings/blob/main/.config/nvim/init.lua"
  click Vim "https://github.com/lingjie00/cli_settings/blob/main/.vimrc"
  click Tmux "https://github.com/lingjie00/cli_settings/blob/main/.tmux.conf"
  click MacWM "https://github.com/lingjie00/cli_settings/tree/main/.config/yabai/yabairc"
  click LinuxWM "https://github.com/lingjie00/cli_settings/tree/main/.config/i3/config"
  click Alac "https://github.com/lingjie00/cli_settings/blob/main/.config/alacritty/alacritty.yml"
  click Kitty "https://github.com/lingjie00/cli_settings/blob/main/.config/kitty/kitty.conf"
  click Qute "https://github.com/lingjie00/cli_settings/blob/main/.qutebrowser/config.py"
  click Zath "https://github.com/lingjie00/cli_settings/tree/main/.config/zathura/zathurarc"
  click W3M "https://github.com/lingjie00/cli_settings/blob/main/.w3m/bookmark.html"

  classDef vc fill:#f9f,stroke:#333,stroke-width:1px
  classDef script fill:#ff9,stroke:#333,stroke-width:1px
  classDef manager fill:#9ff,stroke:#333,stroke-width:1px
  classDef config fill:#9f9,stroke:#333,stroke-width:1px
  classDef service fill:#f99,stroke:#333,stroke-width:1px
  classDef host fill:#ccc,stroke:#333,stroke-width:1px
```
