Skip to content

Latest commit

 

History

History
96 lines (71 loc) · 2.89 KB

README.md

File metadata and controls

96 lines (71 loc) · 2.89 KB
Raw

i3-quickterm

Packaging status

A small drop-down terminal for i3wm and sway

Features

  • use your favourite terminal emulator
  • can select a shell with dmenu / rofi
  • adapt to screen width
  • multi-monitor aware

Installation

Via pip:

pip install i3-quickterm

Or check the the repology badge above to see if it is packaged by your distribution.

Usage

When launched, it will minimize the quickterm on the current screen if there is one. Otherwise, it will either prompt the user for the shell to open or use the one supplied in argument.

If the requested shell is already opened on another screen, it will be moved on the current screen.

It is recommended to map it to an i3 binding:

# with prompt
bindsym $mod+p exec i3-quickterm
# always bring up standard shell, without the menu
bindsym $mod+b exec i3-quickterm shell

Configuration

The configuration is read from ~/.config/i3-quickterm/config.json or ~/.config/i3/i3-quickterm.json.

  • menu: the dmenu-compatible application used to select the shell
  • term: the terminal emulator of choice
  • history: a file to save the last-used shells order, last-used ordering is disabled if set to null
  • ratio: the percentage of the screen height to use
  • pos: where to pop the terminal (top or bottom)
  • shells: registered shells ({ name: command })

term can be either:

  • the name of a terminal from the supported list.
  • auto to select the first existing terminal of the list above (only to provide friendler defaults, not recommended otherwise)
  • a format string, like this one: urxvt -t {title} -e {expanded} with the correct arguments format of your terminal. Some terminals, like xfce4-terminal need the command argument to be passed as a string. In this case, replace {expanded} by {string}

menu, term, history and shell can contain placeholders for environment variables: {$var}.

Unspecified keys are inherited from the defaults:

{
    "menu": "rofi -dmenu -p 'quickterm: ' -no-custom -auto-select",
    "term": "auto",
    "history": "{$HOME}/.cache/i3-quickterm/shells.order",
    "ratio": 0.25,
    "pos": "top",
    "shells": {
        "js": "node",
        "python": "ipython3 --no-banner",
        "shell": "{$SHELL}"
    }
}

Supported terminals

  • alacritty
  • foot
  • gnome-terminal
  • kitty
  • roxterm
  • st
  • terminator
  • termite
  • urxvt
  • urxvtc
  • xfce4-terminal
  • xterm

If you'd like to add another terminal (or correct an error), please open a pull request.

Requirements

  • python >= 3.8
  • i3 >= v3.11 or sway >= 1.2
  • i3ipc-python >= v2.0.1
  • dmenu or rofi (optional)