Swiftpack.co -  mas-cli/mas as Swift Package
Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
mas-cli/mas
:package: Mac App Store command line interface
.package(url: "https://github.com/mas-cli/mas.git", from: "v1.8.3")

mas-cli

mas-cli

A simple command line interface for the Mac App Store. Designed for scripting and automation.

Software License Swift 5 GitHub Release Reviewed by Hound Build, Test, & Lint

📲 Install

🍺 Homebrew

Homebrew is the preferred way to install:

brew install mas

MacPorts

MacPorts works as well:

sudo port install mas

⚠️ Note that macOS 10.15 (Catalina) is required to install mas from MacPorts or the core Homebrew formula.

☎️ Older macOS Versions

We provide a custom Homebrew tap with pre-built bottles for all macOS versions since 10.11.

To install mas from our tap:

brew install mas-cli/tap/mas

Swift 5 Runtime Support

mas requires Swift 5 runtime support. macOS 10.14.4 and later include it, but earlier releases did not. Without it, running mas may report an error similar to this:

dyld: Symbol not found: _$s11SubSequenceSlTl

To get Swift 5 support, you have a few options:

🐙 GitHub Releases

Alternatively, binaries are available in the GitHub Releases.

🤳🏻 Usage

Each application in the Mac App Store has a product identifier which is also used for mas-cli commands. Using mas list will show all installed applications and their product identifiers.

$ mas list
446107677 Screens
407963104 Pixelmator
497799835 Xcode

It is possible to search for applications by name using mas search which will search the Mac App Store and return matching identifiers. Include the --price flag to include prices in the result.

$ mas search Xcode
497799835 Xcode
688199928 Docs for Xcode
449589707 Dash 3 - API Docs & Snippets. Integrates with Xcode, Alfred, TextWrangler and many more.
[...]

To install or update an application simply run mas install with an application identifier:

$ mas install 808809998
==> Downloading PaintCode 2
==> Installed PaintCode 2

If you want to install the first result that the search command returns, use the lucky command.

$ mas lucky twitter
==> Downloading Twitter
==> Installed Twitter

Please note that this command will not allow you to install (or even purchase) an app for the first time: use the purchase command in that case.

$ mas purchase 768053424
==> Downloading Gapplin
==> Installed Gapplin

Please note that you may have to re-authenticate yourself in the App Store to complete the purchase. This is the case if the application is not free or if you configured your account not to remember the credentials for free purchases.

Use mas outdated to list all applications with pending updates.

$ mas outdated
497799835 Xcode (7.0)
446107677 Screens VNC - Access Your Computer From Anywhere (3.6.7)

mas is only able to install/update applications that are listed in the Mac App Store itself. Use softwareupdate(8) utility for downloading system updates (e.g. Xcode Command Line Tools)

To install all pending updates run mas upgrade.

$ mas upgrade
Upgrading 2 outdated applications:
Xcode (7.0), Screens VNC - Access Your Computer From Anywhere (3.6.7)
==> Downloading Xcode
==> Installed Xcode
==> Downloading iFlicks
==> Installed iFlicks

Updates can be performed selectively by providing the app identifier(s) to mas upgrade

$ mas upgrade 715768417
Upgrading 1 outdated application:
Xcode (8.0)
==> Downloading Xcode
==> Installed Xcode

🚏📥 Sign-in

To sign into the Mac App Store for the first time run mas signin.

$ mas signin mas@example.com
==> Signing in to Apple ID: mas@example.com
Password:

⚠️ Due to breaking changes in the underlying API that mas uses to interact with the Mac App Store, the signin command has been temporarily disabled on macOS 10.13+ ⛔. For more information on this issue, see #164.

If you experience issues signing in this way, you can ask to signin using a graphical dialog (provided by Mac App Store application):

$ mas signin --dialog mas@example.com
==> Signing in to Apple ID: mas@example.com

You can also embed your password in the command.

$ mas signin mas@example.com 'ZdkM4f$gzF;gX3ABXNLf8KcCt.x.np'
==> Signing in to Apple ID: mas@example.com

Use mas signout to sign out from the Mac App Store.

🍺 Homebrew integration

mas is integrated with homebrew-bundle. If mas is installed, and you run brew bundle dump, then your Mac App Store apps will be included in the Brewfile created. See the homebrew-bundle docs for more details.

💥 When something doesn't work

If you see this error, it's probably because you haven't installed the app through the App Store yet. See #46.

This redownload is not available for this Apple ID either because it was bought by a different user of the item was refunded or cancelled.

If mas doesn't work for you as expected (e.g. you can't update/download apps), run mas reset and try again. If the issue persists, please file a bug. All your feedback is much appreciated! ✨

📺 Using tmux

mas operates via the same system services as the Mac App Store. These exist as separate processes with communication through XPC. As a result of this, mas experiences similar problems as the pasteboard when running inside tmux. A wrapper tool exists to fix pasteboard behaviour which also works for mas.

You should consider configuring tmux to use the wrapper but if you do not wish to do this it can be used on a one-off basis as follows:

brew install reattach-to-user-namespace
reattach-to-user-namespace mas install

ℹ️ Build from source

You can build from Xcode by opening the root mas directory, or from the Terminal:

script/bootstrap
script/build

Build output can be found in the build/ directory within the project.

✅ Tests

The tests in this project are a recent work-in-progress. Since Xcode does not officially support tests for command-line tool targets, all logic is part of the MasKit target with tests in MasKitTests. Tests are written using Quick.

script/test

📄 License

mas-cli was created by @argon. Code is under the MIT license.

GitHub

link
Stars: 8377
Last commit: 1 week ago

Ad: Job Offers

iOS Software Engineer @ Perry Street Software
Perry Street Software is Jack’d and SCRUFF. We are two of the world’s largest gay, bi, trans and queer social dating apps on iOS and Android. Our brands reach more than 20 million members worldwide so members can connect, meet and express themselves on a platform that prioritizes privacy and security. We invest heavily into SwiftUI and using Swift Packages to modularize the codebase.

Submit a free job ad (while I'm testing this). The analytics numbers for this website are here.

Release Notes

v1.8.3: 🐛 Ignore applications moved outside the system Applications folder
1 week ago

🐛 Bug Fixes

  • 🏡 Ignore applications moved outside the system Applications folder (#376) @chris-araman
  • 🩹 Display decimal progress percentage (#399) @mtoohey31

Changes

  • ⚙️ Prepare for Xcode 13 (#407) @chris-araman
  • 🧹 Enable linting with Xcode 13 beta 3 (#406) @chris-araman
  • ⬆️ Periphery (2.7.1), Ruby (3.0.2), SwiftFormat (0.48.9) (#400) @chris-araman
  • ⬆️ Danger (8.3.1) (#401) @dependabot
  • 🧹 Restore shellcheck (0.7.2) (#396) @chris-araman
  • ⬆️ Periphery (2.5.2), SwiftFormat (0.48.4), Version (2.0.1) (#394) @chris-araman
  • 🧹 Remove unused code (#391) @chris-araman
  • ⬆️ PromiseKit (6.15.0) (#390) @chris-araman
  • ⬆️ PromiseKit (6.14.0) (#389) @chris-araman
  • 🧹 Lint in GitHub Actions (#377) @chris-araman
  • 🚨 Fail CI task if tests fail (#381) @chris-araman
  • ⬆️ Nimble (9.2.0) (#374) @chris-araman
  • 🤞🏼 Rephrase async code as PromiseKit Promises (#362) @chris-araman
  • 🧹 Lint with periphery (#372) @chris-araman
  • 🍺 Publish bottles for custom tap to GitHub Releases (#373) @chris-araman
  • 🪧 Update references to main branch (#370) @chris-araman
  • ⬆️ Quick (4.0.0), Nimble (9.1.0) (#367) @chris-araman

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics