2018-09-04 16:25:49 +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
2018-09-04 16:25:49 +08:00
Homebrew Cask extends [Homebrew ](https://brew.sh ) and brings its elegance, simplicity, and speed to the installation and management of GUI macOS applications such as Atom and Google Chrome.
2012-03-05 10:46:30 +08:00
2018-09-04 16:25:49 +08:00
We do this by providing a friendly CLI workflow for the administration of macOS applications distributed as binaries.
2012-03-05 10:46:30 +08:00
2018-07-12 08:54:24 +08:00
[![Join us on https://discourse.brew.sh ](https://img.shields.io/badge/Discourse-forum-blue.svg )](https://discourse.brew.sh)
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
2018-09-04 16:25:49 +08:00
To start using Homebrew Cask, you just need [Homebrew ](https://brew.sh/ ) installed.
2015-12-22 20:33:44 +08:00
2019-03-25 20:10:33 +08:00
< img src = "https://i.imgur.com/bjr8UxZ.gif" width = "547" alt = "Installing and uninstalling 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
2019-03-25 20:10:33 +08:00
==> Downloading https://github.com/atom/atom/releases/download/v1.35.1/atom-mac.zip
==> Downloading from https://github-production-release-asset-2e65be.s3.amazonaws.co
2016-07-02 12:39:51 +08:00
######################################################################## 100.0%
2019-03-25 20:10:33 +08:00
==> Verifying SHA-256 checksum for Cask 'atom'.
==> Installing Cask atom
==> Moving App 'Atom.app' to '/Applications/Atom.app'.
==> Linking Binary 'apm' to '/usr/local/bin/apm'.
==> Linking 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
2018-09-04 16:25:49 +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
2017-04-01 22:47:53 +08:00
[**If you ignore this guide, your issue may be closed without review** ](doc/faq/closing_issues_without_review.md ).
2013-07-09 22:30:07 +08:00
2019-01-25 00:15:27 +08:00
Before reporting a bug, run `brew update-reset && brew update` and try your command again. This is a fix-all that will reset the state of all your taps, ensuring the problem isn’ t an outdated setup on your side.
2017-04-01 22:47:53 +08:00
2019-01-25 00:15:27 +08:00
If your issue persists, [search for it ](https://github.com/Homebrew/homebrew-cask/search?type=Issues ) before opening a new one. If you find an open issue and have any new information, add it in a comment. If you find a closed issue, try the solutions there.
2017-04-01 22:47:53 +08:00
2019-01-25 00:15:27 +08:00
If the issue is still not solved, see the guides for common problems:
2013-09-23 02:37:18 +08:00
2019-01-25 00:15:27 +08:00
* [Examples of common errors and their solutions ](doc/reporting_bugs/error_examples.md )
* [`curl` error ](doc/reporting_bugs/curl_error.md )
* [`Permission denied` error ](doc/reporting_bugs/permission_denied_error.md )
* [`Checksum does not match` error ](doc/reporting_bugs/checksum_does_not_match_error.md )
* [`source is not there` error ](doc/reporting_bugs/source_is_not_there_error.md )
* [`wrong number of arguments` error ](doc/reporting_bugs/wrong_number_of_arguments_error.md )
2018-09-03 20:32:00 +08:00
* [The app can’ t be opened because it is from an unidentified developer ](doc/faq/the_app_cant_be_opened.md )
2018-07-23 22:05:33 +08:00
* [My problem isn’ t listed ](https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.md )
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
2020-03-16 07:35:50 +08:00
* Issues requesting new casks will be closed. If you want a cask added to the main repositories, [submit a pull request ](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#adding-a-cask ).
2018-05-22 03:21:38 +08:00
* For a feature request, [use this template ](https://github.com/Homebrew/homebrew-cask/issues/new?template=02_feature_request.md ).
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
2020-01-16 10:28:21 +08:00
* [Open an issue ](https://github.com/Homebrew/homebrew-cask/issues/new/choose ).
2018-07-12 08:54:24 +08:00
* Join us on [discourse.brew.sh (forum) ](https://discourse.brew.sh )
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 )