diff --git a/README.md b/README.md new file mode 100644 index 0000000..d5c5d91 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# mas-cli + +Command line interface for the Mac App Store, designed for scripting and +automation. + +## Install + +[Homebrew](hb) is the preferred way to install: + + brew install argon/mas/mas + +Alternatively binaries are available in the [GitHub Releases](ghreleases) + +## Usage + +Each application in the Mac App Store has a product identifier which is also +used for mas-cli commands. The best way to find the product identifier of an +app is to run `mas list`. This will list all installed applications along with +their product identifiers + + $ mas list + 446107677 Screens + 407963104 Pixelmator + 497799835 Xcode + +To install an application simply run `mas install`: + + $ mas install 808809998 + ==> Downloading PaintCode 2 + ==> Installed PaintCode 2 + +`mas install` can also be used to install pending updates. + +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) + +## License + +Code is under the MIT license. + +[hb]: https://brew.sh +[ghreleases]: https://github.com/argon/mas/releases +