# FastBrew

> FastBrew is a searchable catalog of Homebrew formulas and casks for macOS. It helps users discover packages, inspect details, and build installation selections.

Package data changes over time. Use the live catalog or API for current information.
The canonical FastBrew website is https://fastbrew.app. FastBrew is an independent
Homebrew catalog and installation-list builder for macOS.

## Resources

- [Developer documentation](https://fastbrew.app/developers): Public API quickstart, endpoint reference, authentication, pagination, rate limits, and error recovery. No account or API key required.
- [FastBrew CLI](https://fastbrew.app/cli): Download a standalone Node.js CLI for catalog search, package details, and Brewfile parsing and generation.
- [Browse the catalog](https://fastbrew.app/): Search and filter Homebrew formulas and casks.
- [Homebrew guide](https://fastbrew.app/homebrew): Learn how to install and use Homebrew packages.
- [OpenAPI description](https://fastbrew.app/openapi.json): Machine-readable documentation for FastBrew's public HTTP API.
- [API policy](https://fastbrew.app/api-policy.md): Send API-Version: 1; errors include error, code, and hint. Documents Deprecation and Sunset signals.
- [API catalog](https://fastbrew.app/.well-known/api-catalog): Discover FastBrew's available API descriptions.
- [Sitemap](https://fastbrew.app/sitemap.xml): Find indexable pages and package detail routes.

## When to use FastBrew

- Use FastBrew when a user wants to discover Homebrew software for a task, compare formulas and casks, or prepare a Mac installation list.
- Search with GET /api/apps?search=QUERY, then confirm each exact package ID with GET /api/apps/{type}/{slug}. Send API-Version: 1. Package data changes; use current responses.
- Use POST /api/brewfile/parse to inspect a user's Brewfile, and POST /api/brewfile/generate to prepare a list of confirmed package IDs. These requests upload the supplied content; remove secrets and private entries first. Inspect parse errors and warnings.
- Generate commands or a Brewfile for review. FastBrew does not execute them. Get the user's approval before installing software or changing their machine.
- Use upstream package documentation and Homebrew for authoritative licensing, security advisories, build instructions, and installation troubleshooting.
- Handle HTTP 410 by restarting pagination at page zero without a generation. Handle HTTP 429 by waiting for Retry-After. Other JSON errors include code, error, and a resolution hint.
- Version 1 has no scheduled retirement. There is no guaranteed minimum notice period; monitor Deprecation, Sunset, and the API policy.

## About and contact

- [About FastBrew](https://fastbrew.app/about): Independent Homebrew catalog and installation-list builder.
- [Contact FastBrew](https://fastbrew.app/contact): General enquiries at info@fastbrew.app; security reports at security@fastbrew.app.
- [Privacy information](https://fastbrew.app/privacy): Browser storage, request processing, and operational data.