From dafbfef5cd3214e4557439c0d01de4b8c3066f81 Mon Sep 17 00:00:00 2001 From: alvinlollo Date: Sun, 11 Oct 2026 13:11:20 +1100 Subject: [PATCH] Add instruction files AGENTS.md and CLAUDE.md --- AGENTS.md | 16 ++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 17 insertions(+) create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..5fe63d7 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,16 @@ +# AGENTS.md + +## Environment & Constraints +* **Shell**: All scripts are written in `bash` and must be executed using `bash`. Do not attempt to run or source these scripts using `fish`, `zsh`, or other shells. +* **Platforms**: Primarily targeted at **Arch Linux**. Partial compatibility exists for Debian-based systems (specifically `zsh`, `bat`, `LazyVim` install scripts). +* **UI**: Expect interactive prompts using [`gum`](https://github.com/charmbracelet/gum) for selection menus. + +## Repository Structure +* **`install.sh`**: The main entrypoint. +* **`zsh.sh`, `bat.sh`, `LazyVim.sh`, etc.**: Modular installation scripts for specific tools. +* **`configs/`**: Contains configuration files applied by the install scripts (e.g., `shelly-*.toml`). + +## Developer Notes +* **Package Management**: Uses `shelly-cli` (Seafoam-Labs/Shelly-ALPM) for Arch Linux. +* **Debian Prerequisite**: On Debian-based systems, install scripts may trigger `apt full-upgrade -y`. +* **Testing**: If modifying scripts, verify behavior locally by sourcing or running in `bash`, ensuring `gum` is available for menu testing. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file