目的別にまとめた Homebrew (brew) コマンドのリファレンス
📦 パッケージ (Formula) の検索と情報表示
目的のパッケージを探したり、詳細情報を確認したりします。
コマンド | エイリアス | 説明 | 使用例 |
---|---|---|---|
brew search <text> brew search /<regex>/ |
-S |
利用可能なパッケージ (Formula と Cask) を検索します。テキストまたは正規表現で検索できます。 |
|
brew info <formula> |
指定した Formula の詳細情報(バージョン、依存関係、インストールパス、オプションなど)を表示します。インストールされていなくても表示可能です。 |
|
|
brew desc <formula> |
指定した Formula の短い説明を表示します。 |
|
|
brew home <formula> |
homepage |
指定した Formula の公式サイトをデフォルトブラウザで開きます。 |
|
📥 パッケージ (Formula) のインストールとアンインストール
パッケージの追加や削除を行います。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew install <formula> |
--HEAD --build-from-source --verbose / -v --debug / -d --ignore-dependencies |
指定した Formula をインストールします。依存関係も自動的にインストールされます。 |
|
brew uninstall <formula> |
--force / -f --ignore-dependencies |
指定した Formula をアンインストールします。依存パッケージは削除されません。 |
|
brew reinstall <formula> |
(install と同様のオプション) |
指定した Formula をアンインストールしてから再インストールします。設定ファイルなどが破損した場合などに有効です。 |
|
brew autoremove |
--dry-run |
他の Formula の依存関係としてのみインストールされ、現在は不要になった Formula を自動的にアンインストールします。 |
|
💡 ヒント: 複数のパッケージを同時にインストール・アンインストールするには、スペース区切りで指定します。
例:
例:
brew install wget curl tree
🔄 パッケージ (Formula) の更新とアップグレード
Homebrew 自体やインストール済みのパッケージを最新の状態に保ちます。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew update |
--force --verbose / -v |
Homebrew 自体と、利用可能なパッケージリスト (Formula と Cask) を最新の情報に更新します。インストール済みのパッケージは更新されません。 |
|
brew upgrade [<formula>] |
--fetch-HEAD --dry-run --force-bottle |
インストール済みのパッケージを最新バージョンにアップグレードします。引数なしの場合は全ての outdated なパッケージをアップグレードします。特定のパッケージ名を指定すると、そのパッケージのみアップグレードします。 |
|
brew outdated |
--json=v2 --greedy (Cask も対象) |
アップグレード可能なインストール済みパッケージ (outdated) のリストを表示します。 |
|
brew pin <formula> |
指定した Formula が brew upgrade で自動的にアップグレードされないようにピン留め(固定)します。 |
|
|
brew unpin <formula> |
指定した Formula のピン留めを解除します。 |
|
|
brew list --pinned |
ピン留めされている Formula のリストを表示します。 |
|
⚠️ 注意:
brew update
はパッケージリストの更新、brew upgrade
はインストール済みパッケージ自体の更新です。通常は brew update && brew upgrade
のように連続で実行するか、brew upgrade
(内部で update が考慮される場合あり) を実行します。
📋 インストール済みパッケージ (Formula) の管理
インストールされているパッケージの確認や操作を行います。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew list |
--versions --pinned -1 (1列表示) |
Homebrew でインストールした Formula のリストを表示します。 |
|
brew leaves |
-r (再帰表示しない) |
他の Formula から依存されていない、ユーザーが直接インストールした Formula (leaves) のリストを表示します。 |
|
brew deps [<formula>] |
--tree --installed --include-build |
指定した Formula の依存関係を表示します。引数なしの場合、インストール済みの全ての Formula の依存関係を表示します。--tree でツリー表示されます。 |
|
brew uses <formula> |
--installed --recursive |
指定した Formula に依存している(その Formula を利用している)他の Formula を表示します。 |
|
brew switch <formula> <version> |
指定した Formula のアクティブなバージョンを、インストール済みの別のバージョンに切り替えます。 |
|
|
brew link <formula> |
--overwrite --dry-run |
インストール済み Formula のシンボリックリンクを /usr/local (または Homebrew の prefix) 配下に作成します。通常はインストール時に自動で行われますが、unlink された場合などに手動で実行します。 |
|
brew unlink <formula> |
--dry-run |
指定した Formula のシンボリックリンクを削除します。Formula 自体は削除されません。 |
|
brew cleanup |
-s (古いダウンロードキャッシュも削除)--dry-run |
古いバージョンの Formula やダウンロードキャッシュなど、不要になったファイルを削除します。デフォルトでは120日以上古いキャッシュなどが対象になることがあります。 |
|
🔧 Homebrew 自体の管理
Homebrew の設定確認やメンテナンスを行います。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew doctor |
Homebrew の設定や環境に問題がないか診断し、問題があれば解決策を提示します。トラブルシューティングの第一歩です。 |
|
|
brew config |
Homebrew の設定情報(バージョン、パス、環境変数など)を表示します。これもトラブルシューティングに役立ちます。 |
|
|
brew update-reset |
Homebrew のリポジトリ (homebrew-core, homebrew-cask) を強制的にリセットし、最新の状態に戻します。brew update が失敗する場合などに試します。 |
|
|
brew tap |
利用している Tap (追加リポジトリ) の一覧を表示します。 |
|
|
brew tap <user>/<repo> [<URL>] |
新しい Tap を追加します。これにより、公式以外の Formula もインストールできるようになります。 |
|
|
brew untap <user>/<repo> |
追加した Tap を削除します。 |
|
|
brew --prefix [<formula>] |
Homebrew のインストール先ディレクトリ (prefix) を表示します。Formula 名を指定すると、その Formula のインストール先を表示します。 |
|
|
brew --cache [<formula>] |
Homebrew のキャッシュディレクトリ、または指定した Formula のキャッシュファイルのパスを表示します。 |
|
|
brew analytics [on|off|state] |
Homebrew の匿名利用統計データの送信を制御します。 |
|
🖥️ Cask (GUI アプリケーション) の管理
Homebrew を使って macOS の GUI アプリケーションを管理します。コマンド体系は Formula と似ていますが、--cask
フラグまたはサブコマンドが必要です(一部例外あり)。
💡 補足: 以前は
brew cask install <app>
のような専用サブコマンドでしたが、現在は brew install --cask <app>
のように統合されています。古い情報源では brew cask
コマンドが記載されている場合があります。検索 (search
) や情報表示 (info
) は --cask
なしでも Cask を含めて検索・表示できます。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew search --casks <text> |
利用可能な Cask (GUI アプリ) を検索します。--casks オプションを使います。(brew search でも Formula と一緒に検索されます) |
|
|
brew info --cask <cask> |
--json=v2 |
指定した Cask の詳細情報(バージョン、公式サイトなど)を表示します。 |
|
brew install --cask <cask> |
--force --appdir=<dir> |
指定した Cask (GUI アプリ) をインストールします。通常 /Applications フォルダにインストールされます。 |
|
brew uninstall --cask <cask> |
--force --zap |
指定した Cask をアンインストールします。--zap オプションを使用すると、設定ファイルなど関連ファイルも可能な限り削除しようと試みます(注意して使用)。 |
|
brew reinstall --cask <cask> |
指定した Cask をアンインストールしてから再インストールします。 |
|
|
brew upgrade --cask [<cask>] |
--greedy --dry-run |
インストール済みの Cask を最新バージョンにアップグレードします。引数なしの場合、全ての outdated な Cask をアップグレードします。--greedy をつけると、バージョン指定が `latest` の Cask も強制的に再ダウンロード・インストールしようとします。 |
|
brew outdated --cask |
--greedy |
アップグレード可能なインストール済み Cask のリストを表示します。 |
|
brew list --cask |
--versions |
Homebrew でインストールした Cask のリストを表示します。 |
|
brew cleanup |
-s --dry-run |
Formula と同様に、Cask の古いダウンロードキャッシュなども削除対象になります。 |
|
⚙️ サービスの管理 (brew services)
MySQL, PostgreSQL, Nginx などのバックグラウンドサービス (デーモン) を macOS の launchctl
と連携して管理します。brew tap homebrew/services
が必要ですが、通常は初回利用時に自動で Tap されます。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew services list |
Homebrew で管理されているサービスの状態(実行中、停止中など)を一覧表示します。 |
|
|
brew services start <service> |
--file=<path> |
指定したサービスを開始し、ログイン時に自動起動するように登録します。サービス名は通常 Formula 名と同じです。 |
|
brew services stop <service> |
--all |
指定したサービスを停止し、ログイン時の自動起動登録を解除します。 |
|
brew services restart <service> |
指定したサービスを再起動します(停止してから開始)。自動起動の設定は変更されません。 |
|
|
brew services run <service> |
--all |
指定したサービスをフォアグラウンドで一度だけ実行します。自動起動には登録されません。デバッグなどに使えます。 |
|
brew services cleanup |
利用されていない、古いサービスの plist ファイルなどを削除します。 |
|
💡 ヒント: 全てのサービスを対象にする場合は
<service>
の代わりに --all
オプションが使えるコマンドがあります (例: brew services stop --all
)。
🩺 トラブルシューティングと診断
Homebrew の動作がおかしい場合に役立つコマンドです。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew doctor |
最も基本的な診断コマンド。設定の問題、古いリンク、権限の問題などをチェックし、修正方法を提案します。問題が発生したら、まずこれを実行します。 |
|
|
brew config |
Homebrew の詳細な設定と環境情報を表示します。問題報告時にこの情報を含めると役立ちます。 |
|
|
brew missing |
インストール済みの Formula で、依存関係が満たされていないものをリストアップします。 |
|
|
brew update-reset |
brew update が Git 関連のエラーで失敗する場合などに、Homebrew のコアリポジトリを初期状態に近い形に戻して再試行します。ローカルの変更は失われる可能性があります。 |
|
|
brew install --verbose --debug <formula> |
-vd |
特定の Formula のインストールが失敗する場合に、非常に詳細なログとデバッグ情報を出力させます。エラーの原因特定に役立ちます。 |
|
brew readall |
--aliases |
全ての Formula と Cask を読み込み、構文エラーなどがないかチェックします。Tap の開発時などに使われます。 |
|
🔥 重要:
brew doctor
の警告は、必ずしも全てが深刻な問題とは限りません。Homebrew の動作に支障がなければ無視できる警告もあります。メッセージをよく読んで判断してください。
🚀 高度な操作とカスタマイズ
Homebrew をさらに深く利用するためのコマンドです。
コマンド | オプション例 | 説明 | 使用例 |
---|---|---|---|
brew edit <formula|cask> |
指定した Formula または Cask の定義ファイル (Ruby スクリプト) をエディタで開きます。修正や内容確認に使います。 |
|
|
brew create <URL> |
--tap=<tap> --cask |
指定した URL (通常はソースコードの tarball) から新しい Formula のテンプレートを作成します。自作パッケージを Homebrew で管理する第一歩です。--cask で Cask のテンプレートも作成可能です。 |
|
brew bundle dump |
--file=<path> --force |
現在インストールされている Formula, Cask, Tap, Mac App Store アプリ (mas が必要) のリストを Brewfile というファイルに出力します。環境のバックアップや移行に便利です。 |
|
brew bundle install |
--file=<path> --no-lock |
カレントディレクトリまたは指定したパスにある Brewfile を読み込み、リストされているパッケージ等を一括でインストールします。新しい環境のセットアップに強力です。 |
|
brew fetch <formula|cask> |
--force --HEAD --deps |
指定した Formula や Cask のソースやバイナリ (Bottle) をダウンロードだけ行い、インストールはしません。依存関係も一緒にダウンロードするには --deps をつけます。 |
|
brew audit <formula|cask> |
--strict --online |
指定した Formula や Cask が Homebrew のコーディング規約や作法に準拠しているかチェックします。Formula を自作・修正した場合に使用します。 |
|
brew bottle <formula> |
--json |
指定した Formula のビルド済みバイナリパッケージ (Bottle) を作成します。主にメンテナーが使用します。 |
|
コメント