Skip to content
Download

Building from source ​

What it needs ​

  • Rust 1.98.1. The repository's rust-toolchain.toml selects it.
  • Zig 0.16.x on PATH, to build the terminal engine.
  • On Linux, what the window toolkit (gpui) needs: Wayland or X11 development files, and Vulkan.
  • A Nerd Font. The UI's icons are Nerd Font glyphs, and the default font is JetBrainsMono Nerd Font. If your font has no Nerd Font glyphs, the icons are missing or show as boxes. There's no bundled symbols font to fall back on.

On macOS, you need macOS 13.0 or later. To build it, you need the full Xcode application, not only the Command Line Tools.

Building ​

sh
cargo build --release

This produces target/release/insensical, the application, and target/release/isc, the daemon and command line.

  • The first build downloads the Ghostty source. To use a local checkout instead, set GHOSTTY_SOURCE_DIR.
  • The terminal engine is very slow when it's built without optimisation, so .cargo/config.toml builds it optimised even in development builds. Don't remove that.
  • just lists the tasks: build, release, run, isc …, test, lint, check, bench, banner, icons, install, install-local, install-mac.
  • cargo test --workspace, or just test, runs the tests. The window tests draw off-screen and write screenshots to target/screenshots/. No test puts anything on your desktop or reads your own settings or layout. The window tests can hang at the very end of a test, about one run in twelve. This is a fault in off-screen testing; the real application doesn't have it. just test runs under a time limit. If it hangs, run it again.