mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
127e9def50
GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
63 lines
3.8 KiB
Markdown
63 lines
3.8 KiB
Markdown
# External Commands
|
||
Homebrew, like Git, supports *external commands*. This lets you create new commands that can be run like:
|
||
|
||
```shell
|
||
$ brew mycommand --option1 --option3 formula
|
||
```
|
||
|
||
without modifying Homebrew's internals.
|
||
|
||
## Command Types
|
||
External commands come in two flavors: Ruby commands and shell scripts.
|
||
|
||
In both cases, the command file should be executable (`chmod +x`) and live somewhere in `$PATH`.
|
||
|
||
### Ruby Commands
|
||
An external command `extcmd` implemented as a Ruby command should be named `brew-extcmd.rb`. The command is executed by doing a `require` on the full pathname. As the command is `require`d, it has full access to the Homebrew "environment", i.e. all global variables and modules that any internal command has access to.
|
||
|
||
The command may `Kernel.exit` with a status code if it needs to; if it doesn't explicitly exit then Homebrew will return 0.
|
||
|
||
### Shell Scripts
|
||
A shell script for an command named `extcmd` should be named `brew-extcmd`. This file will be run via `exec` with some Homebrew variables set as environmental variables, and passed any additional command-line arguments.
|
||
|
||
| Variable | Description |
|
||
|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||
| HOMEBREW_CACHE | Where Homebrew caches downloaded tarballs to, by default ~/Library/Caches/Homebrew. |
|
||
| HOMEBREW_CELLAR | The location of the Homebrew Cellar, where software is staged. This will be $HOMEBREW_PREFIX/Cellar if that directory exists, or $HOMEBREW_REPOSITORY/Cellar otherwise. |
|
||
| HOMEBREW_LIBRARY_PATH | The directory containing Homebrew’s own application code. |
|
||
| HOMEBREW_PREFIX | Where Homebrew installs software. This is always the grandparent directory of the `brew` executable, /usr/local by default. |
|
||
| HOMEBREW_REPOSITORY | If installed from a Git clone, the repo directory (i.e., where Homebrew’s .git directory lives). |
|
||
|
||
|
||
Note that the script itself can use any suitable shebang (`#!`) line, so an external “shell script” can be written for sh, bash, Ruby, or anything else.
|
||
|
||
## User-submitted Commands
|
||
These commands have been contributed by Homebrew users but are not included in the main Homebrew repository, nor are they installed by the installer script. You can install them manually, as outlined above.
|
||
|
||
Note they are largely untested, and as always, be careful about running untested code on your machine.
|
||
|
||
### brew-livecheck
|
||
Check if there is a new upstream version of a formula.
|
||
See the [`README`](https://github.com/youtux/homebrew-livecheck/blob/master/README.md) for more info and usage.
|
||
|
||
Install using:
|
||
```sh
|
||
brew tap youtux/livecheck
|
||
```
|
||
|
||
### brew-gem
|
||
Install any gem package into a self-contained Homebrew cellar location: [https://github.com/sportngin/brew-gem](https://github.com/sportngin/brew-gem).
|
||
|
||
Note this can also be installed with `brew install brew-gem`.
|
||
|
||
### brew-growl
|
||
Get Growl notifications for Homebrew https://github.com/secondplanet/brew-growl
|
||
|
||
### brew-services
|
||
Simple support to start formulae using launchctl, has out of the box support for any formula which defines `startup_plist` (e.g. mysql, postgres, redis u.v.m.): [https://github.com/Homebrew/homebrew-services](https://github.com/Homebrew/homebrew-services)
|
||
|
||
Install using:
|
||
```sh
|
||
brew tap homebrew/services
|
||
```
|