{"id":27888778,"url":"https://github.com/chingc/tutorial-homebrew","last_synced_at":"2025-05-05T09:28:11.790Z","repository":{"id":287985306,"uuid":"966437534","full_name":"chingc/tutorial-homebrew","owner":"chingc","description":"A quickstart and reference for Homebrew to help you get up and running fast.","archived":false,"fork":false,"pushed_at":"2025-05-04T15:46:19.000Z","size":2,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-05T09:28:01.479Z","etag":null,"topics":["documentation","homebrew","quickstart","readme","reference","tutorial"],"latest_commit_sha":null,"homepage":"https://brew.sh","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chingc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-14T23:27:24.000Z","updated_at":"2025-05-04T15:46:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"d21f49da-a2dd-4099-a8e0-1a61cd01932f","html_url":"https://github.com/chingc/tutorial-homebrew","commit_stats":null,"previous_names":["chingc/tutorial-homebrew"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chingc%2Ftutorial-homebrew","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chingc%2Ftutorial-homebrew/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chingc%2Ftutorial-homebrew/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chingc%2Ftutorial-homebrew/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chingc","download_url":"https://codeload.github.com/chingc/tutorial-homebrew/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252470847,"owners_count":21753060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","homebrew","quickstart","readme","reference","tutorial"],"created_at":"2025-05-05T09:28:11.029Z","updated_at":"2025-05-05T09:28:11.741Z","avatar_url":"https://github.com/chingc.png","language":null,"readme":"# Homebrew\n\nHomebrew is a popular command-line package manager for macOS (and Linux). It can install CLI tools, libraries, and prebuilt binaries. It can also install native macOS applications typically distributed as `.dmg`, `.pkg`, or `.app`. These two categories of software are known as formulae and casks in homebrew, respectively.\n\nInstalling software can be a complicated multi-step process. Knowing how to use homebrew means you'll be able to save time by installing software with a single command. More importantly, it enables automated installation of many applications with very simple scripts.\n\n## Install\n\n1. Open the macOS Terminal (or Linux shell prompt).\n1. Run the following code as a normal user. Do not use `sudo` or administrative privileges. The script explains what it will do and asks if you want to proceed. Accept to continue.\n   ```\n   /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n   ```\n1. Edit your shell profile as directed by the script to ensure homebrew loads when a terminal is started.\n1. Quit and restart your terminal.\n\nTo verify the installation, run `brew` and you should see example usage and help.\n\n## Managing Software\n\nHere are some commands I think you'll be using frequently.\n\n### search, info\n\n- search: Searches for available formulae or casks in homebrew by name.\n    - `brew search ghostty`\n\n- info: Displays detailed information about a specific formula or cask. This includes version, dependencies, whether it auto-updates, and more.\n    - `brew info ghostty`\n\n### install, uninstall, reinstall, list, deps, services\n\n- install: Downloads and installs a specified formula or cask to your system. In some rare cases you will find a formula and cask sharing the same name. To specifically install the cask add `--cask`.\n    - `brew install neovim`\n\n- uninstall: Removes a specified formula or cask from your system.\n    - `brew uninstall neovim`\n\n- reinstall: Uninstalls and then reinstalls a formula or cask to fix issues or refresh it. A shortcut for uninstall then install.\n    - `brew reinstall neovim`\n\n- list: Shows all installed formulae and casks on your system. The output also includes dependences required by formulae you've installed. If you include the name of a formula or cask it will show you where it's installed.\n    - `brew list`\n    - `brew list neovim`\n\n- deps: Lists the dependencies required by a specific formula.\n    - `brew deps neovim`\n\n- services: Some programs come with background services which homebrew can manage for you.\n    - `brew services`\n    - `brew services info redis`\n    - `brew services start redis`\n    - `brew services stop redis`\n\n### update, outdated, upgrade\n\n- update: Gets the latest homebrew formulae and cask definitions. Run this before checking for outdated versions.\n    - `brew update`\n\n- outdated: Lists installed formulae or casks that have newer versions available.\n    - `brew outdated`\n\n- upgrade: Upgrade all outdated formulae and casks. Specify a name to only upgrade a specific one.\n    - `brew upgrade`\n    - `brew upgrade starship`\n\n### autoremove, cleanup\n\n- autoremove: Removes unused dependencies that were installed as dependencies of other formulae.\n    - `brew autoremove`\n\n- cleanup: Deletes old versions and cached downloads to free up disk space.\n    - `brew cleanup`\n\n### pin, unpin\n\n- pin: Prevents a formula from being upgraded to keep it at the current version.\n    - `brew pin redis`\n\n- unpin: Allows a pinned formula to be upgraded again.\n    - `brew unpin redis`\n\n### link, unlink\n\n- link: Symlink all of formula's installed files into homebrew's prefix. This is done\nautomatically, but in some cases you may have to do it manually.\n    - `brew link python@3.13`\n\n- unlink: Removes symlinks for a formula, temporarily disabling access to its executables.\n    - `brew unlink python@3.13`\n\n### --prefix, --cellar, --caskroom\n\n- --prefix: Displays the installation path where homebrew or a formula stores its files.\n    - `brew --prefix`\n    - `brew --prefix uv`\n\n- --cellar: Shows the directory where homebrew stores installed formulae.\n    - `brew --cellar uv`\n\n- --caskroom: Displays the directory where homebrew stores installed casks.\n    - `brew --caskroom zed`\n\n## Uninstall\n\nDirections can be found [here](https://github.com/homebrew/install#uninstall-homebrew) if you want to uninstall homebrew.\n\n## GitHub Actions\n\nThe official [setup-homebrew](https://github.com/Homebrew/actions/tree/master/setup-homebrew) action will let you use homebrew on GitHub Actions.\n\n```\n- uses: Homebrew/actions/setup-homebrew@master\n```\n\nCheck out this workflow for a complete example: [.github/workflows/homebrew.yml](https://github.com/chingc/tutorial-github-actions/blob/main/.github/workflows/homebrew.yml)\n\n## Reference\n\nThe commands above should be enough for most users, but homebrew can do a lot more.\n\nType `brew commands` to see all commands. Use `brew help [COMMAND]` for help with any of them.\n\n- [Homebrew](https://brew.sh)\n- [Homebrew terminology](https://docs.brew.sh/Formula-Cookbook#homebrew-terminology)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchingc%2Ftutorial-homebrew","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchingc%2Ftutorial-homebrew","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchingc%2Ftutorial-homebrew/lists"}