Bitty is a Rust terminal workspace: a GPU-rendered terminal emulator and
multi-pane window manager for shell sessions. It is pre-1.0 and pre-alpha; the
current release line is v0.0.28, there is no stable public API, and behavior,
configuration keys, and package names may change between releases.
The product site is bitty.run. Release artifacts and
release notes are published on
GitHub Releases and on the
R2-backed CDN at https://cdn.bitty.run/releases/<tag>/ (the preferred
download source).
Every supported install channel verifies downloads before installing and fails
closed on mismatch. Detailed instructions, repository keys, and troubleshooting
are documented in packaging/INSTALL.md.
Linux and macOS:
curl -fsSL https://cdn.bitty.run/install/install.sh | bashWindows (PowerShell):
irm https://cdn.bitty.run/install/install.ps1 | iex-
Arch Linux (AUR):
paru -S bitty-bin # prebuilt release binary (recommended) paru -S bitty # build from source
-
Debian / Ubuntu (APT):
curl -fsSL https://cdn.bitty.run/apt/setup.sh | sudo bash sudo apt install -y bitty(See
packaging/debian.md) -
Fedora / EPEL (Copr):
sudo dnf copr enable -y xuepoo/bitty-terminal sudo dnf install -y bitty(See
packaging/fedora.md) -
Nix / NixOS:
nix run github:bitty-terminal/bitty
(Binary cache on
bitty.cachix.org, seepackaging/nix.md) -
AppImage (Universal Portable Linux): Download
bitty-<target>.AppImage,chmod +x, and run. (Seepackaging/appimage.md) -
openSUSE (Zypper / OBS): (See
packaging/opensuse.md) -
Alpine Linux: (Native musl
APKBUILDtemplate inpackaging/alpine.md) -
Gentoo Linux: (Portage overlay ebuilds in
packaging/gentoo.md) -
Void Linux: (xbps-src template in
packaging/void.md) -
Solus Linux: (ypkg recipe in
packaging/solus.md)
-
Homebrew:
brew install bitty-terminal/tap/bitty
-
Apple Disk Image (DMG): Download
Bitty-<version>-universal.dmgfrom GitHub Releases or the CDN.
-
Windows Package Manager (winget):
winget install BittyTerminal.Bitty # or using the moniker winget install bitty(See
packaging/winget.md) -
Scoop:
scoop bucket add bitty https://github.com/bitty-terminal/scoop-bucket scoop install bitty
-
Setup wizard (Inno Setup): Download
bitty-<version>-windows-x86_64-setup.exefrom GitHub Releases or the CDN. (Seepackaging/WINDOWS-SMARTSCREEN.md)
-
FreeBSD Ports: Ports recipe in
packaging/freebsd/x11/bitty/. (Seepackaging/freebsd.md) -
OpenBSD Ports: Ports recipe in
packaging/openbsd/x11/bitty/. (Seepackaging/openbsd.md) -
NetBSD pkgsrc: pkgsrc recipe in
packaging/netbsd/x11/bitty/. (Seepackaging/netbsd.md)
Download a platform package or archive from the R2-backed CDN at
https://cdn.bitty.run/releases/<tag>/ (preferred) or
GitHub Releases (the same
bytes, documented fallback). Supported release artifacts include Linux, macOS,
and Windows binaries, plus selected Linux packages. Every bare binary and archive
has a .sha256 sidecar, and the install scripts and package-manager channels
verify it. Packaging details are in packaging/README.md.
The repository pins the Rust toolchain in rust-toolchain.toml; Rustup installs
it when needed. Linux source builds also need fontconfig and freetype
development packages.
git clone --recurse-submodules https://github.com/bitty-terminal/bitty.git
cd bitty
cargo build --release --locked -p bitty-terminal
./target/release/bittyThe binary crate is bitty-terminal and is not published on crates.io. A git
source install is also available:
cargo +1.98.1 install --git https://github.com/bitty-terminal/bitty.git bitty-terminal --lockedRun the setup wizard once, then launch Bitty:
bitty init
bittyUse bitty init --yes for default answers, --force to replace an existing
configuration, and bitty --help for the current CLI surface. Headless smoke
execution is available with bitty --headless.
Canonical platform documentation is maintained in
bitty-terminal-docs,
whose documentation map is at
docs/README.md.
The checkout mounts that repository at docs/ as a submodule; edit the
canonical docs repository rather than the mount.
Shared governance, decisions, reviews, and security material live in bitty-docs. AI and plugin documentation live in bitty-ai-docs and bitty-plugins-docs.
See CHANGELOG.md for release history and
CONTRIBUTING.md for contribution guidance.
Bitty is shaped by the tools its authors use every day:
- Neovim for a keyboard-first workspace, Lua configuration, and an extension model that keeps the core small.
- Hyprland for tiling window management, workspaces, and the idea that a terminal workspace can be visually deliberate.
- Kitty, WezTerm, Alacritty, and Foot for GPU rendering, terminal protocol coverage, performance discipline, and configuration ergonomics.
Bitty does not share code with these projects; the inspiration is in the product ideas and the standards they helped define.
Prerequisites and the pinned development tools are documented in
CONTRIBUTING.md. Common commands are:
just setup
just check
just testThe workspace contains the terminal core and its supporting crates. External compatibility and performance validation suites are maintained separately.
Released under the MIT OR Apache-2.0 license. See LICENSE.