tabby README

The project's README from github.com/Eugeny/tabby. As one markdown file: README.md.

👋 Managing remote environments? Check out Warpgate, my smart SSH/HTTP/MySQL bastion server, it works great with Tabby, you'll love it.

Downloads:

This README is also available in: :es: Spanish · :ru: Русский · :kr: 한국어 · :cn: 简体中文 · :it: Italiano · :de: Deutsch · :jp: 日本語 · :id: Bahasa Indonesia · :brazil: Português · :poland: Polski

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

Integrated SSH and Telnet 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, MSYS2, 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
SSH, SFTP and Telnet client available as a web app (also self-hosted).

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, macOS Terminal.app and 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 VT220 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.

docker - connect to Docker containers
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
sync-config - sync the config to Gist or Gitee
clippy - an example plugin which annoys you all the time
workspace-manager - allows creating custom workspace profiles based on the given config
search-in-browser - opens default system browser with a text selected from the Tabby's tab
sftp-tab - open sftp tab for ssh connection like SecureCRT
background - change Tabby background image and more...
highlight - Tabby terminal keyword highlight plugin
web-auth-handler - In-app web authentication popups (Built primarily for warpgate in-browser auth)
mcp-server - Powerful Model Context Protocol server integration for Tabby that seamlessly connects with AI assistants through MCP clients like Cursor and Windsurf, enhancing your terminal workflow with intelligent AI capabilities.
ssh-keymap - lets your synced Tabby SSH profiles reference private keys by name instead of by absolute file path. A local mapping file (never synced) translates each name to the real path on that machine * serial-timestamp - adds timestamps to serial terminal sessions

Themes

hype - a Hyper inspired theme
relaxed - the Relaxed theme for Tabby
gruvbox
windows10
altair
catppuccin - Soothing pastel theme for Tabby
noctis - color themes inspired by Noctis VS Code theme

Sponsors

packagecloud has provided free Debian/RPM repository hosting

keygen has provided free release & auto-update hosting

IQ Hive is providing financial support for the project development

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} 💻

Searching Database…

75K ·GitHub

这是什么？

Tabby 是一款高度可配置的终端模拟器，同时也是适用于 Windows、macOS 和 Linux 的 SSH 与串口客户端，它以前叫 Terminus。

它是要替代我的 shell，还是只替代外面的终端窗口？

它只替代终端应用和窗口，不替代你的 shell：它支持 PowerShell、WSL、Git-Bash、Cygwin、MSYS2、Cmder 和 CMD，但它不是一个新的 shell，也不是 MinGW/Cygwin 的替代品。

使用 SSH 或串口客户端之前，还需要额外安装什么吗？

不需要额外的依赖项；SSH2 客户端、串口终端以及 SFTP/Telnet 支持都已内置，还包括一个用于保存 SSH 机密信息的加密容器。

它像 Alacritty 一样占用内存很少吗？

不是，Tabby 明确不是轻量级的；如果内存占用很重要，README 建议改用 ConEmu 或 Alacritty。

它在 Windows、macOS 和 Linux 上的表现都一样吗？

是的，它被设计为跨平台工具，可在三大桌面操作系统上替代 conhost、PowerShell ISE、PuTTY、Terminal.app 和 iTerm。

不安装桌面应用，我能使用 SSH/SFTP/Telnet 客户端吗？

可以，Tabby 还提供网页应用版本的 SSH、SFTP 和 Telnet 客户端，可以自行托管。

我可以用插件和主题扩展 Tabby 吗？

可以，插件和主题可直接在应用内的设置页面安装；例如有 Docker 连接器、配置同步到 Gist/Gitee、用于 AI 助手集成的 MCP 服务器插件，以及 Catppuccin 和 Gruvbox 等主题。

SSH 客户端支持跳板机和代理转发吗？

支持，它包括自动跳板机管理、X11 和端口转发，以及代理转发，包括 Pageant 和 Windows 原生 OpenSSH Agent。

我能直接在 SSH 会话中传输文件吗？

可以，Tabby 支持通过 Zmodem 以及 SFTP 在 SSH 会话中直接收发文件。

除了基本连接，串口终端还能做什么？

它支持保存连接、readline 输入、可选的逐字节十六进制输入和 hexdump 输出、换行符转换以及自动重连。

What are similar projects?

edex-ui, WindTerm, hyper, shell-rs, electerm, pear-desktop, AceShell, upterm

Which topics is it in?

serial, ssh-client, terminal-emulators, sftp, theme, electron, customization, plugin, desktop, web-app, desktop-app, terminal

Creator: Eugeny
Size: 97.6 MB
Stars: 75K
Updated: CommitOct 06 Releasev1.0.238Oct 07
Age: 9y
Commits · 90 Days