Skip to content

Latest commit

 

History

History
122 lines (85 loc) · 6.93 KB

README.md

File metadata and controls

122 lines (85 loc) · 6.93 KB
Raw

Cork

A fast GUI for Homebrew written in SwiftUI

Mastodon Link Mastodon Link

Special Thanks

I'd like to personally thank Seb Jachec for implementing a system for getting real-time outputs of Brew commands.

Without his contribution, many of the processes that depend on real-time outputs, such as installation, uninstallation and updating of packages, would be impossible.

Advantages of Cork

Cork is not just an interface for Homebrew. It has many features that are either very hard to accomplish using Homebrew alone, or straight-up not possible.

Things that are not possible without Cork

  • Automatically respecting system proxy.
  • Clearing of cached downloads.
  • Updating packages from the Menu Bar without having Cork open.
  • Seeing this much info about a package in one convenient location.
  • Tagging packages. This is a Cork-only feature that lets you mark any number of packages you'd like to keep track of.

Things that Cork makes easier

  • Listing of installed packages. Cork has its own way of loading packages, which is around 10 times faster than the Homebrew implementation.
  • Knowing which packages you installed intentionally, and which packages were installed only as dependencies. While somewhat possible with the brew leaves command, it is often unreliable, often not listing packages that should be included.
  • Updating of only selected packages. Again, while possible with Homebrew alone, Cork makes it so easy you wouldn't believe it is not this simple in Homebrew itself.
  • Showing you exactly which packages a package is a dependency of. Super annoying in Homebrew, effortless with Cork.
  • And many other features! Just try Cork out and try finding them all 😉

Getting Cork

Pre-compiled, always up-to-date versions are available from my Homebrew tap. You can get access to it in a few ways:

  • Buy Cork for 25€ through the website. You will get access to all future versions at no additional cost.
  • Become a contributor. For example, you can:
    • Translate Cork into your language, and keep your translation updated. I'd recommend joining the Cork Discord, as I always ping the translators there when new text is ready for translating. If you aren't sure how to go about translating Cork, I'd recommend asking the translation team on Discord. They have the Linguist role. If you'd prefer to learn on your own, this Apple documentation article is a nice introduction to the process: Internalization.
    • Implement a feature tagged with Help Wanted in the Issue Tracker. Please espect the coding style. The main deviation from the Swift convention is that brackets are on their own lines.

However, if you don't want to do any of the above, you can always compile Cork yourself. See below for instructions.

Screenshots

Main Window

Start Page

Package Info

Package Info Package Info - Full-size Caveats Package Info - Minimized Caveats

Tap Info

Tap Info - Formulae Only Tap Info - Formulae and Casks

Install Package

Install Package Install Package - Fetching Dependencies Install Package - Installing Dependencies

Add Taps

Tap Taps

Brew Maintenance

Brew Maintenance Brew Maintenance Results

Media

Do you run a blog, a magazine, make videos, or just make content about apps for fun? Get in touch at [email protected]!

I will provide you with the newest release and development version, answer any questions you have, and introduce you to Cork personally (and for free, or course), so you can focus on creating.

Compiling Cork

Compiling Cork is simple, as it does not have many dependencies.

Prerequisites:

  • macOS Ventura or newer
  • Xcode 15 or newer
  • Git

Instructions:

Before you begin

Skip if you already have an Apple Developer account

  1. Enroll your account in the developer program at https://developer.apple.com/. You don't need a paid account, a free one works fine
  2. Install Xcode
  3. Add your Developer account to Xcode. To do so, in the Menu bar, click Xcode → Settings, and in the window that opens, click Accounts. You can add your account there
  4. After you add your account, it will appear in the list of Apple IDs on the left of the screen. Select your account there
  5. At the bottom of the screen, click Manage Certificates...
  6. On the bottom left, click the + icon and select Apple Development
  7. When a new item appears in the list called Apple Development Certificates, you can press Done to close the account manager

Compiling Cork

  1. Clone this repo using git clone https://github.com/buresdv/Cork.git && cd Cork && open Cork.xcodeproj. Xcode will open the project
  2. Wait until all the dependencies are resolved. It should take a couple minutes at most
  3. In the file browser on the left, click Cork at the very top. It's the icon with the App Store logo
  4. In the pane that opens on the right, click Signing & Capabilities at the top
  5. Under Signing, switch the Team dropdown to None
  6. Under Signing → macOS, switch the Signing Certificate to Sign to Run Locally
  7. In the Menu Bar, click Product → Archive and wait for the building to finish
  8. A new window will open. From the list of Cork rows, select the topmost one, and click Distribute App
  9. In the popup that appears, click Custom, then click Next in the bottom right of the popup
  10. Click Copy App
  11. Open the resulting folder. You'll see an app called Cork. Drag Cork to your /Applications/ folder, and you're done!

License

Cork is licensed under Commons Clause.

This means that Cork open-source and you can do whatever you want with Cork's source, like modifying it, contributing to it etc., but you can't sell Cork or modified versions of it.

Moreover, you can’t distribute compiled versions of Cork without consulting me first. Compiling versions for your personal use is fine.