# eugeny/tabby architecture

> Architecture diagram of the GitHub repository eugeny/tabby, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/eugeny/tabby
- Repository: https://github.com/eugeny/tabby

## Overview

Tabby is a cross-platform terminal emulator and connection client. The principal workflow is to open a tab, establish a local shell or remote connection, and interact with its terminal; core services also manage tabs and recovery. The README documents SSH/SFTP, Telnet, serial, splits, themes, plugins, encrypted configuration, and web use, so those product branches are represented. Some links rely on README descriptions because their implementation wiring was not sampled; those are dashed and unverified.

Main entry points: [`tabby-terminal/src/session.ts`](https://github.com/eugeny/tabby/blob/master/tabby-terminal/src/session.ts) (Terminal Engine), [`tabby-core/src/services/app.service.ts`](https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/app.service.ts) (Tab Manager), [`tabby-ssh/src/services/ssh.service.ts`](https://github.com/eugeny/tabby/blob/master/tabby-ssh/src/services/ssh.service.ts) (SSH Client), [`tabby-local/src/services/terminal.service.ts`](https://github.com/eugeny/tabby/blob/master/tabby-local/src/services/terminal.service.ts) (Local Shell)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_core["Application Core"]
  node_app["Tab Manager<br/>[app.service.ts]"]
  node_tabs["Tab Views"]
  node_config["Configuration<br/>[config.service.ts]"]
  node_recovery["Tab Recovery"]
  node_web["Web Platform<br/>[index.ts]"]
  node_electron["Desktop Platform"]
end

subgraph group_terminal["Terminal Sessions"]
  node_terminal["Terminal Engine<br/>[session.ts]"]
  node_frontend["XTerm Frontend<br/>[xtermFrontend.ts]"]
  node_splits["Split Panes"]
end

subgraph group_connections["Connection Types"]
  node_local["Local Shell"]
  node_ssh["SSH Client<br/>[ssh.service.ts]"]
  node_sftp["SFTP Transfer<br/>[sftp.ts]"]
  node_telnet["Telnet Client<br/>[session.ts]"]
  node_serial["Serial Client<br/>[serial.service.ts]"]
end

subgraph group_extensions["Settings and Extensions"]
  node_settings["Settings UI<br/>[index.ts]"]
  node_vault[("Encrypted Vault<br/>[vault.service.ts]")]
  node_plugins["Plugin Manager"]
  node_plugininstall["Plugin Installer<br/>[pluginManager.ts]"]
end

node_user(("User"))

node_user -.->|"opens tabs"| node_app
node_app -->|"manages tabs"| node_tabs
node_app -->|"uses config"| node_config
node_app -->|"uses recovery"| node_recovery
node_user -.->|"starts shell"| node_local
node_user -.->|"connects SSH"| node_ssh
node_user -.->|"connects Telnet"| node_telnet
node_user -.->|"starts serial"| node_serial
node_user -.->|"splits panes"| node_splits
node_local -.->|"starts session"| node_terminal
node_ssh -.->|"provides terminal"| node_terminal
node_ssh -.->|"transfers files"| node_sftp
node_telnet -.->|"provides terminal"| node_terminal
node_serial -.->|"provides terminal"| node_terminal
node_terminal -.->|"renders output"| node_frontend
node_user -.->|"configures app"| node_settings
node_settings -.->|"manages secrets"| node_vault
node_user -.->|"installs plugins"| node_plugins
node_plugins -.->|"requests install"| node_plugininstall
node_user -.->|"uses web app"| node_web
node_user -.->|"uses desktop app"| node_electron

click node_app "https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/app.service.ts"
click node_tabs "https://github.com/eugeny/tabby/blob/master/tabby-core/src/components/baseTab.component.ts"
click node_config "https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/config.service.ts"
click node_recovery "https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/tabRecovery.service.ts"
click node_terminal "https://github.com/eugeny/tabby/blob/master/tabby-terminal/src/session.ts"
click node_frontend "https://github.com/eugeny/tabby/blob/master/tabby-terminal/src/frontends/xtermFrontend.ts"
click node_splits "https://github.com/eugeny/tabby/blob/master/tabby-core/src/components/splitTab.component.ts"
click node_local "https://github.com/eugeny/tabby/blob/master/tabby-local/src/services/terminal.service.ts"
click node_ssh "https://github.com/eugeny/tabby/blob/master/tabby-ssh/src/services/ssh.service.ts"
click node_sftp "https://github.com/eugeny/tabby/blob/master/tabby-ssh/src/session/sftp.ts"
click node_telnet "https://github.com/eugeny/tabby/blob/master/tabby-telnet/src/session.ts"
click node_serial "https://github.com/eugeny/tabby/blob/master/tabby-serial/src/services/serial.service.ts"
click node_settings "https://github.com/eugeny/tabby/blob/master/tabby-settings/src/index.ts"
click node_vault "https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/vault.service.ts"
click node_plugins "https://github.com/eugeny/tabby/blob/master/tabby-plugin-manager/src/services/pluginManager.service.ts"
click node_plugininstall "https://github.com/eugeny/tabby/blob/master/app/lib/pluginManager.ts"
click node_web "https://github.com/eugeny/tabby/blob/master/tabby-web/src/index.ts"
click node_electron "https://github.com/eugeny/tabby/blob/master/tabby-electron/src/services/electron.service.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_tabs,node_config,node_recovery,node_web,node_electron,node_user toneBlue
class node_terminal,node_frontend,node_splits toneAmber
class node_local,node_ssh,node_sftp,node_telnet,node_serial toneMint
class node_settings,node_vault,node_plugins,node_plugininstall toneRose
```

## Components

### Application Core

- [Tab Manager](https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/app.service.ts): `tabby-core/src/services/app.service.ts`
- [Tab Views](https://github.com/eugeny/tabby/blob/master/tabby-core/src/components/baseTab.component.ts): `tabby-core/src/components/baseTab.component.ts`
- [Configuration](https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/config.service.ts): `tabby-core/src/services/config.service.ts`
- [Tab Recovery](https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/tabRecovery.service.ts): `tabby-core/src/services/tabRecovery.service.ts`
- [Web Platform](https://github.com/eugeny/tabby/blob/master/tabby-web/src/index.ts): `tabby-web/src/index.ts`
- [Desktop Platform](https://github.com/eugeny/tabby/blob/master/tabby-electron/src/services/electron.service.ts): `tabby-electron/src/services/electron.service.ts`

### Terminal Sessions

- [Terminal Engine](https://github.com/eugeny/tabby/blob/master/tabby-terminal/src/session.ts): `tabby-terminal/src/session.ts`
- [XTerm Frontend](https://github.com/eugeny/tabby/blob/master/tabby-terminal/src/frontends/xtermFrontend.ts): `tabby-terminal/src/frontends/xtermFrontend.ts`
- [Split Panes](https://github.com/eugeny/tabby/blob/master/tabby-core/src/components/splitTab.component.ts): `tabby-core/src/components/splitTab.component.ts`

### Connection Types

- [Local Shell](https://github.com/eugeny/tabby/blob/master/tabby-local/src/services/terminal.service.ts): `tabby-local/src/services/terminal.service.ts`
- [SSH Client](https://github.com/eugeny/tabby/blob/master/tabby-ssh/src/services/ssh.service.ts): `tabby-ssh/src/services/ssh.service.ts`
- [SFTP Transfer](https://github.com/eugeny/tabby/blob/master/tabby-ssh/src/session/sftp.ts): `tabby-ssh/src/session/sftp.ts`
- [Telnet Client](https://github.com/eugeny/tabby/blob/master/tabby-telnet/src/session.ts): `tabby-telnet/src/session.ts`
- [Serial Client](https://github.com/eugeny/tabby/blob/master/tabby-serial/src/services/serial.service.ts): `tabby-serial/src/services/serial.service.ts`

### Settings and Extensions

- [Settings UI](https://github.com/eugeny/tabby/blob/master/tabby-settings/src/index.ts): `tabby-settings/src/index.ts`
- [Encrypted Vault](https://github.com/eugeny/tabby/blob/master/tabby-core/src/services/vault.service.ts): `tabby-core/src/services/vault.service.ts`
- [Plugin Manager](https://github.com/eugeny/tabby/blob/master/tabby-plugin-manager/src/services/pluginManager.service.ts): `tabby-plugin-manager/src/services/pluginManager.service.ts`
- [Plugin Installer](https://github.com/eugeny/tabby/blob/master/app/lib/pluginManager.ts): `app/lib/pluginManager.ts`

### Other components

- **User**

## Connections

- User → Tab Manager: opens tabs (evidence: `README.md`)
- Tab Manager → Tab Views: manages tabs (evidence: `tabby-core/src/services/app.service.ts`)
- Tab Manager → Configuration: uses config (evidence: `tabby-core/src/services/app.service.ts`)
- Tab Manager → Tab Recovery: uses recovery (evidence: `tabby-core/src/services/app.service.ts`)
- User → Local Shell: starts shell (evidence: `README.md`)
- User → SSH Client: connects SSH (evidence: `README.md`)
- User → Telnet Client: connects Telnet (evidence: `README.md`)
- User → Serial Client: starts serial (evidence: `README.md`)
- User → Split Panes: splits panes (evidence: `README.md`)
- Local Shell → Terminal Engine: starts session
- SSH Client → Terminal Engine: provides terminal (evidence: `README.md`)
- SSH Client → SFTP Transfer: transfers files (evidence: `README.md`)
- Telnet Client → Terminal Engine: provides terminal (evidence: `README.md`)
- Serial Client → Terminal Engine: provides terminal (evidence: `README.md`)
- Terminal Engine → XTerm Frontend: renders output
- User → Settings UI: configures app (evidence: `README.md`)
- Settings UI → Encrypted Vault: manages secrets (evidence: `README.md`)
- User → Plugin Manager: installs plugins (evidence: `README.md`)
- Plugin Manager → Plugin Installer: requests install
- User → Web Platform: uses web app (evidence: `README.md`)
- User → Desktop Platform: uses desktop app (evidence: `README.md`)
