Skip to content

Add ghostel (libghostty) terminal backend #134

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

Open
dakra wants to merge 1 commit into
base: main
Choose a base branch
from
+192 −11
Open

Add ghostel (libghostty) terminal backend #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ An Emacs interface for [Claude Code CLI](https://github.com/anthropics/claude-co
- **Read-Only Mode** - Toggle to select and copy text with normal Emacs commands and keybindings
- **Mode Cycling** - Quick switch between default, auto-accept edits, and plan modes
- **Desktop Notifications** - Get notified when Claude finishes processing
- **Terminal Choice** - Works with both eat and vterm backends
- **Terminal Choice** - Works with eat, vterm, and ghostel (libghostty) backends
- **Fully Customizable** - Configure keybindings, notifications, and display preferences

## Installation
Expand All @@ -25,7 +25,7 @@ An Emacs interface for [Claude Code CLI](https://github.com/anthropics/claude-co
- Emacs 30.0 or higher
- [Claude Code CLI](https://github.com/anthropics/claude-code) installed and configured
- Required: transient (0.7.5+) inheritenv (0.2)
- Optional: eat (0.9.2+) for eat backend, vterm for vterm backend
- Optional: eat (0.9.2+) for eat backend, vterm for vterm backend, [ghostel](https://github.com/dakra/ghostel) for ghostel backend
- Note: If not using a `:vc` install, the `eat` package requires NonGNU ELPA:
```elisp
(add-to-list 'package-archives '("nongnu" . "https://elpa.nongnu.org/nongnu/"))
Expand All @@ -50,6 +50,10 @@ An Emacs interface for [Claude Code CLI](https://github.com/anthropics/claude-co
;; for vterm terminal backend:
(use-package vterm :ensure t)

;; for ghostel terminal backend (libghostty):
(use-package ghostel
:vc (:url "https://github.com/dakra/ghostel" :rev :newest))

;; install claude-code.el
(use-package claude-code :ensure t
:vc (:url "https://github.com/stevemolitor/claude-code.el" :rev :newest)
Expand Down Expand Up @@ -87,6 +91,10 @@ An Emacs interface for [Claude Code CLI](https://github.com/anthropics/claude-co
;; for vterm terminal backend:
(use-package vterm :straight t)

;; for ghostel terminal backend (libghostty):
(use-package ghostel
:straight (:type git :host github :repo "dakra/ghostel"))

;; install claude-code.el, using :depth 1 to reduce download size:
(use-package claude-code
:straight (:type git :host github :repo "stevemolitor/claude-code.el" :branch "main" :depth 1
Expand All @@ -109,13 +117,17 @@ An Emacs interface for [Claude Code CLI](https://github.com/anthropics/claude-co
### Setting Prefix Key
You need to set your own key binding for the Claude Code command map, as described in the [Installation](#installation) section. The examples in this README use `C-c c` as the prefix key.

### Picking Eat or Vterm
### Picking a Terminal Backend

By default claude-code.el uses the `eat` backend. If you prefer vterm customize
`claude-code-terminal-backend`:
By default claude-code.el uses the `eat` backend. You can switch to vterm or
ghostel by customizing `claude-code-terminal-backend`:

```elisp
;; Use vterm:
(setq claude-code-terminal-backend 'vterm)

;; Use ghostel (libghostty-powered terminal emulator):
(setq claude-code-terminal-backend 'ghostel)
```

### Transient Menu
Expand Down
181 changes: 175 additions & 6 deletions claude-code.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,10 @@ resizing."

(defcustom claude-code-terminal-backend 'eat
"Terminal backend to use for Claude Code.
Choose between \\='eat (default) and \\='vterm terminal emulators."
Choose between \\='eat (default), \\='vterm, and \\='ghostel terminal emulators."
:type '(radio (const :tag "Eat terminal emulator" eat)
(const :tag "Vterm terminal emulator" vterm))
(const :tag "Vterm terminal emulator" vterm)
(const :tag "Ghostel terminal emulator (libghostty)" ghostel))
:group 'claude-code)

(defcustom claude-code-no-delete-other-windows nil
Expand Down Expand Up @@ -909,6 +910,168 @@ _BACKEND is the terminal backend type (should be \\='vterm)."
"Get the BACKEND specific function that adjusts window size."
#'vterm--window-adjust-process-window-size)

;;;;; ghostel backend implementations

;; Declare external variables and functions from ghostel package
(defvar ghostel--process)
(defvar ghostel--copy-mode-active)
(defvar ghostel--saved-local-map)
(defvar ghostel-kill-buffer-on-exit)
(declare-function ghostel-exec "ghostel")
(declare-function ghostel--send-key "ghostel")
(declare-function ghostel--send-encoded "ghostel")
(declare-function ghostel-copy-mode "ghostel")
(declare-function ghostel-copy-mode-exit "ghostel")
(declare-function ghostel--window-adjust-process-window-size "ghostel")
(declare-function ghostel--set-title "ghostel")

;; Helper to ensure ghostel is loaded
(defun claude-code--ensure-ghostel ()
"Ensure ghostel package is loaded."
(unless (featurep 'ghostel)
(unless (require 'ghostel nil t)
(error "The ghostel package is required for ghostel terminal backend. Please install it"))))

(cl-defmethod claude-code--term-make ((_backend (eql ghostel)) buffer-name program &optional switches)
"Create a ghostel terminal for BACKEND.

_BACKEND is the terminal backend type (should be \\='ghostel).
BUFFER-NAME is the name for the new terminal buffer.
PROGRAM is the program to run in the terminal.
SWITCHES are optional command-line arguments for PROGRAM."
(claude-code--ensure-ghostel)
(let ((buffer (get-buffer-create buffer-name)))
(inheritenv (ghostel-exec buffer program switches))
buffer))

(cl-defmethod claude-code--term-send-string ((_backend (eql ghostel)) string)
"Send STRING to ghostel terminal.

_BACKEND is the terminal backend type (should be \\='ghostel).
STRING is the text to send to the terminal."
(ghostel--send-key string))

(cl-defmethod claude-code--term-kill-process ((_backend (eql ghostel)) buffer)
"Kill the ghostel terminal process in BUFFER.

_BACKEND is the terminal backend type (should be \\='ghostel).
BUFFER is the terminal buffer containing the process to kill."
(when (buffer-live-p buffer)
(with-current-buffer buffer
(when (and ghostel--process (process-live-p ghostel--process))
(kill-process ghostel--process)))
(kill-buffer buffer)))

(cl-defmethod claude-code--term-read-only-mode ((_backend (eql ghostel)))
"Switch ghostel terminal to read-only mode.

_BACKEND is the terminal backend type (should be \\='ghostel)."
(claude-code--ensure-ghostel)
(unless ghostel--copy-mode-active
(ghostel-copy-mode)))

(cl-defmethod claude-code--term-interactive-mode ((_backend (eql ghostel)))
"Switch ghostel terminal to interactive mode.

_BACKEND is the terminal backend type (should be \\='ghostel)."
(claude-code--ensure-ghostel)
(when ghostel--copy-mode-active
(ghostel-copy-mode-exit)
;; Re-setup keymap since ghostel-copy-mode-exit restores the saved keymap
(claude-code--term-setup-keymap 'ghostel)))

(cl-defmethod claude-code--term-in-read-only-p ((_backend (eql ghostel)))
"Check if ghostel terminal is in read-only mode.

_BACKEND is the terminal backend type (should be \\='ghostel)."
ghostel--copy-mode-active)

(defun claude-code--ghostel-bell-handler ()
"Handle bell from ghostel terminal by triggering Claude notification."
(claude-code--notify nil))

(defun claude-code--ghostel-inhibit-title (orig-fun &rest args)
"Prevent ghostel title changes in claude-code buffers.

ORIG-FUN is the original `ghostel--set-title' function.
ARGS are the arguments passed to it."
(unless (claude-code--buffer-p (current-buffer))
(apply orig-fun args)))

(cl-defmethod claude-code--term-configure ((_backend (eql ghostel)))
"Configure ghostel terminal in current buffer.

_BACKEND is the terminal backend type (should be \\='ghostel)."
(claude-code--ensure-ghostel)
;; Prevent ghostel from killing buffer on process exit directly;
;; instead route through claude-code--kill-buffer for proper cleanup
(setq-local ghostel-kill-buffer-on-exit nil)
(add-hook 'ghostel-exit-functions
(lambda (buf _event)
(claude-code--kill-buffer buf))
nil t)
;; Prevent ghostel from renaming the buffer via OSC title sequences
(advice-add 'ghostel--set-title :around #'claude-code--ghostel-inhibit-title)
;; Route bell to claude-code notification system
;; (ghostel native module calls `ding' on BEL, which uses ring-bell-function)
(setq-local ring-bell-function #'claude-code--ghostel-bell-handler)
;; Fix initial terminal layout timing
(sleep-for claude-code-startup-delay))

(cl-defmethod claude-code--term-customize-faces ((_backend (eql ghostel)))
"Apply face customizations for ghostel terminal.

_BACKEND is the terminal backend type (should be \\='ghostel)."
;; Ghostel inherits from term-color-* faces; no remapping needed
)

(defun claude-code--ghostel-send-return ()
"Send return key to ghostel."
(interactive)
(ghostel--send-key "\r"))

(defun claude-code--ghostel-send-alt-return ()
"Send <alt>-<return> to ghostel."
(interactive)
(ghostel--send-encoded "return" "meta"))

(defun claude-code--ghostel-send-escape ()
"Send escape key to ghostel."
(interactive)
(ghostel--send-key "\e"))

(cl-defmethod claude-code--term-setup-keymap ((_backend (eql ghostel)))
"Set up the local keymap for Claude Code buffers.

_BACKEND is the terminal backend type (should be \\='ghostel)."
(let ((map (make-sparse-keymap)))
;; Inherit parent ghostel keymap
(set-keymap-parent map (current-local-map))

;; C-g for escape
(define-key map (kbd "C-g") #'claude-code--ghostel-send-escape)

;; Configure key bindings based on user preference
(pcase claude-code-newline-keybinding-style
('newline-on-shift-return
(define-key map (kbd "<S-return>") #'claude-code--ghostel-send-alt-return)
(define-key map (kbd "<return>") #'claude-code--ghostel-send-return))
('newline-on-alt-return
(define-key map (kbd "<M-return>") #'claude-code--ghostel-send-alt-return)
(define-key map (kbd "<return>") #'claude-code--ghostel-send-return))
('shift-return-to-send
(define-key map (kbd "<return>") #'claude-code--ghostel-send-alt-return)
(define-key map (kbd "<S-return>") #'claude-code--ghostel-send-return))
('super-return-to-send
(define-key map (kbd "<return>") #'claude-code--ghostel-send-alt-return)
(define-key map (kbd "<s-return>") #'claude-code--ghostel-send-return)))

(use-local-map map)))

(cl-defmethod claude-code--term-get-adjust-process-window-size-fn ((_backend (eql ghostel)))
"Get the ghostel specific function that adjusts window size."
#'ghostel--window-adjust-process-window-size)

;;;; Private util functions
(defmacro claude-code--with-buffer (&rest body)
"Execute BODY with the Claude buffer, handling buffer selection and display.
Expand Down Expand Up @@ -1134,6 +1297,9 @@ If FORCE-PROMPT is non-nil, always prompt even if no instances exist."
(when (eq claude-code-terminal-backend 'vterm)
(advice-remove 'vterm--filter #'claude-code--vterm-bell-detector)
(advice-remove 'vterm--filter #'claude-code--vterm-multiline-buffer-filter))
;; Remove ghostel advice if using ghostel backend
(when (eq claude-code-terminal-backend 'ghostel)
(advice-remove 'ghostel--set-title #'claude-code--ghostel-inhibit-title))
;; Clean the window widths hash table
(when claude-code--window-widths
(clrhash claude-code--window-widths))
Expand Down Expand Up @@ -1298,7 +1464,10 @@ With double prefix ARG (\\[universal-argument] \\[universal-argument]), prompt f
(set-window-parameter window 'left-fringe-width 0)
(set-window-parameter window 'right-fringe-width 0)
;; set no-delete-other-windows parameter for claude-code window
(set-window-parameter window 'no-delete-other-windows claude-code-no-delete-other-windows))))
(set-window-parameter window 'no-delete-other-windows claude-code-no-delete-other-windows)
;; Optionally select the window based on user preference
(when claude-code-toggle-auto-select
(select-window window)))))

;; switch to the Claude buffer if asked to
(when switch-after
Expand Down Expand Up @@ -1494,9 +1663,9 @@ ARGS can contain additional arguments passed from the CLI."

;; Run the event hook and potentially get a JSON response
(let* ((message (list :type type
:buffer-name buffer-name
:json-data json-data
:args (append args extra-args)))
:buffer-name buffer-name
:json-data json-data
:args (append args extra-args)))
(hook-response (run-hook-with-args-until-success 'claude-code-event-hook message)))

;; Return hook response if any, otherwise nil
Expand Down