Skip to main content

Installing Zith

Getting started with Zith is quick and easy. Choose your platform below:

Windows​

# Using PowerShell (admin privileges may be required)
iwr -useb https://zith-lang.org/install.ps1 | iex

Or download the installer from GitHub Releases.

macOS​

# Using Homebrew
brew install zith

# Or using the install script
curl -fsSL https://zith-lang.org/install.sh | bash

Linux​

# Using the install script
curl -fsSL https://zith-lang.org/install.sh | bash

# Or download from releases
wget https://github.com/galaxyhaze/Zith/releases/latest/download/zith-linux-x86_64.tar.gz
tar -xzf zith-linux-x86_64.tar.gz
sudo mv zith /usr/local/bin/

Verify Installation​

After installation, verify Zith is working:

zith --version

You should see output like:

Zith 0.1.0

Manual Installation​

From Source​

If you prefer to build from source:

git clone https://github.com/galaxyhaze/Zith.git
cd Zith
mkdir build && cd build
cmake ..
cmake --build . --config Release
sudo cmake --install .

Requirements:

  • CMake 3.20+
  • C++20 compatible compiler (GCC 11+, Clang 14+, MSVC 2022+)

Configuration​

Environment Variables​

Zith uses these optional environment variables:

  • ZITH_HOME - Override installation directory
  • ZITH_EDITOR - Default editor for zith edit
  • ZITH_CACHE_DIR - Cache directory location

Shell Completion​

Add shell completions for better CLI experience:

# Bash
echo 'source <(zith completion bash)' >> ~/.bashrc

# Zsh
echo 'source <(zith completion zsh)' >> ~/.zshrc

# Fish
zith completion fish > ~/.config/fish/completions/zith.fish

Next Steps​

Now that Zith is installed:

  1. Quick Start - Write your first Zith program

  2. CLI Reference - Learn available commands

  3. Language Guide - Dive into syntax

Having trouble? Check our FAQ or open an issue on GitHub.