tabby/README.md

   

---

Tabby (formerly Terminus) is a highly configurable terminal emulator, SSH and serial client for Windows, macOS and Linux

• Integrated SSH client and connection manager
• Integrated serial terminal
• Theming and color schemes
• Fully configurable shortcuts and multi-chord shortcuts
• Split panes
• Remembers your tabs
• PowerShell (and PS Core), WSL, Git-Bash, Cygwin, Cmder and CMD support
• Direct file transfer from/to SSH sessions via Zmodem
• Full Unicode support including double-width characters
• Doesn't choke on fast-flowing outputs
• Proper shell experience on Windows including tab completion (via Clink)
• Integrated encrypted container for SSH secrets and configuration

---

Contents

• Contents
• What Tabby is and isn't
• Terminal features
• SSH Client
• Serial Terminal
• Portable
• Plugins
• Themes
• Contributing

What Tabby is and isn't

• Tabby is an alternative to Windows' standard terminal (conhost), PowerShell ISE, PuTTY or iTerm

• Tabby is not a new shell or a MinGW or Cygwin replacement. Neither is it lightweight - if RAM usage is of importance, consider Conemu or Alacritty

Terminal features

• A V220 terminal + various extensions
• Multiple nested split panes
• Tabs on any side of the window
• Optional dockable window with a global spawn hotkey ("Quake console")
• Progress detection
• Notification on process completion
• Bracketed paste, multiline paste warnings
• Font ligatures
• Custom shell profiles
• Optional RMB paste and copy-on select (PuTTY style)

SSH Client

• SSH2 client with a connection manager
• X11 and port forwarding
• Automatic jump host management
• Agent forwarding (incl. Pageant and Windows native OpenSSH Agent)
• Login scripts

Serial Terminal

• Saved connections
• Readline input support
• Optional hex byte-by-byte input and hexdump output
• Newline conversion
• Automatic reconnection

Portable

Tabby will run as a portable app on Windows, if you create a data folder in the same location where Tabby.exe lives.

Plugins

Plugins and themes can be installed directly from the Settings view inside Tabby.

• clickable-links - makes paths and URLs in the terminal clickable
• title-control - allows modifying the title of the terminal tabs by providing a prefix, suffix, and/or strings to be removed
• quick-cmds - quickly send commands to one or all terminal tabs
• save-output - record terminal output into a file
• scrollbar - adds a scrollbar to hterm tabs
• sync-config - sync the config to Gist or Gitee

Themes

• hype - a Hyper inspired theme
• relaxed - the Relaxed theme for Tabby
• gruvbox
• windows10
• altair

Contributing

Pull requests and plugins are welcome!

See HACKING.md and API docs for information of how the project is laid out, and a very brief plugin development tutorial.

---

Thanks goes to these wonderful people (emoji key):

Russell Myers 💻	Austin Warren 💻	Felicia Hummel 💻	Mike MacCana ⚠️ 🎨	Yacine Kanzari 💻	BBJip 💻	Futagirl 🎨
Levin Rickert 💻	OJ Kwon 💻	domain 🔌 💻	James Brumond 🔌	Daniel Imms 💻 🔌 ⚠️	Florian Bachmann 💻	Michael Kühnel 💻 🎨
Tilmann Meyer 💻	PM Extra 🐛	Jonathan 💻	Hans Koch 💻	Dak Smyth 💻	Wang Zhi 💻	jack1142 💻
Howie Douglas 💻	Chris Kaczor 💻	Johannes Kadak 💻	LeSeulArtichaut 💻	Cyril Taylor 💻	nstefanou 💻 🔌	orin220444 💻
Gobius Dolhain 💻	Gwilherm Folliot 💻	Dmitry Pronin 💻	Jonathan Beverley 💻	Zenghai Liang 💻	Mateusz Tracz 💻	pinpin 💻
Takuro Onoda 💻	frauhottelmann 💻	Piotr Patalong 🎨	Clark Wang 💻	iamchating 💻	starxg 🔌	Alisue 🎨
Dominic Yin 💻	Brandon Rothweiler 🎨	Logic Machine 📖

This project follows the all-contributors specification. Contributions of any kind welcome!