mirror of
https://github.com/donl/homebrew-cask-versions.git
synced 2026-07-16 22:06:43 -06:00
Overhaul USAGE.md
- Include all current commands - Use new functionality to skip explicit "brew tap" commands - Document all forms for specifying Casks (URI, etc) - Demote "Additional Taps" section to near the end - Other small tweaks too numerous to list
This commit is contained in:
Roland Walker
parent
728221a264
commit
9268552fcd
1 changed files with 141 additions and 62 deletions
203
USAGE.md
203
USAGE.md
|
|
@ -1,81 +1,146 @@
|
|||
# How to Use
|
||||
# How to Use Homebrew-cask
|
||||
|
||||
## Getting Started
|
||||
|
||||
First ensure you have Homebrew version '0.9' or higher:
|
||||
First ensure you have Homebrew version '0.9.5' or higher:
|
||||
|
||||
$ brew --version
|
||||
0.9.3
|
||||
```bash
|
||||
$ brew --version
|
||||
0.9.5
|
||||
```
|
||||
|
||||
Tap this repository and install the `brew-cask` tool:
|
||||
Install the Homebrew-cask tool:
|
||||
|
||||
$ brew tap phinze/homebrew-cask
|
||||
$ brew install brew-cask
|
||||
```bash
|
||||
$ brew install phinze/cask/brew-cask
|
||||
```
|
||||
|
||||
### Additional Taps (optional)
|
||||
## Frequently Used Commands
|
||||
|
||||
The primary tap includes most of the Casks that a normal user will be
|
||||
interested in. There are a few additional Taps where we store different kinds
|
||||
of Casks.
|
||||
Homebrew-cask is implemented as a subcommand of Homebrew. All Homebrew-cask
|
||||
commands begin with `brew cask`. Homebrew-cask has its own set of command
|
||||
verbs many of which are similar to Homebrew's. The most frequently-used
|
||||
commands are:
|
||||
|
||||
| tap name | description |
|
||||
| -------- | ----------- |
|
||||
| [caskroom/versions](https://github.com/caskroom/homebrew-versions) | contains alternate versions of Casks (e.g. betas, nightly releases, old versions)
|
||||
| [caskroom/fonts](https://github.com/caskroom/homebrew-fonts) | contains casks that install fonts, which are kept separate so we can educate users about the different licensing landscape around font installation/usage
|
||||
|
||||
You can tap any of the above with a command like this:
|
||||
|
||||
$ brew tap (tap name)
|
||||
|
||||
Once that command completes, you should see the list of Casks in the tap alongside the Casks in the main repo. You use the same commands to interact with these additional Casks, and `brew update` will automatically update all Taps.
|
||||
* `search` -- searches all known Casks
|
||||
* `install` -- installs the given Cask
|
||||
* `uninstall` -- uninstalls the given Cask
|
||||
|
||||
## Searching for Casks
|
||||
|
||||
Let's see if there's a Cask for Chrome:
|
||||
The `brew cask search` command accepts a substring (or regular expression) argument.
|
||||
Let's see if there's a Cask for Google Chrome:
|
||||
|
||||
$ brew cask search chrome
|
||||
google-chrome
|
||||
```bash
|
||||
$ brew cask search chrome
|
||||
google-chrome
|
||||
```
|
||||
|
||||
Listing all available Casks can be done with a `search` command with no search term:
|
||||
A `search` command with no search term will list all available Casks:
|
||||
|
||||
$ brew cask search
|
||||
# list of all available casks
|
||||
```bash
|
||||
$ brew cask search
|
||||
# <list of all available Casks>
|
||||
```
|
||||
|
||||
## Installing Casks
|
||||
|
||||
$ brew cask install google-chrome
|
||||
==> Downloading https://dl.google.com/chrome/mac/stable/GGRO/googlechrome.dmg
|
||||
==> Success! google-chrome installed to /opt/homebrew-cask/Caskroom/google-chrome/stable-channel
|
||||
==> Linking Google Chrome.app to /Users/paulh/Applications/Google Chrome.app
|
||||
The command `brew cask install` accepts a Cask name as returned by `brew cask search`.
|
||||
Let's try to install Google Chrome:
|
||||
|
||||
## Inspecting Installed Casks
|
||||
|
||||
List all installed Casks
|
||||
|
||||
$ brew cask list
|
||||
adium google-chrome one-password
|
||||
|
||||
Details about a single Cask:
|
||||
|
||||
$ brew cask info caffeine
|
||||
caffeine: 1.1.1
|
||||
http://lightheadsw.com/caffeine/
|
||||
Not installed
|
||||
https://github.com/phinze/homebrew-cask/commits/master/Casks/caffeine.rb
|
||||
|
||||
## Updating/Upgrading Casks
|
||||
|
||||
Since this repository is a Tap, you'll pull down the latest Casks with a simple
|
||||
`brew update`. When the `brew-cask` tool itself is updated, it will show in
|
||||
`brew outdated` and you can upgrade it via the normal Homebrew workflow.
|
||||
```bash
|
||||
$ brew cask install google-chrome
|
||||
==> Downloading https://dl.google.com/chrome/mac/stable/GGRO/googlechrome.dmg
|
||||
==> Success! google-chrome installed to /opt/homebrew-cask/Caskroom/google-chrome/stable-channel
|
||||
==> Linking Google Chrome.app to /Users/paulh/Applications/Google Chrome.app
|
||||
```
|
||||
|
||||
## Uninstalling Casks
|
||||
|
||||
Easy peasy:
|
||||
|
||||
brew cask uninstall google-chrome
|
||||
```bash
|
||||
$ brew cask uninstall google-chrome
|
||||
```
|
||||
|
||||
This will both uninstall and unlink the Cask.
|
||||
This will both uninstall the Cask and remove symlinks which were created in
|
||||
`~/Applications`.
|
||||
|
||||
## Other Commands
|
||||
|
||||
* `info` -- displays information about the given Cask
|
||||
* `list` -- with no args, lists installed Casks; given installed Casks, lists installed files
|
||||
* `doctor` -- checks for configuration issues
|
||||
* `home` -- opens the homepage of the given Cask
|
||||
* `alfred` -- modifies Alfred's scope to include the Caskroom
|
||||
|
||||
The following commands are for Cask authors:
|
||||
|
||||
* `audit` -- verifies installability of Casks
|
||||
* `create` -- creates a Cask and opens it in an editor
|
||||
* `edit` -- edits the given Cask
|
||||
* `checklinks` -- checks for bad Cask links
|
||||
|
||||
## Inspecting Installed Casks
|
||||
|
||||
List all installed Casks
|
||||
|
||||
```bash
|
||||
$ brew cask list
|
||||
adium google-chrome onepassword
|
||||
```
|
||||
|
||||
Show details about a specific Cask:
|
||||
|
||||
```bash
|
||||
$ brew cask info caffeine
|
||||
caffeine: 1.1.1
|
||||
http://lightheadsw.com/caffeine/
|
||||
Not installed
|
||||
https://github.com/phinze/homebrew-cask/commits/master/Casks/caffeine.rb
|
||||
```
|
||||
|
||||
## Updating/Upgrading Casks
|
||||
|
||||
Since the Homebrew-cask repository is a Homebrew Tap, you'll pull down the latest
|
||||
Casks every time you issue the regular Homebrew command `brew update`. Currently,
|
||||
Homebrew-cask cannot always detect if an Application has been updated. You
|
||||
can force an update via the command `brew cask install --force`. We are working
|
||||
on improving this.
|
||||
|
||||
It is generally safe to run updates from within an Application.
|
||||
|
||||
## Updating/Upgrading the Homebrew-cask Tool
|
||||
|
||||
When a new version Homebrew-cask is released, it will appear in the output of
|
||||
`brew outdated` after running `brew update`. You can upgrade it via the normal
|
||||
Homebrew workflow: `brew upgrade brew-cask`.
|
||||
|
||||
## Additional Taps (optional)
|
||||
|
||||
The primary Homebrew-cask Tap includes most of the Casks that a typical user will
|
||||
be interested in. There are a few additional Taps where we store different kinds
|
||||
of Casks.
|
||||
|
||||
| Tap name | description |
|
||||
| -------- | ----------- |
|
||||
| [caskroom/versions](https://github.com/caskroom/homebrew-versions) | contains alternate versions of Casks (e.g. betas, nightly releases, old versions)
|
||||
| [caskroom/fonts](https://github.com/caskroom/homebrew-fonts) | contains Casks that install fonts, which are kept separate so we can educate users about the different licensing landscape around font installation/usage
|
||||
|
||||
You can tap any of the above with a `brew tap` command:
|
||||
|
||||
```bash
|
||||
$ brew tap <tap_name>
|
||||
```
|
||||
|
||||
after which, Casks from the new Tap will be available to `search` or `install` just like Casks from the main Tap.
|
||||
`brew update` will automatically keep your new Tap up to date.
|
||||
|
||||
You may also specify a fully-qualified Cask name (which includes the Tap) for any `brew cask` command. This will implicitly add the Tap if you have not previously added it with `brew tap`:
|
||||
|
||||
```bash
|
||||
$ brew cask install caskroom/fonts/font-symbola
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
|
|
@ -83,10 +148,9 @@ This will both uninstall and unlink the Cask.
|
|||
|
||||
* `--version`: print version and exit
|
||||
* `--debug`: output debug information
|
||||
* `--no-binaries`: skip symlinkning binaries into `/usr/local/bin`
|
||||
* `--no-binaries`: skip symlinking executable binaries into `/usr/local/bin`
|
||||
|
||||
You can also provide a number of options to the `brew cask` command to modify the default
|
||||
installation locations.
|
||||
You can also modify the default installation locations used by the `brew cask` command:
|
||||
|
||||
* `--caskroom=/my/path` determines where the actual applications will be located.
|
||||
Default is `/opt/homebrew-cask/Caskroom`
|
||||
|
|
@ -104,7 +168,7 @@ Default is `~/Library/Fonts`
|
|||
* `--binarydir=/my/path` changes the path for binary symlinks.
|
||||
Default is `/usr/local/bin`
|
||||
|
||||
To make these changes permanent, you might want to add the following line to your `.bash_profile` or `.zshenv`:
|
||||
To make these settings persistent, you might want to add the following line to your `.bash_profile` or `.zshenv`:
|
||||
|
||||
```bash
|
||||
# Specify your defaults in this environment variable
|
||||
|
|
@ -112,7 +176,7 @@ export HOMEBREW_CASK_OPTS="--appdir=/Applications --caskroom=/etc/Caskroom"
|
|||
```
|
||||
|
||||
Note that you still can override the environment variable `HOMEBREW_CASK_OPTS` by _explicitly_ providing
|
||||
the options in the command line:
|
||||
options in the command line:
|
||||
|
||||
```bash
|
||||
# Will force the Chrome app to be linked to ~/Applications
|
||||
|
|
@ -120,12 +184,27 @@ the options in the command line:
|
|||
$ brew cask install --appdir="~/Applications" google-chrome
|
||||
```
|
||||
|
||||
# Taps
|
||||
## Other Ways to Specify a Cask
|
||||
|
||||
You can add Casks to your existing (or new) taps: just create a directory named
|
||||
`Casks` inside your tap, put your Casks there, and everything will just work.
|
||||
Most `brew cask` commands can accept a Cask name as an argument. As described
|
||||
above, a Cask name on the command line can take the form of:
|
||||
|
||||
# Alfred Integration
|
||||
* a Cask name as returned by `brew cask search`, _eg_: `google-chrome`
|
||||
* a fully-qualified Cask name which includes the Tap, _eg_: `caskroom/fonts/font-symbola`
|
||||
|
||||
`brew cask` also accepts two other forms for Cask names:
|
||||
|
||||
* a fully-qualified pathname to a Cask file, _eg_: `/usr/local/Cellar/brew-cask/0.25.0/Casks/google-chrome.rb`
|
||||
* a `curl`-retrievable URI to a Cask file, _eg_: `https://raw.github.com/phinze/homebrew-cask/f54bbfaae0f2fa7210484f46313a459cb8a14d2f/Casks/google-chrome.rb`
|
||||
|
||||
The last two forms are intended for users who wish to maintain private Casks.
|
||||
|
||||
## Taps
|
||||
|
||||
You can add Casks to your existing (or new) Taps: just create a directory named
|
||||
`Casks` inside your Tap, put your Cask files there, and everything will just work.
|
||||
|
||||
## Alfred Integration
|
||||
|
||||
I've been using Casks along with Alfred to great effect. Just add
|
||||
`/opt/homebrew-cask/Caskroom` as a Search Scope in Alfred's preferences or
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue