zellij

(β˜… 35,030)

A terminal workspace with batteries included

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .rustfmt.toml
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • docker-compose.yml
  • funding.json
  • GOVERNANCE.md
  • LICENSE.md
  • README.md
  • rust-toolchain.toml

# Installation Guide

1. Get the code
git clone https://github.com/zellij-org/zellij

Downloads the entire project code from GitHub to your computer.

cd zellij

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
cargo install --locked zellij

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

bash <(curl -L https://zellij.dev/launch)

An install script that downloads and runs in a single step.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install --locked zellij

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation