BrewUI README

The project's README from github.com/Homebrew/BrewUI. As one markdown file: README.md.

🧑‍💻 BrewUI

BrewUI user interface

Homebrew's official macOS GUI: making package management approachable for users who prefer graphical interfaces over Terminal, while maintaining complete transparency about underlying Homebrew operations.

💡 Motivation

Enable CLI-averse users to safely discover, install, update and manage Homebrew packages through a native SwiftUI interface that never hides what Homebrew is doing.

📲 Tech

📦 Installation

brew install --cask homebrew-app

Homebrew configuration

Put Homebrew options in brew.env and relaunch BrewUI after changing them. Shell aliases and exported variables do not configure the app. See Homebrew configuration.

🛠️ Development

After cloning:

./scripts/bootstrap

This installs Mint from Brewfile, runs mint bootstrap to build the SwiftFormat and SwiftLint versions pinned in Mintfile, enables repository git hooks and resolves Swift package dependencies for Homebrew.xcodeproj.

After bootstrap, commits automatically run checks on staged Swift files:

  1. mint run swiftformat
  2. mint run swiftlint (with --fix, then strict validation)

The hook also runs BrewUILint over the production tree. If unresolved lint violations remain, the commit is blocked and the hook prints the failures so you can fix and re-commit.

See development setup for signing configuration, conventions and testing for contributor guidance and architecture for system design.

🌍 Translations

Translations are community-sourced and a partial one is welcome: any string without a translation falls back to English. Copy lives in one Localizable.xcstrings catalog per UI target, Homebrew/ for the window, sidebar and menus, and Resources/ in BrewUIComponents and each BrewFeature* package. Edit a catalog in Xcode. See localisation for the reasoning behind the steps below.

Adding a language

  1. Open Homebrew/Localizable.xcstrings, press +, pick the language and translate at least one string there. macOS only lists a language in the per-app picker under Applications in System Settings when the app bundle ships it, so a language that exists only in a package catalog never loads and scripts/localize verify fails. Adding it also records the language in knownRegions in Homebrew.xcodeproj; commit that.
  2. Add the language to each package catalog you want to translate and do as much of it as you like.
  3. Never leave a translation blank. An empty value renders as empty text rather than falling back to English, so delete the entry instead of clearing it. verify fails on a blank.
  4. Run scripts/localize verify, then scripts/localize status to see how far the language has got.

Translating a string

  1. Find the catalog that holds it: grep -rl "Run Again" Homebrew/Localizable.xcstrings Sources/*/Resources/Localizable.xcstrings.
  2. Read the comment before translating. It says where the string appears and what each %@ or %lld stands for.
  3. Keep every format specifier the English has, and number them (%1$@, %2$lld) if your language needs a different order. Nothing checks this for you and a mismatch shows the wrong value at runtime.
  4. English needs only two plural forms, so the code picks between two keys itself (1 package and %lld packages). A language with more categories varies the %lld key by plural (Vary By Plural in Xcode) and translates 1 package as well.
  5. Mark the string as reviewed once you are happy with it. One left in Needs Review still ships, so the state is a note to yourself rather than a gate.
  6. Run scripts/localize verify.

Changing English copy

The key is the English text, so rewording a string makes a new entry rather than editing one.

  1. Change the literal in the Swift source, keeping bundle: #bundle and updating the comment: if the meaning moved.
  2. Run scripts/localize sync, which an Xcode build does for you. It adds the new key and marks the old one "extractionState" : "stale", keeping its translations.
  3. Carry each translation over to the new key where the wording still means the same thing. Where it does not, leave it behind so the string falls back to English until someone translates it again.
  4. Delete the stale entry once its translations have been carried over or discarded. Nothing fails while one lingers, but a catalog full of them buries the entries still worth rescuing.
  5. Commit the .xcstrings changes with the code. CI compares the catalogs against the built sources and fails if they have drifted.

🚧 Status

Stable and under active development.

📄 Licence

AGPL-3.0. If you reuse or adapt the source the AGPL terms apply, including the network-use clause.

BrewUI (Homebrew/BrewUI)

Searching Database…

2.6K ·GitHub
BrewUI
Что это такое?Официальный графический интерфейс Homebrew для macOS: ищите, устанавливайте, обновляйте пакеты и управляйте ими без Терминала, при этом всегда видно, что Homebrew делает под капотом.
Это отдельное приложение для Mac или надстройка над Терминалом?Отдельное нативное приложение для macOS, написанное на Swift и SwiftUI. Оно управляет Homebrew за вас, но никогда не скрывает, что Homebrew на самом деле делает под капотом.
Как установить его на свой Mac?Раздел Installation в README описывает, как получить приложение. Для сборки из исходников склонируйте репозиторий и запустите бутстрап Mint — он установит зафиксированные версии SwiftFormat и SwiftLint, включит git-хуки и подтянет зависимости Swift-пакета.
Нужен ли уже установленный Homebrew, или приложение несёт свой менеджер пакетов?Нужен уже настроенный Homebrew — BrewUI работает поверх него, беря данные о пакетах из CLI-утилиты brew и JSON API Homebrew.
Настроят ли приложение мои настройки шелла — алиасы, экспортируемые переменные?Нет. Опции Homebrew читаются только из файла brew.env, и после его изменения нужно перезапустить BrewUI; алиасы и переменные шелла ни на что не влияют.
Работает ли он ещё и с Homebrew на Linux, или только для Mac?Только для Mac. Это нативное приложение для macOS на Swift и SwiftUI, так что пользователям Homebrew на Linux остаётся Терминал.
Если я переиспользую или переработаю код BrewUI, что требует лицензия?Лицензия — AGPL-3.0: переиспользование или переработка исходников подпадает под условия AGPL, включая пункт об использовании по сети.
BrewUI достаточно стабилен для повседневного использования?Да — README описывает его как стабильный и активно развиваемый проект, и как официальный графический интерфейс Homebrew он уже собрал более 2 600 звёзд на GitHub.
А если BrewUI ещё не переведён на мой язык?Переводы делаются сообществом, и частичные тоже принимаются: любая строка без перевода откатывается на английский. Добавить язык можно через каталоги Localizable.xcstrings в Xcode, а прогресс проверяется командой scripts/localize status.
What are similar projects?MacPacker, tinycast, tendedero, macos-sysdata, Ice, OpenYoink, dimble, forel
Which topics is it in?swift-package-manager, localization, swiftui, agplv3, package-manager, native, translation, macos-app, homebrew, app, multilingual, swift
Creator
Homebrew
Size
2.9 MB
Stars
2.6K
Updated
CommitOct 16Releasev0.6.0Oct 13
Age
7mo
Commits · 90 Days