setup-cpp/packages/setup-brew/README.md

1.6 KiB

setup-brew

Version License: Apache--2.0

Setup brew and brew packages

Install

npm install --save setup-brew

Usage

InstallationInfo (type)

The information about an installation result

SetupBrewOptions (type)

setupBrew (function)

Parameters:

  • options (SetupBrewOptions)

returns: Promise

getBrewBinDir (function)

Get the path to the bin directory of brew

returns: string

getBrewDir (function)

Get the path where brew is installed

returns: "/opt/homebrew" | "/usr/local" | "/home/linuxbrew/.linuxbrew"

BrewPackOptions (type)

installBrewPack (function)

A function that installs a package using brew

Parameters:

  • name (string) - The name of the package
  • version (string) - The version of the package (optional)
  • options - The options for installing the package
  • givenOptions (BrewPackOptions)

returns: Promise

🤝 Contributing

You can sponsor my work here:

https://github.com/sponsors/aminya

Pull requests, issues and feature requests are welcome. See the Contributing guide.