actions
/
setup-cpp
Template
mirror of https://github.com/aminya/setup-cpp
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
setup-cpp/packages/setup-brew
History
Amin Yahyaabadi 2032957802
docs: add examples for setup-apt functions 		2024-08-28 14:12:56 -07:00
..
__tests__ feat: introduce setup-brew package 2024-08-23 15:20:37 -07:00
src docs: add examples for setup-apt functions 2024-08-28 14:12:56 -07:00
.eslintrc.json feat: introduce setup-brew package 2024-08-23 15:20:37 -07:00
README.md docs: add examples for setup-apt functions 2024-08-28 14:12:56 -07:00
jest.config.mjs fix: add module type to packages + fix running the packages tests 2024-08-26 14:46:06 -07:00
package.json feat!: support addAptKey options through installAptPack 2024-08-28 13:55:40 -07:00
tsconfig.json feat: introduce setup-brew package 2024-08-23 15:20:37 -07:00

README.md

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 where brew is installed

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

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.