Skip to content

Add AGENTS.md with the layout and a "don't run the installers" rule #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FrancesCoronel merged 2 commits into from
Oct 24, 2026
Merged

Add AGENTS.md with the layout and a "don't run the installers" rule #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
835483e
Add AGENTS.md so agents know the layout and not to run the installers
claude Oct 10, 2026
2f57df5
Merge branch 'master' into claude/repo-structure
FrancesCoronel Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# AGENTS.md

Guidance for AI coding agents (Claude Code, Copilot, Codex, and others) working in this repository.

## What this repo is

Frances's macOS setup: shell configs, Homebrew casks, fonts, terminal themes and macOS defaults. It's installed by cloning to `~/.dotfiles` and running the scripts below, which copy files into `$HOME` and change system settings.

## Don't run the install scripts

`bootstrap.sh` and everything in `init/` install software, run `sudo`, overwrite files in `$HOME` and change macOS settings. Never run them to "test" a change. Check shell changes with ShellCheck instead.

## Layout

| Path | What's there |
|---|---|
| `bootstrap.sh` | Entry point: Homebrew, core formulae, bash files |
| `init/.casks`, `.fonts`, `.npm`, `.osx`, `.shell`, `.gituser` | Install steps, run one at a time with `sh ~/.dotfiles/init/<name>` (see README) |
| `bin/shell/` | Shell dotfiles copied into `$HOME` (`.zshrc`, `.bashrc`, ...), plus `zsh/.p10k.zsh` and terminal themes for Hyper, iTerm and Terminal |
| `bin/fonts/` | Font files installed by `init/.fonts` |
| `bin/alfred/`, `bin/tower/` | App themes |
| `.github/.gitconfig`, `.github/.gitignore` | Global Git config and ignore file (not GitHub settings, despite the folder) |

Despite the name, nothing in `bin/` is an executable. If you move a file, update every script that copies it (search `bootstrap.sh` and `init/` for the path).

## Making changes

- Scripts are Bash (`#!/usr/bin/env bash`) for macOS. Quote variables and pass ShellCheck; `.shellcheckrc` holds the repo's settings once added.
- Never commit secrets, tokens, SSH keys or machine-specific paths beyond `$HOME`.
- Keep the README's install steps in sync when you add or rename an `init/` script.
- CI comes from the shared workflows in [FrancesCoronel/workflows](https://github.com/FrancesCoronel/workflows).
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
Loading