A command-line interface for the Mac App Store. Designed for scripting and automation.
Homebrewis the preferred way to install:
brew install masMacPortsis an alternative way to install:
sudo port install masWe provide acustom Homebrew tapwith pre-built bottles for all macOS versions since 10.11 (El Capitan). The newest versions of mas, however, are only available for macOS 10.13+ (High Sierra or newer).
To install mas from our tap:
brew install mas-cli/tap/masAlternatively, binaries and sources are available from theGitHub Releases.
mas requires Swift 5 runtime support. macOS 10.14.4 (Mojave) and newer include it, but earlier releases do not. Without it, running mas might report errors similar to:
dyld: Symbol not found: _$s11SubSequenceSlTl
To get Swift 5 support on macOS versions older than 10.14.4 (Mojave), you can:
- Upgrade to macOS 10.14.4 (Mojave) or newer.
- Install theSwift 5 Runtime Support for Command Line Tools.
- Install Xcode 10.2 or newer to
/Applications/Xcode.app.
Each application in the Mac App Store has an integer app identifier (app ID). mas commands accept app IDs as arguments and output App IDs to uniquely identify apps.
mas searchandmas listcan be used to find the app IDs of relevant apps.
Alternatively, to find an app's app ID:
- Find the app in the Mac App Store
- Select
Share>Copy Link - Extract the app ID from the URL. e.g., the Mac App Store URL for Xcode,
https://apps.apple.com/us/app/xcode/id497799835?mt=12,
has app ID
497799835
None of the commands in this section require you to be logged into an Apple ID, neither for your macOS user, nor in the Mac App Store.
mas search <search-term>searches by name for applications available from the Mac App Store.
Providing the--priceflag includes each app's price in the output.
$ mas search Xcode
497799835 Xcode
688199928 DocsforXcode
449589707 Dash 3 - API Docs&Snippets. Integrates with Xcode, Alfred, TextWrangler and many more.
[...]mas info <app-id>displays more detailed information about an application available from the Mac App Store.
$ mas info 497799835
Xcode 16.0 [0.0]
By: Apple Inc.
Released: 2024-09-16
Minimum OS: 14.5
Size: 2.98 GB
From: https://apps.apple.com/us/app/xcode/id497799835?mt=12&uo=4All the commands in this section require you to be logged into an Apple ID for your macOS user.
mas listdisplays all the applications on your Mac that were installed from the Mac App Store.
$ mas list
497799835 Xcode (15.4)
640199958 Developer (10.6.5)
899247664 TestFlight (3.5.2)mas outdateddisplays all applications installed from the Mac App Store on your computer that have pending upgrades.
$ mas outdated
497799835 Xcode (15.4 ->16.0)
640199958 Developer (10.6.5 ->10.6.6)Runmas upgradeto install pending upgrades.
All the commands in this section require you to be logged into an Apple ID in the Mac App Store.
Depending on your Apple ID settings, you might need to re-authenticate yourself in the Mac App Store to perform a purchase, install, lucky, or upgrade, even if you are already signed in to an Apple ID in the Mac App Store.
mas purchase <app-id>…installs free applications that you haven't yet gotten/ "purchased" from the Mac App Store.
purchaseis currently a misnomer, because it currently can only "purchase" free apps. To purchase apps that cost money, please purchase them directly in the Mac App Store.
$ mas purchase 497799835
==>Downloading Xcode
==>Installed Xcodemas install <app-id>…installs apps that you have already gotten/ "purchased" from the Mac App Store.
Providing the--forceflag re-installs the app even if it is already installed on your computer.
$ mas install 497799835
==>Downloading Xcode
==>Installed Xcodemas lucky <search-term>installs the first result that would be returned bymas search <search-term>.
Likemas install,mas luckycan only install apps that have previously been gotten/ "purchased".
$ mas lucky Xcode
==>Downloading Xcode
==>Installed XcodeAll the commands in this section require you to be logged into an Apple ID in the Mac App Store.
mas only installs/upgrades applications from the Mac App Store. Use
softwareupdate(8)to install system updates (e.g., Xcode Command Line Tools, Safari, etc.)
mas upgradeupgrades outdated apps installed from the Mac App Store. Without any arguments, it upgrades all such apps.
$ mas upgrade
Upgrading 2 outdated applications:
Xcode (15.4) ->(16.0)
Developer (10.6.5) ->(10.6.6)
==>Downloading Xcode
==>Installed Xcode
==>Downloading Developer
==>Installed DeveloperUpgrades can be performed selectively by providing app IDs tomas upgrade.
$ mas upgrade 715768417
Upgrading 1 outdated application:
Xcode (15.4) ->(16.0)
==>Downloading Xcode
==>Installed XcodeAll the commands in this section interact with the Apple ID for which you are signed in in the Mac App Store. These commands do not interact with the Apple ID for which your macOS user is signed in.
⛔ The
signincommand is not supported on macOS 10.13 (High Sierra) or newer. On those macOS versions, please sign in via the Mac App Store instead. Please seeKnown Issues.
On macOS 10.12 (Sierra) or older,mas signin <apple-id>signs in to the specified Apple ID in the Mac App Store.
$ mas signin [email protected]
Password:Providing the--dialogflag signs in using a graphical dialog provided by Mac App Store.
mas signin --dialog [email protected]You can also embed your password in the command.
mas signin [email protected] MyPasswordmas signoutsigns out from the current Apple ID in the Mac App Store.
mas integrates withhomebrew-bundle.If mas is installed, when you runbrew bundle dump,
your Mac App Store apps will be included in the created Brewfile. See thehomebrew-bundle
docs for more details.
mas uses multiple undocumented Apple private frameworks to implement much of its functionality. Over time, Apple has silently changed these frameworks, breaking some functionality. Known issues include:
- ⛔️ The
signincommand is not supported on macOS 10.13 (High Sierra) or newer.#164 - ⛔️ The
accountcommand is not supported on macOS 12 (Monterey) or newer.#417
mas might be using suboptimal app version sources to compare local app versions with Mac App Store app versions. That current sources are frequently consistent with the Mac App Store, but are infrequently inconsistent. This might cause symptoms like#384and #387.mas will be updated soon to fix any such problems, if possible.
The Mac App Store operates on eventual consistency, so the versions seen by various parts of mas or the Mac App Store might be inconsistent for some period of time. This might cause symptoms like #384and#387.
Macs with Apple Silicon can install and run iOS and iPadOS apps from the Mac App Store. mas is not yet aware of these apps, and is not yet able to install or upgrade them.#321
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 insidetmux.A
wrapper tool existsto
fix pasteboard behaviour which also works for mas.
You should consider configuringtmuxto 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 installIf you see the following error, it's probably because you haven't yet "purchased" the app through the Mac App Store. See#46.
This redownload is not available for this Apple ID either because it was bought by a different user or the item was refunded or cancelled.
If mas doesn't work for you as expected (e.g. you can't install/upgrade apps), runmas reset,then try again.
If the issue persists, pleasefile a bug.
All feedback is much appreciated! ✨
You can build from Xcode by opening the root mas directory, or from the Terminal:
script/bootstrap
script/buildBuild output can be found in the.build/directory within the project.
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 mas target with tests in masTests. Tests are written usingQuick.
script/testmas was created by@argon. Code is under theMIT license.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
