ipatool README

The project's README from github.com/majd/ipatool. As one markdown file: README.md.

Release License Sponsor

ipatool is a command line tool that allows you to search for iOS, iPadOS, tvOS, visionOS, and macOS apps on the App Store, and download .ipa or macOS .pkg app packages.

Demo

Requirements

Installation

Linux and Windows

You can grab the latest version of ipatool from GitHub releases.

macOS

You can install ipatool using Homebrew.

$ brew install ipatool

Usage

To get started, run the following command.

$ ipatool --help
A cli tool for interacting with Apple's ipa files

Usage:
  ipatool [command]

Available Commands:
  auth                 Authenticate with the App Store
  completion           Generate the autocompletion script for the specified shell
  download             Download iOS, iPadOS, tvOS, visionOS, and macOS app packages from the App Store
  get-version-metadata Retrieves the metadata for a specific version of an app
  help                 Help about any command
  list-purchases       List apps owned by the authenticated App Store account
  list-versions        List the available versions of an App Store app
  purchase             Obtain a license for the app from the App Store
  search               Search for iOS, iPadOS, tvOS, visionOS, and macOS apps available on the App Store

Flags:
      --format format                sets output format for command; can be 'text', 'json' (default text)
  -h, --help                         help for ipatool
      --keychain-passphrase string   passphrase for unlocking keychain
      --non-interactive              run in non-interactive session
      --verbose                      enables verbose logs
  -v, --version                      version for ipatool

Use "ipatool [command] --help" for more information about a command.

Note: the tool runs in interactive mode by default. Use the --non-interactive flag if running in an automated environment.

Compiling

The tool can be compiled using the Go toolchain.

$ go build -o ipatool

Unit tests can be executed with the following commands.

$ go generate ./...
$ go test -v ./...

License

ipatool is released under the MIT license.

ipatool (majd/ipatool)

Searching Database…

11.7K ·GitHub
Ipatool
What is this?ipatool is a command-line tool for searching the App Store and downloading .ipa packages for iOS, iPadOS, tvOS and visionOS apps, as well as .pkg packages for macOS apps.
Is this a GUI app or a command-line tool?It's a command-line tool that runs in interactive mode by default, with a non-interactive flag available for scripting.
Do I need an Apple ID to use it?Yes, you need an Apple Account that is already set up and configured to use the App Store.
Does it work out of the box in automated scripts or CI?By default it runs interactively, so for automated environments you need to pass the --non-interactive flag explicitly.
Which operating systems can run ipatool?It supports macOS, Linux, Windows, and iOS as host operating systems.
What file formats does it actually produce?It downloads .ipa packages for iOS/iPadOS/tvOS/visionOS apps and .pkg packages for macOS apps.
What's this tool typically used for?Given its security and reverse-engineering focus (per its GitHub topics), it's commonly used by researchers to pull App Store binaries for analysis rather than for casual app installs.
Is it a standalone binary or does it depend on other installed tools?It's distributed as a standalone binary via GitHub releases or Homebrew, with no other runtime dependencies mentioned beyond a configured Apple Account.
What are similar projects?omarchy-apple-dev, cobra, CocoaPods, rea, httpx, binwalk, App-Store-Connect-CLI, mimic
Which topics is it in?appstore, visionos, golang-library, ios-app, downloader, apple, app, reverse-engineering, cybersecurity, golang, swift, security-tools
Creator
majd
Size
1.6 MB
Stars
11.7K
Updated
CommitOct 15Releasev2.7.0Oct 09
Age
5y
Commits · 90 Days