ghostty-bg 0.1.0 → 0.2.0

package/README.md

@@ -1,14 +1,14 @@
 # ghostty-bg (`gbg`)
 
-Change your terminal background color with one command.
+Per-directory background colors for Ghostty — one command per project.
 
 https://github.com/user-attachments/assets/28d9a5a6-a82c-4da5-b39d-c8d9bf58036f
 
 `gbg` is a tiny, zero-dependency Node CLI. It sends the standard
 [OSC 11](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) escape
-sequence to recolor the current window instantly, and saves the color to
-Ghostty's config so it sticks across new windows and restarts — no Ghostty fork
-or special API required.
+sequence to recolor the current window instantly, and remembers the color per
+directory. With the shell hook installed, `cd` into a directory and its color
+is applied automatically — no Ghostty fork or special API required.
 
 ## Install
 
@@ -25,13 +25,14 @@ npx ghostty-bg --color dracula
 ## Usage
 
 ```sh
-gbg                     # random color from the built-in palette
+gbg                     # random color, remembered for this directory
 gbg --color dracula     # a named theme
 gbg --color "#1a2b3c"   # a hex value (#rgb or #rrggbb)
 gbg teal                # shorthand for --color
-gbg --no-save tomato    # current window only, don't persist
-gbg --reset             # clear the color (window + saved config)
+gbg --no-save tomato    # current window only, not remembered
+gbg --reset             # forget this directory's color, reset background
 gbg --list              # list available color names
+gbg shell-init          # print the zsh cd hook
 gbg --help              # show help
 gbg --version           # show version
 ```
@@ -51,29 +52,35 @@ Short flags: `-c` (color), `-n` (no-save), `-r` (reset), `-l` (list),
 Running `gbg` with no arguments picks a random color from a curated palette of
 dark, readable backgrounds.
 
-## Persistence
+## Per-directory colors
 
 By default `gbg` does two things:
 
 1. Recolors the **current window** immediately via OSC 11.
-2. Saves the color so it **survives new windows and restarts**.
+2. Remembers the color for the **current directory**.
 
-For persistence on Ghostty, `gbg` writes `background = <color>` to a dedicated
-`gbg.conf` in your Ghostty config directory and adds a single
-`config-file = .../gbg.conf` line to your main `config` (only that one line is
-ever added — the color itself lives only in `gbg.conf`).
+To make `cd` apply the remembered color automatically, add the hook to your
+shell:
 
-- Already-open windows update on the spot (OSC 11). Other already-open windows
-  pick it up after a Ghostty config reload.
-- New windows and restarts read it from the config.
-- `gbg --no-save` skips step 2 (current window only).
-- `gbg --reset` clears the saved color and returns to your theme default.
+```sh
+echo 'eval "$(gbg shell-init)"' >> ~/.zshrc
+```
+
+After that:
+
+- `cd` into a remembered directory → its color is applied.
+- `cd` anywhere else → the background returns to your theme default.
+- `gbg --no-save` applies to the current window without remembering it.
+- `gbg --reset` forgets the current directory's color.
+
+The hook is plain zsh and reads a small `paths` file with `awk`, so it adds no
+Node startup cost on `cd`. Colors are matched by exact directory.
 
 ## How It Works
 
-`gbg` writes `ESC ] 11 ; <color> BEL` to the terminal to set the live
-background, and `ESC ] 111 BEL` to reset it. Persistence is a plain
-`background = <color>` line in a Ghostty `config-file` include.
+`gbg` writes `ESC ] 11 ; <color> BEL` to the terminal to set the background and
+`ESC ] 111 BEL` to reset it. Remembered colors live in
+`${XDG_CONFIG_HOME:-~/.config}/gbg/paths` as `<dir><TAB><#hex>` lines.
 
 ## Requirements
 

package/bin/gbg.js

@@ -9,41 +9,61 @@ import {
   UnknownColorError,
 } from "../src/colors.js";
 import { setBackground, resetBackground } from "../src/terminal.js";
-import { saveColor, clearColor, gbgConfPath } from "../src/config.js";
+import { setPathColor, clearPathColor, pathsFile } from "../src/paths.js";
 
 function readVersion() {
   const pkgPath = fileURLToPath(new URL("../package.json", import.meta.url));
   return JSON.parse(readFileSync(pkgPath, "utf8")).version;
 }
 
-const HELP = `gbg — change your terminal background color (Ghostty & any OSC 11 terminal)
+const HELP = `gbg — per-directory background colors for Ghostty (& any OSC 11 terminal)
 
 Usage:
-  gbg                     Apply a random color from the built-in palette
-  gbg --color <name|hex>  Apply a specific color (name or #hex)
+  gbg                     Apply a random color and remember it for this directory
+  gbg --color <name|hex>  Apply a specific color (name or #hex) and remember it
   gbg <name|hex>          Shorthand for --color
-  gbg --no-save           Apply to the current session only (don't persist)
-  gbg --reset             Reset the background and clear the persisted color
+  gbg --no-save           Apply to the current window only (don't remember)
+  gbg --reset             Forget this directory's color and reset the background
   gbg --list              List available color names
+  gbg shell-init          Print the zsh hook that switches color on cd
   gbg --help              Show this help
   gbg --version           Show version
 
 Examples:
-  gbg
-  gbg --color dracula
-  gbg -c "#1a2b3c"
+  gbg --color dracula     # this directory is dracula from now on
   gbg teal
-  gbg --no-save tomato
+  gbg --no-save tomato    # one-off, not remembered
   gbg --reset
 
+Per-directory colors:
+  By default gbg remembers the color for the current directory. Add the cd hook
+  to your shell so it switches automatically:
+
+      echo 'eval "$(gbg shell-init)"' >> ~/.zshrc
+
+  Then cd into a remembered directory and its color is applied; cd elsewhere and
+  the background returns to your theme default.
+
 Colors:
   - Named themes (dracula, nord, gruvbox, tokyonight, ...)
   - CSS color names (red, teal, midnightblue, ...)
-  - Hex: #rgb or #rrggbb (with or without the leading #)
+  - Hex: #rgb or #rrggbb (with or without the leading #)`;
 
-By default the color is applied to the current session (via OSC 11) and saved to
-Ghostty's config so it survives new windows and restarts. Use --no-save for a
-one-off change, or --reset to clear it.`;
+const SHELL_INIT = `# gbg: per-directory background colors
+_gbg_paths="\${XDG_CONFIG_HOME:-$HOME/.config}/gbg/paths"
+_gbg_apply() {
+  [[ -t 1 ]] || return
+  local hex=""
+  [[ -r "$_gbg_paths" ]] && hex=$(command awk -F'\\t' -v p="$PWD" '$1==p{print $2; exit}' "$_gbg_paths")
+  if [[ -n "$hex" ]]; then
+    printf '\\033]11;%s\\007' "$hex"
+  else
+    printf '\\033]111\\007'
+  fi
+}
+autoload -Uz add-zsh-hook
+add-zsh-hook chpwd _gbg_apply
+_gbg_apply`;
 
 function printList() {
   const { themes, css } = colorNames();
@@ -76,6 +96,10 @@ function main() {
 
   const { values, positionals } = parsed;
 
+  if (positionals[0] === "shell-init") {
+    console.log(SHELL_INIT);
+    return;
+  }
   if (values.help) {
     console.log(HELP);
     return;
@@ -88,10 +112,22 @@ function main() {
     printList();
     return;
   }
+
+  // Match the shell's logical $PWD (which the cd hook uses) rather than the
+  // symlink-resolved physical path, so keys line up across symlinked dirs.
+  const cwd =
+    process.env.PWD && process.env.PWD.startsWith("/")
+      ? process.env.PWD
+      : process.cwd();
+
   if (values.reset) {
     resetBackground();
-    clearColor();
-    console.error("gbg: background reset (cleared from this session and Ghostty config)");
+    const had = clearPathColor(cwd);
+    console.error(
+      had
+        ? `gbg: forgot color for ${cwd} and reset the background`
+        : "gbg: background reset to theme default",
+    );
     return;
   }
 
@@ -116,8 +152,8 @@ function main() {
   console.error(`gbg: background → ${label}`);
 
   if (!values["no-save"]) {
-    saveColor(result.hex);
-    console.error(`gbg: saved to ${gbgConfPath()} (new windows & restarts; reload Ghostty config to refresh open windows)`);
+    setPathColor(cwd, result.hex);
+    console.error(`gbg: remembered for ${cwd} (applies when you cd here)`);
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ghostty-bg",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Change your Ghostty (or any OSC 11 terminal) background color with a single command.",
   "author": "Masa",
   "homepage": "https://github.com/MASAKASUNO1/ghostty-path-bg#readme",

package/src/paths.js

@@ -0,0 +1,47 @@
+// Per-directory color memory. Stored as a simple tab-separated file
+// (`<abs-dir>\t<#hex>` per line) so the zsh cd-hook can read it with awk
+// without spawning Node on every directory change.
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { existsSync, readFileSync, writeFileSync, mkdirSync } from "node:fs";
+
+function gbgDir() {
+  const base = process.env.XDG_CONFIG_HOME || join(homedir(), ".config");
+  return join(base, "gbg");
+}
+
+export function pathsFile() {
+  return join(gbgDir(), "paths");
+}
+
+function read() {
+  const file = pathsFile();
+  const map = new Map();
+  if (!existsSync(file)) return map;
+  for (const line of readFileSync(file, "utf8").split("\n")) {
+    if (!line) continue;
+    const tab = line.indexOf("\t");
+    if (tab < 0) continue;
+    map.set(line.slice(0, tab), line.slice(tab + 1));
+  }
+  return map;
+}
+
+function write(map) {
+  mkdirSync(gbgDir(), { recursive: true });
+  const body = [...map.entries()].map(([dir, hex]) => `${dir}\t${hex}`).join("\n");
+  writeFileSync(pathsFile(), body.length ? body + "\n" : "");
+}
+
+export function setPathColor(dir, hex) {
+  const map = read();
+  map.set(dir, hex);
+  write(map);
+}
+
+export function clearPathColor(dir) {
+  const map = read();
+  const had = map.delete(dir);
+  if (had) write(map);
+  return had;
+}

package/src/config.js

@@ -1,57 +0,0 @@
-// Persist the background across Ghostty restarts and new windows.
-//
-// gbg owns a small include file (gbg.conf) and makes the main Ghostty config
-// load it via `config-file`. Only that one include line is ever added to the
-// user's config; the color itself only ever lives in gbg.conf, so gbg never
-// rewrites the rest of the user's configuration.
-import { homedir } from "node:os";
-import { join } from "node:path";
-import { existsSync, readFileSync, writeFileSync, mkdirSync } from "node:fs";
-
-function ghosttyDir() {
-  const base = process.env.XDG_CONFIG_HOME || join(homedir(), ".config");
-  return join(base, "ghostty");
-}
-
-export function gbgConfPath() {
-  return join(ghosttyDir(), "gbg.conf");
-}
-
-function mainConfigPath() {
-  return join(ghosttyDir(), "config");
-}
-
-const INCLUDE_MARKER = "# gbg: persist background across Ghostty restarts";
-
-function ensureInclude() {
-  const dir = ghosttyDir();
-  mkdirSync(dir, { recursive: true });
-
-  const main = mainConfigPath();
-  const includeLine = `config-file = ${gbgConfPath()}`;
-  const content = existsSync(main) ? readFileSync(main, "utf8") : "";
-  if (content.includes(includeLine)) return;
-
-  // Appended last so gbg.conf's `background` overrides any theme background.
-  const sep = content.length && !content.endsWith("\n") ? "\n" : "";
-  writeFileSync(main, `${content}${sep}\n${INCLUDE_MARKER}\n${includeLine}\n`);
-}
-
-export function saveColor(hex) {
-  ensureInclude();
-  const body =
-    "# Managed by gbg — do not edit by hand.\n" +
-    "# Set with: gbg --color <name|hex>   Clear with: gbg --reset\n" +
-    `background = ${hex}\n`;
-  writeFileSync(gbgConfPath(), body);
-}
-
-export function clearColor() {
-  // Keep the file (emptied) so the config-file include never dangles.
-  if (!existsSync(gbgConfPath())) return;
-  writeFileSync(
-    gbgConfPath(),
-    "# Managed by gbg — no persisted background (cleared).\n" +
-      "# Set one with: gbg --color <name|hex>\n",
-  );
-}