2015-03-23 10:00:36 +08:00
# Homebrew-Cask
2013-08-13 05:03:06 +08:00
2015-03-23 10:00:36 +08:00
_“To install, drag this icon…” no more!_
2013-04-05 16:10:59 +08:00
2016-06-14 04:11:40 +08:00
Homebrew-Cask extends [Homebrew ](http://brew.sh ) and brings its elegance, simplicity, and speed to the installation and management of GUI macOS applications such as Google Chrome and Adium.
2012-03-05 10:46:30 +08:00
2016-06-14 04:11:40 +08:00
We do this by providing a friendly Homebrew-style CLI workflow for the administration of macOS applications distributed as binaries.
2012-03-05 10:46:30 +08:00
2017-01-23 04:03:58 +08:00
It’ s implemented as a `homebrew` [external command ](http://docs.brew.sh/External-Commands.html ) called `cask` .
2012-03-05 10:46:30 +08:00
2015-03-22 23:56:27 +08:00
[![Build Status ](https://img.shields.io/travis/caskroom/homebrew-cask/master.svg )](https://travis-ci.org/caskroom/homebrew-cask)
2015-09-17 23:32:03 +08:00
[![Join the chat at https://gitter.im/caskroom/homebrew-cask ](https://img.shields.io/badge/gitter-join%20chat-blue.svg )](https://gitter.im/caskroom/homebrew-cask)
2015-03-22 23:56:27 +08:00
2015-09-07 21:23:51 +08:00
## Let’ s try it!
2015-09-16 06:24:11 +08:00
2015-12-22 20:33:44 +08:00
To start using Homebrew-Cask, you just need [Homebrew ](http://brew.sh/ ) installed.
2016-07-17 08:12:21 +08:00
< img src = "https://i.imgur.com/WYa2557.gif" width = "450px" alt = "Installing Atom (animated gif)" >
2015-09-16 06:24:11 +08:00
2016-07-02 12:39:51 +08:00
Slower, now:
2015-09-16 06:24:11 +08:00
2013-09-19 23:14:57 +08:00
```
2016-07-02 12:39:51 +08:00
$ brew cask install atom
==> Satisfying dependencies
complete
==> Downloading https://github.com/atom/atom/releases/download/v1.8.0/atom-mac.zip
######################################################################## 100.0%
==> Verifying checksum for Cask atom
==> Moving App 'Atom.app' to '/Applications/Atom.app'
==> Symlinking Binary 'apm' to '/usr/local/bin/apm'
==> Symlinking Binary 'atom.sh' to '/usr/local/bin/atom'
2016-07-17 04:13:02 +08:00
🍺 atom was successfully installed!
2016-07-02 12:39:51 +08:00
```
And there we have it. Atom installed with one quick command: no clicking, no dragging, no dropping.
2015-09-16 06:24:11 +08:00
2016-01-11 21:56:20 +08:00
## Learn More
2012-10-11 02:55:24 +08:00
2016-02-09 10:12:35 +08:00
* Find basic documentation on using Homebrew-Cask in [USAGE.md ](USAGE.md )
2015-09-16 06:24:11 +08:00
* Want to contribute a Cask? Awesome! See [CONTRIBUTING.md ](CONTRIBUTING.md )
2016-01-23 13:14:24 +08:00
* Want to hack on our code? Also awesome! See [hacking.md ](doc/development/hacking.md )
2016-01-15 09:57:32 +08:00
* More project-related details and discussion are available in the [documentation ](doc )
2013-07-09 22:30:07 +08:00
2016-06-19 23:41:05 +08:00
## Reporting bugs
2013-07-09 22:30:07 +08:00
2016-06-30 10:28:34 +08:00
Like most pieces of software, Homebrew-Cask has bugs — and we are busy fixing them! If you find a new bug tell us about it, but before you do make sure the problem isn’ t simply an outdated setup on your side, by following [this guide ](doc/reporting_bugs/pre_bug_report.md ).
2013-07-09 22:30:07 +08:00
2016-06-19 23:41:05 +08:00
If your issue persists, follow these instructions to the appropriate course of action:
2013-09-23 02:37:18 +08:00
2016-09-13 01:48:18 +08:00
* A cask fails to install:
* [`curl` error ](doc/reporting_bugs/a_cask_fails_to_install.md#curl-error )
* [`Permission denied` error ](doc/reporting_bugs/a_cask_fails_to_install.md#permission-denied-error )
* [`sha256 mismatch` error ](doc/reporting_bugs/a_cask_fails_to_install.md#sha256-mismatch-error )
* [`source is not there` error ](doc/reporting_bugs/a_cask_fails_to_install.md#source-is-not-there-error )
2016-12-18 09:53:09 +08:00
* [`wrong number of arguments` error ](doc/reporting_bugs/a_cask_fails_to_install.md#wrong-number-of-arguments-error )
2016-09-13 01:48:18 +08:00
* [Unlisted reason ](doc/reporting_bugs/a_cask_fails_to_install.md#unlisted-reason )
2016-06-30 10:28:52 +08:00
* [`brew cask list` shows wrong information ](doc/reporting_bugs/brew_cask_list_shows_wrong_information.md )
2016-07-02 12:38:07 +08:00
* [`uninstall` wrongly reports cask as not installed ](doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md )
2016-08-20 09:56:23 +08:00
* [`Error: Unknown command: cask` error ](doc/reporting_bugs/error_unknown_command_cask.md )
2016-10-12 17:34:19 +08:00
* [My problem isn’ t listed][bug_report]
2014-02-21 21:58:19 +08:00
2016-06-19 23:41:05 +08:00
## Requests
2016-01-04 17:59:19 +08:00
2016-06-19 23:41:05 +08:00
* Start an issue on GitHub following one of these templates:
2016-10-12 17:34:19 +08:00
* [Feature request][feature_request]
* [Cask request][cask_request]
2016-01-04 17:59:19 +08:00
2016-06-19 23:41:05 +08:00
## Questions? Wanna chat?
2016-01-04 17:59:19 +08:00
2016-06-19 23:41:05 +08:00
We’ re really rather friendly! Here are the best places to talk about the project:
2015-12-10 22:47:04 +08:00
2016-06-19 23:41:05 +08:00
* If none of the templates above is appropriate, [open an issue ](https://github.com/caskroom/homebrew-cask/issues/new ).
* Join us (and [caskbot ](https://github.com/passcod/caskbot )) on IRC at `#homebrew-cask` on Freenode
* Join us on [Gitter ](https://gitter.im/caskroom/homebrew-cask )
2015-01-11 01:36:08 +08:00
2016-01-11 19:37:41 +08:00
## License
2014-01-07 16:08:08 +08:00
Code is under the [BSD 2 Clause (NetBSD) license ](LICENSE )
2015-12-11 02:06:08 +08:00
2016-10-12 17:34:19 +08:00
[bug_report]: https://github.com/caskroom/homebrew-cask/issues/new?title=Bug%20report%3A%20%5Bsummarise%20the%20issue%20here%5D& body=Remember%20to%20follow%20the%20%5Bpre%20bug%20report%5D%28https%3A%2F%2Fgithub.com%2Fcaskroom%2Fhomebrew-cask%2Fblob%2Fmaster%2Fdoc%2Freporting_bugs%2Fpre_bug_report.md%29%20guide%20beforehand.%20Failure%20to%20do%20so%20might%20get%20your%20issue%20closed.%0A%0A%23%23%23%23%20Description%20of%20issue%0A%0A%5Binsert%20a%20detailed%20description%20of%20your%20issue%20here%5D%0A%0A%3Cdetails%3E%3Csummary%3EOutput%20of%20%60brew%20cask%20%3Ccommand%3E%20--verbose%60%3C%2Fsummary%3E%0A%0A%60%60%60%0A%5Bpaste%20output%20here%5D%0A%60%60%60%0A%3C%2Fdetails%3E%0A%0A%3Cdetails%3E%3Csummary%3EOutput%20of%20%60brew%20doctor%60%3C%2Fsummary%3E%0A%0A%60%60%60%0A%5Bpaste%20output%20here%5D%0A%60%60%60%0A%3C%2Fdetails%3E%0A%0A%3Cdetails%3E%3Csummary%3EOutput%20of%20%60brew%20cask%20doctor%60%3C%2Fsummary%3E%0A%0A%60%60%60%0A%5Bpaste%20output%20here%5D%0A%60%60%60%0A%3C%2Fdetails%3E%0A
2017-01-20 07:10:45 +08:00
[cask_request]: https://github.com/caskroom/homebrew-cask/issues/new?title=Cask%20request%3A%20%5Bapp%20name%20here%5D& body=%23%23%23%20Cask%20details%0A%0APlease%20fill%20out%20as%20much%20as%20possible.%20Before%20you%20do%2C%20note%20%2A%2Awe%20cannot%20support%20Mac%20App%20Store-only%20apps%2A%2A.%0A%0AName%3A%0A%0AHomepage%3A%0A%0ADownload%20URL%3A%0A%0ADescription%3A%0A
2016-10-12 17:34:19 +08:00
[feature_request]: https://github.com/caskroom/homebrew-cask/issues/new?title=Feature%20request%3A& body=%23%23%23%20Description%20of%20feature%2Fenhancement%0A%0A%0A%0A%23%23%23%20Justification%0A%0A%0A%0A%23%23%23%20Example%20use%20case%0A%0A%0A%0A