﻿---
title: Installation
description: Install reel with Homebrew, or build it from source.
url: https://docs-v3-preview.elastic.dev/reel/getting-started/installation
---

# Installation
reel is a command-line tool for macOS 15 or later on Apple silicon.
```sh
brew install --cask mpdreamz/tap/reel
reel doctor
```

The cask installs `Reel Companion.app` beside it, a menu bar app that shows what a run is doing (see
[the companion app](https://docs-v3-preview.elastic.dev/reel/getting-started/companion)). `brew upgrade` updates both. Releases are signed with a Developer ID and notarized by Apple, so the binary runs without
a warning. The [releases](https://github.com/Mpdreamz/reel/releases) page has `reel-arm64.zip` and its checksum for
scripts.
Nothing else is needed: reel records with ScreenCaptureKit, encodes with AVFoundation and narrates with macOS's own
voices. Two things are optional:
- **[voicebox](https://github.com/jamiepine/voicebox)**, a local voice server, for narration in a cloned voice.
- **A Chromium-based browser** (Chrome, Chromium, Brave or Edge), for web reels that ask for it with
  `Set Browser chromium`. WebKit is built in and the default.


## From source

You need [mise](https://mise.jdx.dev) and the macOS SDK, from Xcode or the Command Line Tools
(`xcode-select --install`). mise installs the rest, Swift 6.4.1 from swift.org among it: the Swift in the Command
Line Tools cannot build the tests.
```sh
git clone https://github.com/Mpdreamz/reel.git
cd reel
mise run install   
```