{"owner":"mbadolato","repo":"iTerm2-Color-Schemes","hasSkills":true,"hasMcp":false,"mcpConfig":null,"found":["AGENTS.md"],"skills":{"AGENTS.md":"# AGENTS.md\n\nGuidance for AI coding agents working in this repository.\n\n## Project overview\n\nThis repo collects terminal color schemes and generates them for 30+ targets (iTerm2, Alacritty, Kitty, WezTerm, VS Code, Windows Terminal, etc.). Source themes live in `yaml/` (`.yml`, preferred for new themes) and `schemes/` (`.itermcolors`, for themes exported directly from iTerm2). Everything else under format directories (`alacritty/`, `kitty/`, `wezterm/`, …) is generated output.\n\n## Repository layout\n\n| Path | Purpose |\n|------|---------|\n| `yaml/` | Preferred source for new themes (Gogh-based YAML format) |\n| `schemes/` | iTerm2 `.itermcolors` source files (use when exporting from iTerm2) |\n| `tools/` | Generation scripts, converters, and Jinja2 templates |\n| `tools/templates/` | Per-format Jinja2 templates |\n| `screenshots/` | Auto-generated theme preview images |\n\n## Setup\n\n```bash\npython -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.txt\n```\n\nPython version: see `.python-version` (currently 3.10). Docker alternative: `./generate-all.sh`.\n\nActivate the venv before running commands below (`source .venv/bin/activate`), or prefix with `.venv/bin/python`.\n\n## Common commands\n\n```bash\n# Generate all themes for all formats\ncd tools && python gen.py\n\n# Generate one theme (preferred while iterating)\ncd tools && python gen.py -s \"Your Theme Name\"\n\n# Generate one format template only\ncd tools && python gen.py -t kitty\n\n# Full local pipeline (macOS; regenerates all themes, Terminal profiles, screenshots, README)\n./generate-all-nodocker.sh\n\n# Check WCAG contrast (default threshold 1.75, matches gen.py)\npython tools/wcag_check.py -s \"Your Theme Name\"\npython tools/wcag_check.py --schemes-dir schemes   # all schemes\n\n# YAML themes: generate .itermcolors first, then check\ncd tools && python gen.py -s \"Your Theme Name\"\npython tools/wcag_check.py -s \"Your Theme Name\"\n\n# Visual preview (display-only truecolor; does not change terminal palette)\npython tools/preview_theme.py -s \"Your Theme Name\"\n```\n\n## Adding a new theme\n\n**Prefer YAML** unless the theme is being exported directly from iTerm2.\n\n### YAML (default)\n\n1. Create `yaml/Your Theme Name.yml` following `yaml/README.md`. Use the display name as the filename — spaces are fine; do not slugify or use underscores.\n2. Convert from other formats if needed: `tools/kitty_to_yaml.py`, `tools/ghostty_to_yaml.py`.\n3. Regenerate with `cd tools && python gen.py -s \"Your Theme Name\"`.\n\n### iTerm2 export (when applicable)\n\n1. Export from iTerm2 and add `schemes/Your Theme Name.itermcolors`.\n2. Regenerate with `cd tools && python gen.py -s \"Your Theme Name\"`.\n\nFor both paths: optionally update `CREDITS.md`, and do **not** hand-edit files in generated format directories. See `README.md` (Contribute) for full details.\n\n## Adding a new output format\n\n1. Create a Jinja2 template in `tools/templates/` using placeholders documented in `README.md` (Contribute → How to add new template).\n2. Test with `cd tools && python gen.py -t <template-name>`.\n3. Update `requirements.txt` or `.python-version` only if dependencies change.\n\n## Important rules\n\n- **Prefer YAML for new themes.** Add `yaml/*.yml` unless the source is a direct iTerm2 export.\n- **Edit sources, not outputs.** Change `yaml/` or `schemes/`, then regenerate. Never manually patch hundreds of generated theme files.\n- **Use selective generation** (`-s`, `-t`) when working on a single theme or format to avoid long runtimes.\n- **Theme naming.** Name source files as the display name (`yaml/Catppuccin Mocha.yml`, `schemes/SpaceGray Eighties.itermcolors`). No slugifying or underscores. YAML `name:` must match the filename if set. Quote names with spaces in CLI commands.\n- **Avoid unrelated changes.** This repo is large; keep diffs focused on the task (one theme, one template, one tool fix).\n- **README screenshots** are auto-generated by `tools/generate_screenshots_readme.py`; do not hand-edit the screenshots section in `README.md`.\n- **Disclose agent usage.** Note AI agent involvement in commit messages and PR descriptions. Agent-generated code and themes are welcome; the user may remove the disclosure if they prefer.\n\n## CI behavior\n\nGitHub Actions (`.github/workflows/generate-all.yml`) regenerates themes and screenshots on pushes to `master` that touch `schemes/`, `yaml/`, or `screenshots/README.md`. PRs should include source changes; generated artifacts may be updated by CI.\n\n## Further reading\n\n- `README.md` — installation, contribution workflow, and template placeholder reference\n- `yaml/README.md` — YAML source format\n- `CREDITS.md` — theme attribution"},"files":{"AGENTS.md":"# AGENTS.md\n\nGuidance for AI coding agents working in this repository.\n\n## Project overview\n\nThis repo collects terminal color schemes and generates them for 30+ targets (iTerm2, Alacritty, Kitty, WezTerm, VS Code, Windows Terminal, etc.). Source themes live in `yaml/` (`.yml`, preferred for new themes) and `schemes/` (`.itermcolors`, for themes exported directly from iTerm2). Everything else under format directories (`alacritty/`, `kitty/`, `wezterm/`, …) is generated output.\n\n## Repository layout\n\n| Path | Purpose |\n|------|---------|\n| `yaml/` | Preferred source for new themes (Gogh-based YAML format) |\n| `schemes/` | iTerm2 `.itermcolors` source files (use when exporting from iTerm2) |\n| `tools/` | Generation scripts, converters, and Jinja2 templates |\n| `tools/templates/` | Per-format Jinja2 templates |\n| `screenshots/` | Auto-generated theme preview images |\n\n## Setup\n\n```bash\npython -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.txt\n```\n\nPython version: see `.python-version` (currently 3.10). Docker alternative: `./generate-all.sh`.\n\nActivate the venv before running commands below (`source .venv/bin/activate`), or prefix with `.venv/bin/python`.\n\n## Common commands\n\n```bash\n# Generate all themes for all formats\ncd tools && python gen.py\n\n# Generate one theme (preferred while iterating)\ncd tools && python gen.py -s \"Your Theme Name\"\n\n# Generate one format template only\ncd tools && python gen.py -t kitty\n\n# Full local pipeline (macOS; regenerates all themes, Terminal profiles, screenshots, README)\n./generate-all-nodocker.sh\n\n# Check WCAG contrast (default threshold 1.75, matches gen.py)\npython tools/wcag_check.py -s \"Your Theme Name\"\npython tools/wcag_check.py --schemes-dir schemes   # all schemes\n\n# YAML themes: generate .itermcolors first, then check\ncd tools && python gen.py -s \"Your Theme Name\"\npython tools/wcag_check.py -s \"Your Theme Name\"\n\n# Visual preview (display-only truecolor; does not change terminal palette)\npython tools/preview_theme.py -s \"Your Theme Name\"\n```\n\n## Adding a new theme\n\n**Prefer YAML** unless the theme is being exported directly from iTerm2.\n\n### YAML (default)\n\n1. Create `yaml/Your Theme Name.yml` following `yaml/README.md`. Use the display name as the filename — spaces are fine; do not slugify or use underscores.\n2. Convert from other formats if needed: `tools/kitty_to_yaml.py`, `tools/ghostty_to_yaml.py`.\n3. Regenerate with `cd tools && python gen.py -s \"Your Theme Name\"`.\n\n### iTerm2 export (when applicable)\n\n1. Export from iTerm2 and add `schemes/Your Theme Name.itermcolors`.\n2. Regenerate with `cd tools && python gen.py -s \"Your Theme Name\"`.\n\nFor both paths: optionally update `CREDITS.md`, and do **not** hand-edit files in generated format directories. See `README.md` (Contribute) for full details.\n\n## Adding a new output format\n\n1. Create a Jinja2 template in `tools/templates/` using placeholders documented in `README.md` (Contribute → How to add new template).\n2. Test with `cd tools && python gen.py -t <template-name>`.\n3. Update `requirements.txt` or `.python-version` only if dependencies change.\n\n## Important rules\n\n- **Prefer YAML for new themes.** Add `yaml/*.yml` unless the source is a direct iTerm2 export.\n- **Edit sources, not outputs.** Change `yaml/` or `schemes/`, then regenerate. Never manually patch hundreds of generated theme files.\n- **Use selective generation** (`-s`, `-t`) when working on a single theme or format to avoid long runtimes.\n- **Theme naming.** Name source files as the display name (`yaml/Catppuccin Mocha.yml`, `schemes/SpaceGray Eighties.itermcolors`). No slugifying or underscores. YAML `name:` must match the filename if set. Quote names with spaces in CLI commands.\n- **Avoid unrelated changes.** This repo is large; keep diffs focused on the task (one theme, one template, one tool fix).\n- **README screenshots** are auto-generated by `tools/generate_screenshots_readme.py`; do not hand-edit the screenshots section in `README.md`.\n- **Disclose agent usage.** Note AI agent involvement in commit messages and PR descriptions. Agent-generated code and themes are welcome; the user may remove the disclosure if they prefer.\n\n## CI behavior\n\nGitHub Actions (`.github/workflows/generate-all.yml`) regenerates themes and screenshots on pushes to `master` that touch `schemes/`, `yaml/`, or `screenshots/README.md`. PRs should include source changes; generated artifacts may be updated by CI.\n\n## Further reading\n\n- `README.md` — installation, contribution workflow, and template placeholder reference\n- `yaml/README.md` — YAML source format\n- `CREDITS.md` — theme attribution"},"items":[{"name":"AGENTS.md","path":"AGENTS.md","title":"AGENTS.md","content":"# AGENTS.md\n\nGuidance for AI coding agents working in this repository.\n\n## Project overview\n\nThis repo collects terminal color schemes and generates them for 30+ targets (iTerm2, Alacritty, Kitty, WezTerm, VS Code, Windows Terminal, etc.). Source themes live in `yaml/` (`.yml`, preferred for new themes) and `schemes/` (`.itermcolors`, for themes exported directly from iTerm2). Everything else under format directories (`alacritty/`, `kitty/`, `wezterm/`, …) is generated output.\n\n## Repository layout\n\n| Path | Purpose |\n|------|---------|\n| `yaml/` | Preferred source for new themes (Gogh-based YAML format) |\n| `schemes/` | iTerm2 `.itermcolors` source files (use when exporting from iTerm2) |\n| `tools/` | Generation scripts, converters, and Jinja2 templates |\n| `tools/templates/` | Per-format Jinja2 templates |\n| `screenshots/` | Auto-generated theme preview images |\n\n## Setup\n\n```bash\npython -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.txt\n```\n\nPython version: see `.python-version` (currently 3.10). Docker alternative: `./generate-all.sh`.\n\nActivate the venv before running commands below (`source .venv/bin/activate`), or prefix with `.venv/bin/python`.\n\n## Common commands\n\n```bash\n# Generate all themes for all formats\ncd tools && python gen.py\n\n# Generate one theme (preferred while iterating)\ncd tools && python gen.py -s \"Your Theme Name\"\n\n# Generate one format template only\ncd tools && python gen.py -t kitty\n\n# Full local pipeline (macOS; regenerates all themes, Terminal profiles, screenshots, README)\n./generate-all-nodocker.sh\n\n# Check WCAG contrast (default threshold 1.75, matches gen.py)\npython tools/wcag_check.py -s \"Your Theme Name\"\npython tools/wcag_check.py --schemes-dir schemes   # all schemes\n\n# YAML themes: generate .itermcolors first, then check\ncd tools && python gen.py -s \"Your Theme Name\"\npython tools/wcag_check.py -s \"Your Theme Name\"\n\n# Visual preview (display-only truecolor; does not change terminal palette)\npython tools/preview_theme.py -s \"Your Theme Name\"\n```\n\n## Adding a new theme\n\n**Prefer YAML** unless the theme is being exported directly from iTerm2.\n\n### YAML (default)\n\n1. Create `yaml/Your Theme Name.yml` following `yaml/README.md`. Use the display name as the filename — spaces are fine; do not slugify or use underscores.\n2. Convert from other formats if needed: `tools/kitty_to_yaml.py`, `tools/ghostty_to_yaml.py`.\n3. Regenerate with `cd tools && python gen.py -s \"Your Theme Name\"`.\n\n### iTerm2 export (when applicable)\n\n1. Export from iTerm2 and add `schemes/Your Theme Name.itermcolors`.\n2. Regenerate with `cd tools && python gen.py -s \"Your Theme Name\"`.\n\nFor both paths: optionally update `CREDITS.md`, and do **not** hand-edit files in generated format directories. See `README.md` (Contribute) for full details.\n\n## Adding a new output format\n\n1. Create a Jinja2 template in `tools/templates/` using placeholders documented in `README.md` (Contribute → How to add new template).\n2. Test with `cd tools && python gen.py -t <template-name>`.\n3. Update `requirements.txt` or `.python-version` only if dependencies change.\n\n## Important rules\n\n- **Prefer YAML for new themes.** Add `yaml/*.yml` unless the source is a direct iTerm2 export.\n- **Edit sources, not outputs.** Change `yaml/` or `schemes/`, then regenerate. Never manually patch hundreds of generated theme files.\n- **Use selective generation** (`-s`, `-t`) when working on a single theme or format to avoid long runtimes.\n- **Theme naming.** Name source files as the display name (`yaml/Catppuccin Mocha.yml`, `schemes/SpaceGray Eighties.itermcolors`). No slugifying or underscores. YAML `name:` must match the filename if set. Quote names with spaces in CLI commands.\n- **Avoid unrelated changes.** This repo is large; keep diffs focused on the task (one theme, one template, one tool fix).\n- **README screenshots** are auto-generated by `tools/generate_screenshots_readme.py`; do not hand-edit the screenshots section in `README.md`.\n- **Disclose agent usage.** Note AI agent involvement in commit messages and PR descriptions. Agent-generated code and themes are welcome; the user may remove the disclosure if they prefer.\n\n## CI behavior\n\nGitHub Actions (`.github/workflows/generate-all.yml`) regenerates themes and screenshots on pushes to `master` that touch `schemes/`, `yaml/`, or `screenshots/README.md`. PRs should include source changes; generated artifacts may be updated by CI.\n\n## Further reading\n\n- `README.md` — installation, contribution workflow, and template placeholder reference\n- `yaml/README.md` — YAML source format\n- `CREDITS.md` — theme attribution","category":"root","tokens":1158}]}