https://github.com/Homebrew/formulae.brew.sh

🏎 An online formulae browser for Homebrew
https://github.com/Homebrew/formulae.brew.sh

formulae github-pages homebrew jekyll

Last synced: about 1 month ago
JSON representation

🏎 An online formulae browser for Homebrew

• Host: GitHub
• URL: https://github.com/Homebrew/formulae.brew.sh
• Owner: Homebrew
• License: bsd-2-clause
• Created: 2018-04-17T11:06:18.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T07:00:30.000Z (5 months ago)
• Last Synced: 2024-04-14T00:21:43.372Z (5 months ago)
• Topics: formulae, github-pages, homebrew, jekyll
• Language: HTML
• Homepage: https://formulae.brew.sh
• Size: 3.58 MB
• Stars: 1,361
• Watchers: 51
• Forks: 494
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Homebrew Formulae

[Homebrew Formulae](https://formulae.brew.sh) is an online package browser for [Homebrew](https://brew.sh).

It displays all packages in the [Homebrew/homebrew-core](https://github.com/Homebrew/homebrew-core) and [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask). A [GitHub Action](https://github.com/Homebrew/formulae.brew.sh/blob/master/.github/workflows/scheduled.yml) is run periodically which pulls changes from each tap and deploys the site to GitHub Pages.

## JSON API

It also provides a JSON API for all packages (or individual packages) in each tap and their related analytics. This JSON data is used for the creation of the HTML resources on this site.

Currently available:

- List metadata for all formulae and casks

- Get metadata for each formula and cask

- List analytics events for all formulae and casks

- List analytics events for each formula and cask

Read more in the [JSON API documentation](https://formulae.brew.sh/docs/api/).

## Usage

Open  in your web browser.

To instead run the site locally, run:

```bash

git clone https://github.com/Homebrew/formulae.brew.sh

cd formulae.brew.sh

rake generate

bundle install

bundle exec jekyll serve

```

## Search

Search is indexed by Algolia crawler at https://crawler.algolia.com/admin/crawlers/26b9e6e2-bce4-4f42-9930-6b6ddf06cc9e/overview.

This is only accessible by brew organisation members.

## License

Code is under the [BSD 2-clause "Simplified" License](LICENSE.txt).