Skip to content

Quickly toggle persistent term and shell buffers

License

Notifications You must be signed in to change notification settings

emacsmirror/toggle-term

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Table Of Contents

Toggle Term

toggle-term.el is an Emacs package inspired by toggleterm.nvim, allowing you to spawn a persistent terminal, shell, eshell, or ielm at the bottom of the frame and switch between them when needed.

./assets/toggle-term.gif

Installation

Melpa

As of 05/26/24 toggle-term.el is part of the MELPA

Just add the following to your init.el if you already have the MELPA added:

(use-package toggle-term
  :bind (("M-o f" . toggle-term-find)
         ("M-o t" . toggle-term-term)
         ("M-o s" . toggle-term-shell)
         ("M-o e" . toggle-term-eshell)
         ("M-o i" . toggle-term-ielm)
         ("M-o o" . toggle-term-toggle))
  :config
    (setq toggle-term-size 25))

Quelpa

(quelpa
 '(toggle-term :fetcher github
               :repo "justinlime/toggle-term.el"))
(setq toggle-term-size 25)
(require 'toggle-term)

Quelpa Use Package

(use-package toggle-term
  :quelpa (toggle-term :fetcher github :repo "justinlime/toggle-term.el")
  :bind (("M-o f" . toggle-term-find)
         ("M-o t" . toggle-term-term)
         ("M-o s" . toggle-term-shell)
         ("M-o e" . toggle-term-eshell)
         ("M-o i" . toggle-term-ielm)
         ("M-o o" . toggle-term-toggle))
  :config
    (setq toggle-term-size 25))

Usage

Functions

Toggle-term provides the following main functions:

toggle-term-find
Switch to an active toggle, or create a new one.
toggle-term-toggle
Toggle the last used toggle.
toggle-term-term
Toggle a term, named toggle-term-term
toggle-term-shell
Toggle a shell, named toggle-term-shell
toggle-term-eshell
Toggle an eshell, named toggle-term-eshell
toggle-term-ielm
Toggle an ielm, named toggle-term-ielm

Variables

toggle-term-size

This can be used to set the size, which is a percentage of the window the toggle will occupy.

This would set the toggle to occupy 25% of the available window:

(setq toggle-term-size 25)

Releases

No releases published

Packages

No packages published

Languages

  • Emacs Lisp 100.0%