Skip to content

README.en.md

Latest commit

 

History

History
83 lines (57 loc) · 3.01 KB

README.en.md

File metadata and controls

83 lines (57 loc) · 3.01 KB
Raw

Terry

中文

Terry is a terminal-first desktop workspace with a built-in AI agent.
It is built on Zed’s GPUI stack, but focused on terminals, files, and agent workflows — not as a full IDE.

Features

  • Terminal workspace — Group and manage multiple terminals; open new sessions with the right working directory; groups support automatic tiled layouts (manual / tall / grid / stack, like kitty)
  • Terminal images — kitty graphics protocol and sixel support for rendering images directly in the terminal, with animated GIFs (chafa / viu / icat work)
  • Terminal protocols — kitty keyboard protocol (CSI u) and OSC 52 clipboard read/write
  • Link jump — Ctrl+Shift+E lists all currently visible links (URL / path / OSC 8); pick one with the keyboard to open it
  • AI Agent — Chat with LLMs in a side panel; run commands and tools with configurable profiles
  • MCP — Connect Model Context Protocol servers to extend agent capabilities
  • Files panel — Browse the project tree alongside your terminals
  • Settings & themes — Customize shell, appearance, agent models, and more
  • i18n — UI strings available in multiple locales (including English and Chinese)

Platforms

Platform Status
macOS (Apple Silicon / Intel) Supported
Linux (x86_64) Supported
Windows (x86_64) Supported

Release packages are built via GitHub Actions (.github/workflows/release.yml).

Getting started

Prerequisites

  • Rust 1.95.0 (see rust-toolchain.toml)
  • Platform build deps (same family as Zed): CMake, a C/C++ toolchain, and on Linux the usual X11/Wayland/fontconfig libraries

Build & run

cargo run --release

Config and data live under the app name Terry (for example ~/.config/terry/ on Linux, ~/Library/Application Support/Terry on macOS).

Package locally

# macOS
script/package-macos.sh

# Linux
script/package-linux.sh

# Windows (PowerShell)
.\script\package-windows.ps1

Artifacts are written under target/release/.

Project layout

src/                 # App entry, terminal/file panels, menus
crates/              # Shared libraries (GPUI, terminal, agent, settings, …)
agent_ui / crates/agent_ui
assets/              # Icons, default settings, themes
script/              # Packaging scripts
resources/           # App icons and desktop metadata

Relationship to Zed

Terry reuses substantial code from the Zed editor (GPUI, workspace, terminal, agent infrastructure).
The product goal is different: a lightweight terminal + agent workspace, not a general-purpose code editor.

License

  • Application package: GPL-3.0-or-later (see LICENSE-GPL)
  • Many crates retain their upstream licenses (including Apache-2.0; see LICENSE-APACHE and per-crate metadata)

Contributing

Issues and pull requests are welcome. Please keep changes focused; match existing code style, and test on the platform you touch.