Skip to content

installation.mdx

Latest commit

 

History

History
106 lines (78 loc) · 3.43 KB

installation.mdx

File metadata and controls

106 lines (78 loc) · 3.43 KB
title Installation
description Install monocle on macOS or Linux.

Requirements

Before installing monocle, make sure you have:

Homebrew (recommended)

The simplest way to install monocle on macOS or Linux:

brew install --cask josephschmitt/tap/monocle
monocle is distributed as a Homebrew **cask**, not a formula — note the `--cask` flag.

Upgrading from a formula install

Earlier releases shipped monocle as a Homebrew formula (brew install josephschmitt/tap/monocle). It's now a cask. If you installed the old formula, uninstall it before installing the cask — otherwise Homebrew reports a conflict between the two:

brew uninstall monocle        # remove the old formula
brew install --cask josephschmitt/tap/monocle
Homebrew **formulae** are intended to build software from source (or install official precompiled "bottles" from homebrew-core). monocle's old formula did neither — it just downloaded the prebuilt release binary and dropped it in `bin`. Homebrew's `brew audit` rules increasingly discourage that pattern for third-party taps, and [GoReleaser deprecated formula generation for prebuilt binaries in v2.10](https://goreleaser.com/deprecations#brews) in favor of **casks**, which are the modern home for any prebuilt artifact you download rather than compile — including CLI tools. Switching keeps monocle's release tooling on a supported path. (Because the release binaries aren't code-signed/notarized, the cask also strips the macOS quarantine attribute on install so Gatekeeper doesn't block the binary.)

Pre-built binaries

Download and install a pre-built binary for your platform from GitHub Releases.

curl -Lo monocle.tar.gz https://github.com/josephschmitt/monocle/releases/latest/download/monocle_darwin_arm64.tar.gz
tar xzf monocle.tar.gz
sudo mv monocle /usr/local/bin/
curl -Lo monocle.tar.gz https://github.com/josephschmitt/monocle/releases/latest/download/monocle_darwin_amd64.tar.gz
tar xzf monocle.tar.gz
sudo mv monocle /usr/local/bin/
curl -Lo monocle.tar.gz https://github.com/josephschmitt/monocle/releases/latest/download/monocle_linux_amd64.tar.gz
tar xzf monocle.tar.gz
sudo mv monocle /usr/local/bin/
curl -Lo monocle.tar.gz https://github.com/josephschmitt/monocle/releases/latest/download/monocle_linux_arm64.tar.gz
tar xzf monocle.tar.gz
sudo mv monocle /usr/local/bin/

Verify the installation

After installing, confirm monocle is available:

monocle --version

Uninstall

To remove monocle and its agent registrations:

monocle unregister all
brew uninstall --cask monocle

If you installed from source, run make uninstall from the repo directory.

Next steps

Once monocle is installed, follow the quick start guide to register it with your agent and begin reviewing code.