Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

getting-started.md

Latest commit

 

History

History
179 lines (136 loc) · 6.14 KB

getting-started.md

File metadata and controls

179 lines (136 loc) · 6.14 KB
Raw

Getting Started with Fabrik

Fabrik provides transparent build caching for your existing build tools. This guide will get you set up in minutes.

Step 1: Install Fabrik

Using Mise:

# Install Mise if you haven't already
curl https://mise.run | sh

# Install Fabrik
mise use -g ubi:tuist/fabrik
Alternative: Install from GitHub Releases

Download the latest release for your platform:

# macOS (ARM)
curl -L https://github.com/tuist/fabrik/releases/latest/download/fabrik-aarch64-apple-darwin.tar.gz | tar xz
sudo mv fabrik /usr/local/bin/

# macOS (Intel)
curl -L https://github.com/tuist/fabrik/releases/latest/download/fabrik-x86_64-apple-darwin.tar.gz | tar xz
sudo mv fabrik /usr/local/bin/

# Linux (x86_64)
curl -L https://github.com/tuist/fabrik/releases/latest/download/fabrik-x86_64-unknown-linux-gnu.tar.gz | tar xz
sudo mv fabrik /usr/local/bin/

Step 2: Set Up Shell Integration

Fabrik uses shell integration to automatically start cache daemons when you navigate into projects.

For Bash:

echo 'eval "$(fabrik activate bash)"' >> ~/.bashrc
source ~/.bashrc

For Zsh:

echo 'eval "$(fabrik activate zsh)"' >> ~/.zshrc
source ~/.zshrc

For Fish:

echo 'fabrik activate fish | source' >> ~/.config/fish/config.fish
source ~/.config/fish/config.fish

Important

After adding shell integration, restart your terminal or run the source command shown above. The activation hook needs to be loaded before Fabrik can manage daemons automatically.

Step 3: Verify Installation

Run the doctor command to verify everything is set up correctly:

fabrik doctor

You should see:

✅ Fabrik binary found
✅ Shell detected
✅ Shell integration configured

Step 4: Initialize Your Project

Navigate to your project and run the interactive initialization:

cd ~/your-project
fabrik init

This will ask you:

  • Cache directory location (default: .fabrik/cache)
  • Maximum cache size (default: 5GB)
  • Whether you have a remote cache server (optional)

The command creates a fabrik.toml configuration file in your project root.

Step 5: Choose Your Build System

Fabrik works with any build system that supports remote caching. Continue with the guide for your build system:

View all build systems →

How It Works

Once set up, Fabrik runs transparently in the background:

cd ~/myproject
# → Daemon starts automatically
# → Environment variables exported
# → Build tools connect to cache

gradle build
# → Faster builds with caching! 🚀

Tip

Each project gets its own isolated daemon with unique ports - no conflicts, no configuration needed. The daemon automatically starts when you cd into a project with fabrik.toml and stops when you leave.

Next Steps

  • Follow your build system's integration guide (links above)
  • See CLI Reference for all available commands
  • Read Architecture for how Fabrik works internally