brew

Install tools using Homebrew package manager on macOS and Linux.

Shims are not supported for Homebrew-installed tools. The .bin() method should not be used with this installer. Homebrew manages binary placement and PATH integration natively.

Basic Usage

import { defineTool } from "@alexgorbatchev/dotfiles";

export default defineTool((install) => install("brew", { formula: "ripgrep" }));

Parameters

Parameter	Description
formula	Formula or cask name (defaults to tool name)
cask	Set true for cask installation
tap	Tap(s) to add before installing (brew tap <target>)
trust	Tap(s) or formula(s) to explicitly trust before tapping/installing (brew trust <target>)
args	Additional CLI flags passed directly to brew install (e.g. ['--HEAD'], ['--build-from-source'])
service	Automatically start background daemon after install (true, 'start', or 'run')
link	Force symlinking keg-only or conflicting formulas (true or { force?: boolean, overwrite?: boolean })
versionArgs	Arguments for version check (e.g., ['--version'])
versionRegex	Regex to extract version from output (string or RegExp)
env	Environment variables (static or dynamic function)

Examples

Homebrew Cask

install("brew", {
  formula: "visual-studio-code",
  cask: true,
});

With Tap Trust & Custom Tap

install("brew", {
  formula: "deepgram-cli",
  trust: "deepgram/tap",
  tap: "deepgram/tap",
});

Background Service & Keg-Only Linking

install("brew", {
  formula: "redis",
  service: "start",
  link: { overwrite: true },
});

Build Flags

install("brew", {
  formula: "custom-tool",
  args: ["--build-from-source"],
});

Platform Support

Platform	Support
macOS	Full (formulas + casks)
Linux	Formulas only
Windows	Not supported