Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jixiuf/vterm-toggle
toggles between the vterm buffer and whatever buffer you are editing.
https://github.com/jixiuf/vterm-toggle
emacs libvterm terminal vterm
Last synced: 3 months ago
JSON representation
toggles between the vterm buffer and whatever buffer you are editing.
- Host: GitHub
- URL: https://github.com/jixiuf/vterm-toggle
- Owner: jixiuf
- License: gpl-3.0
- Created: 2019-03-23T14:31:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-12T02:46:28.000Z (about 1 year ago)
- Last Synced: 2024-02-16T07:36:56.978Z (9 months ago)
- Topics: emacs, libvterm, terminal, vterm
- Language: Emacs Lisp
- Homepage:
- Size: 83 KB
- Stars: 173
- Watchers: 7
- Forks: 11
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://melpa.org/#/vterm-toggle)
# vterm-toggle Toggle vterm buffer
[emacs-libvterm](https://github.com/akermu/emacs-libvterm) is fully-fledged terminal emulator inside GNU Emacs based on libvterm.
This package provides the command `vterm-toggle` which toggles between the vterm
buffer and whatever buffer you are editing.
This is done in an "intelligent" way. Features are:
1. Starts a vterm if none is existent.
2. Minimum distortion of your window configuration.
3. When done in the vterm-buffer you are returned to the same window
configuration you had before you toggled to the shell.
4. If you desire, you automagically get a `cd` command in the shell to the
directory where your current buffers file exists, just call `vterm-toggle-cd`
instead of `vterm-toggle`.
```
(global-set-key [f2] 'vterm-toggle)
(global-set-key [C-f2] 'vterm-toggle-cd)
;; you can cd to the directory where your previous buffer file exists
;; after you have toggle to the vterm buffer with `vterm-toggle'.
(define-key vterm-mode-map [(control return)] #'vterm-toggle-insert-cd)
;Switch to next vterm buffer
(define-key vterm-mode-map (kbd "s-n") 'vterm-toggle-forward)
;Switch to previous vterm buffer
(define-key vterm-mode-map (kbd "s-p") 'vterm-toggle-backward)
```
# Customize
## vterm-toggle-cd-auto-create-buffer
With
```
(setq vterm-toggle-cd-auto-create-buffer nil)
```
`vterm-toggle-cd` would activate a recent vterm buffer even if no prompt can be found
(with vterm-toggle-use-dedicated-buffer still nil). So when the current buffer is not a vterm buffer,
it would always activate a recent vterm buffer if there is one but would only insert cd if the prompt is available.
And you can bind
```
(define-key vterm-mode-map [(control return)] #'vterm-toggle-insert-cd)
```
## vterm-toggle-reset-window-configration-after-exit
`t` Reset window configuration after vterm buffer is killed.
`'kill-window-only` Kill Window only.
## vterm-toggle-hide-method
1. `delete-window` Delete vterm window
2. `nil` Toggle without closing the vterm window, just jump back-and-forth
between vterm and a code buffer.
3. `reset-window-configration` Reset window configration
## show vterm buffer in current window
```
(setq vterm-toggle-fullscreen-p nil)
(add-to-list 'display-buffer-alist
'((lambda (buffer-or-name _)
(let ((buffer (get-buffer buffer-or-name)))
(with-current-buffer buffer
(or (equal major-mode 'vterm-mode)
(string-prefix-p vterm-buffer-name (buffer-name buffer))))))
(display-buffer-reuse-window display-buffer-same-window)))
```
## show vterm buffer in bottom side
```
(setq vterm-toggle-fullscreen-p nil)
(add-to-list 'display-buffer-alist
'((lambda (buffer-or-name _)
(let ((buffer (get-buffer buffer-or-name)))
(with-current-buffer buffer
(or (equal major-mode 'vterm-mode)
(string-prefix-p vterm-buffer-name (buffer-name buffer))))))
(display-buffer-reuse-window display-buffer-at-bottom)
;;(display-buffer-reuse-window display-buffer-in-direction)
;;display-buffer-in-direction/direction/dedicated is added in emacs27
;;(direction . bottom)
;;(dedicated . t) ;dedicated is supported in emacs27
(reusable-frames . visible)
(window-height . 0.3)))
```
## show vterm buffer in side window
If you want show vterm buffer at bottom side window:
```
(setq vterm-toggle-fullscreen-p nil)
(add-to-list 'display-buffer-alist
'((lambda (buffer-or-name _)
(let ((buffer (get-buffer buffer-or-name)))
(with-current-buffer buffer
(or (equal major-mode 'vterm-mode)
(string-prefix-p vterm-buffer-name (buffer-name buffer))))))
(display-buffer-reuse-window display-buffer-in-side-window)
(side . bottom)
;;(dedicated . t) ;dedicated is supported in emacs27
(reusable-frames . visible)
(window-height . 0.3)))
```
# work with centaur-tabs (select next/prev vterm buffer)
https://github.com/ema2159/centaur-tabs/
You can customize `centaur-tabs` and make all vterm buffer in a tab group, and
use `centaur-tabs-forward` and `centaur-tabs-backward` switch from one vterm
buffer to another.
```
(global-set-key (kbd "s-n") 'centaur-tabs-forward)
(global-set-key (kbd "s-p") 'centaur-tabs-backward)
```
```
(setq centaur-tabs-buffer-groups-function 'vmacs-awesome-tab-buffer-groups)
(defun vmacs-awesome-tab-buffer-groups ()
"`vmacs-awesome-tab-buffer-groups' control buffers' group rules. "
(list
(cond
((derived-mode-p 'eshell-mode 'term-mode 'shell-mode 'vterm-mode)
"Term")
((string-match-p (rx (or
"\*Helm"
"\*helm"
"\*tramp"
"\*Completions\*"
"\*sdcv\*"
"\*Messages\*"
"\*Ido Completions\*"
))
(buffer-name))
"Emacs")
(t "Common"))))
(setq vterm-toggle--vterm-buffer-p-function 'vmacs-term-mode-p)
(defun vmacs-term-mode-p(&optional args)
(derived-mode-p 'eshell-mode 'term-mode 'shell-mode 'vterm-mode))
```
# vterm-toggle-use-dedicated-buffer
When vterm-toggle-use-dedicated-buffer is not nil, you can toggle to a dedicated vterm buffer.
you can toggle to different dedicated buffer for different purpose.
For example, I want to replace default `compile` with my `vterm-compile`
```
(defvar vterm-compile-dedicated-buffer nil)
(defun vterm-compile ()
(interactive)
(let ((vterm-toggle-use-dedicated-buffer t)
(vterm-toggle--vterm-dedicated-buffer vterm-compile-dedicated-buffer))
(with-current-buffer (vterm-toggle-cd)
(setq vterm-compile-dedicated-buffer (current-buffer))
(rename-buffer "term compile")
(compilation-shell-minor-mode 1)
(vterm-send-string compile-command t)
(vterm-send-return))
)
)
```