Raibid Labs Documentation

INSTALL_QUICK_START

2 min read

Scarab Terminal - Installation Quick Start

curl -sSf https://raw.githubusercontent.com/raibid-labs/scarab/main/scripts/install.sh | bash

Or download and inspect first:

curl -sSf https://raw.githubusercontent.com/raibid-labs/scarab/main/scripts/install.sh -o install.sh
bash install.sh

Platform-Specific Installation

macOS

Homebrew (Coming Soon):

brew tap raibid-labs/scarab
brew install scarab

Manual:

# Download latest release
VERSION="v0.1.0-alpha.7"
curl -LO "https://github.com/raibid-labs/scarab/releases/download/$VERSION/scarab-$VERSION-$(uname -m)-apple-darwin.tar.gz"
 
# Extract and install
tar -xzf scarab-*.tar.gz
sudo mv scarab-* /usr/local/bin/

Linux

Ubuntu/Debian:

# Coming soon: .deb packages
wget https://github.com/raibid-labs/scarab/releases/latest/download/scarab_amd64.deb
sudo dpkg -i scarab_amd64.deb

Arch Linux (AUR):

# Coming soon
yay -S scarab-terminal-bin

Universal (Any Linux):

curl -sSf https://raw.githubusercontent.com/raibid-labs/scarab/main/scripts/install.sh | bash

From Source

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 
# Clone and build
git clone https://github.com/raibid-labs/scarab
cd scarab
cargo build --release
 
# Install
sudo cp target/release/scarab-* /usr/local/bin/

Quick Start

  1. Start the daemon:

    scarab-daemon &

  2. Launch terminal:

    scarab

  3. Configuration (optional):

    # macOS/Linux
vi ~/.config/scarab/config.toml

What Gets Installed

  • scarab-daemon - Background server (handles PTY, plugins)
  • scarab-client - GUI client (Bevy-based renderer)
  • scarab - Symlink to client for convenience
  • scarab-plugin-compiler - Compile Fusabi plugins (.fsx → .fzb)

System Requirements

  • macOS: 10.15+ (Catalina or newer)
  • Linux: Any modern distribution with X11 or Wayland
  • GPU: Any GPU with Vulkan/Metal support
  • RAM: 256MB minimum

Uninstall

Installer-based:

rm -rf ~/.local/bin/scarab*
rm -rf ~/.config/scarab

Homebrew:

brew uninstall scarab

Troubleshooting

”Command not found”

Add install directory to PATH:

export PATH="$HOME/.local/bin:$PATH"

Permission denied

chmod +x ~/.local/bin/scarab*

GPU issues

Use software renderer:

SCARAB_RENDERER=software scarab

Next Steps

Version: v0.1.0-alpha.7 Last Updated: 2025-11-24

Graph View