# shiftgeist/horiceon architecture

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

- Interactive diagram: https://gitdiagram.com/shiftgeist/horiceon
- Repository: https://github.com/shiftgeist/horiceon

## Overview

##### Main Components
- Git Repository & Dotfiles Manager: At the center, show the Git repository (often referenced through the “horiceon” alias) that manages all dotfiles and configurations. This is the primary interface for deployment and updates.
- Core Configuration Files: Include top-level files like .zshrc, .gitconfig, .Brewfile, and others that control shell behavior, Git settings, and package management.
- Custom Directories and Scripts:
- The .horiceon directory is a key “hub” for personal utilities and configurations. It contains several sub-components:
- The bin folder holds a variety of shell scripts (for system management, git tasks, invoking deno scripts, utility functions, etc.).
- The autohotkey directory includes scripts for Windows automation.
- The Firefox folder includes custom user configurations (userChrome.css, userContent.css, etc.).
- The knowledge folder contains markdown files detailing documentation for various topics (Git, terminal, typescript, etc.).
- Editor and Application Configurations:
- The .config directory, particularly the zed folder, includes settings for an editor.
- The Library/Application Support/Code directories represent the VS Code user configurations (keybindings, settings, snippets).

##### Relationships and Interactions
- Out how the custom scripts in .horiceon/bin facilitate specific tasks (e.g., git branch management, resource monitoring, launching various utilities) that interact with the underlying system.
- Connections between the configuration components (like .zshrc and .gitconfig) to corresponding applications (the shell and Git itself).
- That the Library folder’s VS Code configurations are separate from but influenced by the main dotfiles setup.

##### Architectural Patterns and Design Principles
- Separation of Concerns: The repository is structured to keep configuration files, custom scripts, and documentation distinct. Emphasize how this separation allows for easier maintenance and updates.
- Extensibility: The folder structure (particularly within .horiceon) shows how different utilities (shell scripts, autohotkey scripts, and knowledge documentation) can be updated or extended independently.
- Environment Replication: The README and setup instructions reveal the design goal to replicate a complete home environment on another machine; mark this as a key design intent.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Main Components
    cli["horiceon alias (CLI)"]:::external
    gitRepo["Dotfiles Repo (horiceon)"]:::repo

    %% Core Configuration Files Subgraph
    subgraph "Core Configuration Files"
        zshrc["Shell Config (.zshrc)"]:::config
        gitconfig["Git Config (.gitconfig)"]:::config
        Brewfile["Package Manager (.Brewfile)"]:::config
    end

    %% Custom Utilities (.horiceon) Subgraph
    subgraph "Custom Utilities (.horiceon)"
        horiceonRoot["Personal Toolbox (.horiceon)"]:::script
        horiceonBin["Shell Scripts (.horiceon/bin)"]:::script
        ahk["Windows Automation (.horiceon/autohotkey)"]:::script
        firefox["Firefox Customizations (.horiceon/firefox)"]:::script
        knowledge["Documentation (.horiceon/knowledge)"]:::doc
    end

    %% Editor & Application Configurations Subgraph
    subgraph "Editor & Application Configurations"
        zedConfig["Zed Editor Config (.config/zed)"]:::config
        vsCodeConfig["VS Code Config (Library/Application Support/Code/User)"]:::config
    end

    %% External Services/Tools
    shell["Shell"]:::external
    git["Git"]:::external
    vscode["VS Code"]:::external
    firefoxApp["Firefox"]:::external

    %% Relationships
    cli -->|"executes"| gitRepo
    gitRepo -->|"applies"| zshrc
    gitRepo -->|"applies"| gitconfig
    gitRepo -->|"applies"| Brewfile
    gitRepo -->|"manages"| horiceonRoot
    gitRepo -->|"includes"| zedConfig
    gitRepo -->|"includes"| vsCodeConfig

    horiceonRoot -->|"contains"| horiceonBin
    horiceonRoot -->|"contains"| ahk
    horiceonRoot -->|"contains"| firefox
    horiceonRoot -->|"contains"| knowledge

    shell -->|"uses"| zshrc
    git -->|"reads"| gitconfig
    firefoxApp -->|"leverages"| firefox
    vscode -->|"uses"| vsCodeConfig

    %% Click Events
    click gitRepo "https://github.com/shiftgeist/horiceon/blob/main/."
    click zshrc "https://github.com/shiftgeist/horiceon/blob/main/.zshrc"
    click gitconfig "https://github.com/shiftgeist/horiceon/blob/main/.gitconfig"
    click Brewfile "https://github.com/shiftgeist/horiceon/blob/main/.Brewfile"
    click horiceonRoot "https://github.com/shiftgeist/horiceon/blob/main/.horiceon"
    click horiceonBin "https://github.com/shiftgeist/horiceon/tree/main/.horiceon/bin"
    click ahk "https://github.com/shiftgeist/horiceon/tree/main/.horiceon/autohotkey"
    click firefox "https://github.com/shiftgeist/horiceon/tree/main/.horiceon/firefox"
    click knowledge "https://github.com/shiftgeist/horiceon/tree/main/.horiceon/knowledge"
    click zedConfig "https://github.com/shiftgeist/horiceon/tree/main/.config/zed"
    click vsCodeConfig "https://github.com/shiftgeist/horiceon/tree/main/Library/Application Support/Code/User"

    %% Styles
    classDef repo fill:#cce5ff,stroke:#004085,stroke-width:2px;
    classDef config fill:#d4edda,stroke:#155724,stroke-width:2px;
    classDef script fill:#fff3cd,stroke:#856404,stroke-width:2px;
    classDef doc fill:#f8d7da,stroke:#721c24,stroke-width:2px;
    classDef external fill:#e2e3e5,stroke:#6c757d,stroke-width:2px;
```
