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.25, 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).
Install one of the AUR packages:
paru -S bitty-bin # prebuilt release binary
paru -S bitty # build from sourceDownload 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 artifact 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.
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.