Metadata-Version: 2.4
Name: ghostty-config
Version: 2.4.0
Summary: Themes, fonts, shortcuts and every everyday setting of Ghostty, in a full-screen interface inside the terminal.
Author: Johan H.G. Natter
License-Expression: MIT
License-File: LICENSE
Project-URL: Homepage, https://vitruves.github.io/ghostty-config/
Project-URL: Source, https://github.com/vitruves/ghostty-config
Project-URL: Changelog, https://github.com/vitruves/ghostty-config/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/vitruves/ghostty-config/issues
Keywords: ghostty,terminal,config,themes,tui
Classifier: Environment :: Console
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
Description-Content-Type: text/markdown

<p align="center"><img src="https://raw.githubusercontent.com/vitruves/ghostty-config/2.4.0/img/logo.png" alt="" width="96"></p>

<h1 align="center">ghostty-config</h1>

<p align="center">Themes, fonts, shortcuts and every everyday setting of <a href="https://ghostty.org">Ghostty</a>, in a full-screen interface inside the terminal.<br>A single binary, installed with one command. <a href="https://vitruves.github.io/ghostty-config/">Website</a>.</p>

<p align="center">
  <a href="#install"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fghostty-config.vitruves.workers.dev%2Fbadge.json&style=flat-square" alt="Installs"></a>
  <a href="https://github.com/vitruves/ghostty-config/tags"><img src="https://img.shields.io/github/v/tag/vitruves/ghostty-config?sort=semver&label=release&style=flat-square&color=3d6fd6" alt="Latest release"></a>
  <img src="https://img.shields.io/badge/macOS%20%C2%B7%20Linux-555?style=flat-square" alt="macOS and Linux">
  <a href="https://github.com/vitruves/ghostty-config/blob/2.4.0/LICENSE"><img src="https://img.shields.io/badge/license-MIT-555?style=flat-square" alt="MIT licence"></a>
  <a href="https://cli.masoko.net/tools/ghostty-config/"><img src="https://img.shields.io/badge/terminal%20index-listed-555?style=flat-square" alt="Listed on The Terminal Index"></a>
</p>

<p align="center">
  <img src="https://raw.githubusercontent.com/vitruves/ghostty-config/2.4.0/img/themes.png" alt="The wall of themes" width="820">
</p>

## Install

```bash
curl -fsSL https://ghostty-config.vitruves.workers.dev/install.sh | sh
```

Or with pip (pipx and uv work too): `pip install ghostty-config`.

The script puts a checksum-verified binary for your system (macOS or Linux, Intel or ARM) in `~/.local/bin`. No Go, no git, no dependencies. From source: `git clone https://github.com/vitruves/ghostty-config.git && cd ghostty-config && make build && make local-install`.

## Use

Run `ghostty-config`. Browsing changes nothing: a theme or a font is written when you press `Enter` on it, a setting when you change its value.

## Layouts

The same settings, three ways to reach them. A chooser asks for one at first launch; switch any time with `F4` or in Tool → Interface → Layout.

- **Atelier:** sections in a sidebar, the wall of themes, every setting in its place (the screenshots above and below).
- **Palette:** one search line over themes, fonts, settings, shortcuts and commands, with filters. The highlighted setting opens in place; a theme previews in a strip drawn in its colours.
- **Guided:** six plain questions, one page at a time (Colours, Font, Window, Cursor, Copy & paste, Done), with large previews and a link to all the settings of each step.

<p align="center">
  <img src="https://raw.githubusercontent.com/vitruves/ghostty-config/2.4.0/img/atelier.png" alt="The Palette layout: one search line over everything" width="820">
</p>

<p align="center">
  <img src="https://raw.githubusercontent.com/vitruves/ghostty-config/2.4.0/img/guide.png" alt="The Guided layout: one question at a time" width="820">
</p>

## Keys

The keys of Atelier; Palette and Guided show theirs in the footer.

<div align="center">

| Key | Action |
| :---: | :--- |
| `Tab` | Next section |
| `↑` `↓` | Move through the list |
| `←` `→` | Change the highlighted setting |
| `Enter` | Apply, or open the full list of values |
| `Delete` | Back to Ghostty's default |
| `Ctrl+Z` | Undo the last change |
| `/` or type | Search themes, settings and commands |
| `Ctrl+T` `Ctrl+F` | Try a theme in this terminal; star it |
| `F3` | Ghostty's own documentation of the highlighted line (Ghostty 1.4) |
| `F4` | ghostty-config's own settings: layout, look, reload, update check, drawing |
| `F1` `Esc` | Help; go back, then quit |

</div>

Everything can be clicked too: sections, pills, switches, the arrows beside a long value, and a double click on a theme card applies it. Sliders are pulled: the preview follows the pointer and the value is written when you let go. What the pointer is over lights up, and the mark of a changed setting turns into an arrow that puts Ghostty's default back.

<p align="center">
  <img src="https://raw.githubusercontent.com/vitruves/ghostty-config/2.4.0/img/window.png" alt="Window settings in a light terminal" width="820">
</p>

## Sections

- **Themes:** 1071 themes, the 252 of the curated collection in 27 families and the 819 Ghostty 1.4 ships, plus your own, each shown as a card and checked for contrast. Create, edit and save your own.
- **Fonts:** family, style and size with a specimen set in the font itself, spacing, ligatures, the OpenType features and variable axes the font really has, Nerd Font icons. 70 monospace families can be downloaded in one Enter, and if your font is missing or proportional the tool offers one.
- **Window:** opacity, blur, title bar and title, padding, size and position at launch, full screen, tabs, splits, search and palette colours, background image, with a preview that follows every value.
- **Input:** cursor, mouse (right click, scroll speed), selection, clipboard, links, and every keyboard shortcut: press the new one, conflicts are shown.
- **Session:** window restore, startup command and directory, scrollback, notifications, bell, quick terminal, shell integration, updates, the macOS or Linux specifics, and an Advanced part. 212 Ghostty options in all on macOS with Ghostty 1.4; the few that are lists of lines (`env`, `key-remap`…) stay in the file.
- **Extensions:** shaders (cursor trails, screen effects) and theme packs, with their source and licence shown before install. **Programs** that put Ghostty to use, installed in one Enter and started with your shell: a prompt and completions (starship, zoxide, fzf, atuin, carapace, lig), images in the terminal through the Kitty graphics protocol (yazi, superfile, presenterm, fastfetch, kitten icat, chafa, viu, tdf for PDFs), clickable file names (ripgrep, eza, fd, delta for git), everyday tools in true colour (bat, glow, lazygit), system and disk (btop, bottom, dust, duf, procs, hyperfine), search and data (television, jq, fx, tealdeer, navi), editors (neovim, helix, micro), sessions that outlive their window (zmx, zellij). The list shows one group at a time under a row of tabs: `←` `→` or a click turns them, typing searches them all. A program comes from Homebrew when you have it, else from its GitHub release into `~/.local/bin`, checked against the SHA-256 GitHub gives for the file; nothing runs as root. The line that starts it goes in one marked block of `~/.zshrc` or `~/.bashrc` (`~/.bash_profile` on macOS), backed up before its first change, or in `conf.d/ghostty-config.fish` for fish; switching a program off takes its line out, and a line of your own is left alone. `Ctrl+X` uninstalls a program after a yes: its line goes, then `brew uninstall`, or its files leave `~/.local/bin` (lig runs its own `lig uninstall` first); a program installed some other way (apt, cargo…) is left to its installer.
- **Tool:** reload Ghostty, check the config, see the session's changes, restore a backup, the interface's own layout and look: its scheme, accent colour and contrast, and when drawn as images its size and the width of theme cards.

Settings follow the Ghostty you have: 1.4's new ones (scrollback in bytes, clipboard access and limits, `link-osc8`, the SSH terminfo cache…) are offered to 1.4, and 1.3 keeps working. See [CHANGELOG.md](https://github.com/vitruves/ghostty-config/blob/2.4.0/CHANGELOG.md) for what changed in each version.

## Good to know

- **Your files.** Each setting is rewritten on its own line and comments are kept. If a file changed elsewhere meanwhile, your edits there are kept too. Every file is backed up to `~/.config/ghostty-config/backups/` before its first change.
- **Checked.** After each write the config goes through `ghostty +validate-config`, and any problem is shown with its line.
- **Reload.** On macOS with Ghostty 1.3 or later the tool asks Ghostty to reload over AppleScript (macOS asks once, under Privacy & Security → Automation); older versions get the reload shortcut instead (needs the Accessibility permission). On Linux it activates Ghostty's `reload-config` action over D-Bus, which needs `gdbus` and a single-instance Ghostty; otherwise, reload Ghostty yourself.
- **Display.** In Ghostty and Kitty the interface is drawn as images (Kitty graphics protocol), elsewhere and in tmux with plain text.
- **Updates.** At most once an hour, a background check on GitHub offers new releases. Nothing else uses the network except downloads you ask for.

## Options

```
-config file            edit this file instead of the default config
-themes dir             user themes directory
-cells                  draw the interface with terminal text, keeping images for theme cards
-no-images              never draw images
-images                 draw images even where the terminal is not known to support them
-plain                  use only characters every terminal can draw
-no-reload              never ask Ghostty to reload
-no-update-check        never check GitHub for a new release
-export-collection dir  write the curated themes to a directory and exit
-paths                  print the files that are read and written
-version                print the version
```

`-cells`, `-no-images`, `-images`, `-plain`, `-no-reload` and `-no-update-check` hold for one launch. To keep a choice for every launch, set it in `F4` (Drawing, Simple glyphs, Reload Ghostty after each change, Check for updates); a flag given on the command line overrides the saved preference, and `F4` shows that row as set by the flag.

## Credits

[Ghostty](https://github.com/ghostty-org/ghostty) is by Mitchell Hashimoto and its contributors. Shaders come from [KroneCorylus/ghostty-shader-playground](https://github.com/KroneCorylus/ghostty-shader-playground), [hackrdotsh/ghostty-shaders](https://github.com/hackrdotsh/ghostty-shaders), [sahaj-b/cursor-shaders](https://github.com/sahaj-b/cursor-shaders), [hced/ghostty-cursor-trails](https://github.com/hced/ghostty-cursor-trails) and [s0xDk/ghostty-blackhole](https://github.com/s0xDk/ghostty-blackhole); programs and theme packs from the projects named in the interface. The interface is set in Google Sans Flex and Google Sans Code (SIL OFL). MIT licence.
