gnachman / iTerm2

iTerm2 macOS Terminal Replacement **Website** • **Downloads** • **Documentation** • **Features** --- About iTerm2 is a powerful terminal emulator for macOS that brings the terminal into the modern age with features you never knew you always wanted. Key Features • **tmux Integration** - Native iTerm2 windows/tabs replace tmux's text-based interface. Run tmux -CC and tmux windows become real macOS windows. Sessions persist through crashes, SSH disconnects, and even app upgrades. Collaborate by having two people attach to the same session. • **Shell Integration** - Deep shell awareness that tracks commands, directories, hostnames, and usernames. Enables click-to-download files via SCP, drag-and-drop uploads, command history per host, recent directories by "frecency," and marks at each prompt. • **AI Chat** - Built-in LLM chat window that can optionally interact with terminal contents. Link sessions to get context-aware help, run commands on your behalf, or explain output with annotations. • **Inline Images** - Display images (including animated GIFs) directly in the terminal. Use imgcat to view photos, charts, or visual output without leaving your workflow. • **Automatic Profile Switching** - Terminal appearance changes automatically based on hostname, username, directory, or running command. SSH to production? Background turns red. Different environments get different visual contexts. • **Dedicated Hotkey Windows** - System-wide hotkey summons a terminal that slides down from the top of the screen (or any edge), even over fullscreen apps. Pin it or let it auto-hide. • **Session Restoration** - Sessions run in long-lived server processes. If iTerm2 crashes or upgrades, your shells keep running. When iTerm2 restarts, it reconnects to your sessions exactly where you left off. • **Built-in Web Browser** - Browser profiles integrate web browsing into iTerm2's window/tab/pane hierarchy. Copy mode, triggers, AI chat, and other terminal features work in browser sessions. • **Configurable Status Bar** - Per-session status bar showing git branch, CPU/memory graphs, current directory, hostname, custom interpolated strings, or Python API components. • **Triggers** - Regex patterns that fire actions when matched: highlight text, run commands, send notifications, open password manager, set marks, or invoke Python scripts. • **Smart Selection** - Quad-click selects semantic objects (URLs, file paths, email addresses, quoted strings). Right-click for context actions. Cmd-click to open. • **Copy Mode** - Vim-like keyboard selection. Navigate and select text without touching the mouse. Works with marks to jump between command prompts. • **Instant Replay** - Scrub backward through terminal history to see exactly what was on screen at any moment, with timestamps. Perfect for catching fleeting errors. • **Python Scripting API** - Full automation and customization via Python. Create custom status bar components, triggers, menu items, or entirely new features. • **Open Quickly** - Cmd-Shift-O opens a search across all sessions by tab title, command, hostname, directory, or badge. Navigate large session collections instantly. --- Installation Download Get the latest version from iterm2.com/downloads For the bleeding edge without building, try the nightly build. Build from Source > **Note:** Development builds may be less stable than official releases. Prerequisites • The most recent version of Xcode (with Command Line Tools). You can minimize suffering by using the same Xcode that is in the file . • Homebrew • Rustup Clone Setup (first time) This installs Homebrew dependencies (cmake, pkg-config, python3, etc.), SF Symbols, Rust cross-compilation support, downloads the Metal Toolchain, initializes submodules, and compiles third-party libraries (OpenSSL, libsixel, libgit2, Sparkle, etc.) inside a sandbox. Re-run whenever your active Xcode version changes — the file tracks which version was last used. Build Run Architecture Builds target your native architecture by default. To produce a universal (arm64 + x86_64) binary: Code signing Code signing is disabled by default to keep contributor builds simple. To enable it with the project's signing identity: Building in Xcode If you prefer building from Xcode instead of the command line: • Complete the **Clone** and **Setup** steps above. • Configure code signing with your team ID: This script updates in all Xcode project files (iTerm2 and its dependencies like Sparkle, SwiftyMarkdown, etc.) so code signing works with your identity. **To find your team ID:** Open Keychain Access, find your "Apple Development" or "Developer ID" certificate, and look for the 10-character string in parentheses (e.g., "H7V7XYVQ7D"). **No Developer account?** Skip this step and select "Sign to Run Locally" in Xcode's Signing & Capabilities tab. • Open in Xcode. • Edit Scheme (Cmd- **Note:** We use GitLab for issues because it provides better support for attachments. --- Resources | Resource | Link | | ---------------- | ----------------------------------------------------------------- | | Official Website | iterm2.com | | Documentation | iterm2.com/documentation | | Community | iTerm2 Discussions | | Downloads | iterm2.com/downloads | --- License iTerm2 is distributed under the GPLv3 license. --- Support If you love iTerm2, consider: • Starring this repository • Spreading the word • Sponsoring development --- **Made by George Nachman and contributors**