Cameron Katri's Manual Page Server

xcrun altool command [...]

altool supports various usages depending on if you need to deliver an app for distribution via the App Store or to notarize a macOS app for distribution outside of the Mac App Store.

The --validate-app and --upload-package commands are used for App Store distribution.

The --notarize-app, --notarization-info and --notarization-history commands are used when notarizing macOS apps and retrieving information about apps previously notarized.

Most commands require authorization, but you can pass in your credentials via Environment Variables or the keychain. See the -p parameter below.

Two methods of authentication are available: username with password, and apiKey with apiIssuer.

-u, --username username

Username. Required to connect for most commands. You must also specify --password.

-p, --password password

Password. Required if --username is specified. If this argument is not supplied on the command line, it will be read from stdin. Alternatively to entering password in plaintext, the password may also be specified using a '@keychain:' or '@env:' prefix followed by a keychain password item name or environment variable name.

--apiKey api_key

apiKey. Required for JWT authentication (in lieu of username/password). This option will search the following directories in sequence for a private key file with the name of 'AuthKey_<api_key>.p8': './private_keys', '~/private_keys', '~/.private_keys', and '~/.appstoreconnect/private_keys'. Additionally, you can set the environment variable $API_PRIVATE_KEYS_DIR or a user default API_PRIVATE_KEYS_DIR to specify the directory where your AuthKey file is located.

--apiIssuer issuer_id

Issuer ID. Required if --apiKey is specified.

--store-password-in-keychain-item name_for_keychain_item -u username -p password

Stores the password password in the keychain item named name_for_keychain_item associated with the account username. If an item with that name and account already exists in the keychain, its password will be updated. Otherwise a new item is created with that name. You can use this keychain item with the -p option to mask your password with other commands. Optionally, you can specify a custom keychain file in which to store the password with the --keychain option. You can also use --sync to create a password that will sync with your iCloud account.

--keychain path_to_keychain_file

Used with --store-password-in-keychain and the @keychain: option for -p lets you specify the path to a keychain file in which to store or from which to read the password. Cannot be used with the --sync option.

--sync

Used with --store-password-in-keychain to allow the keychain item to sync with your iCloud account and other devices associated with the account. Cannot by used with the --keychain option.

-f, --file file

file specifies the path to the file to process.

-t, --type {macos | ios | appletvos}

Specify the platform of the file.

--transport {HTTPS | Signiant | Aspera | DAV}

Allows you to specify the protocol used when using --upload-package, --upload-app, or --notarize-app. You should only use this option when instructed by Apple.

-k, --throttle Kbps

Allows you to limit the upload speed to Kbps kilobits per second. If not specified, then the default limit is used.

--apple-id id

Specify the Apple ID of the app to be uploaded with --upload-package.

--bundle-id id

Specify the CFBundleIdentifier of the app to be uploaded with --upload-package.

--bundle-short-version-string string

Specify the CFBundleShortVersionString of the app to be uploaded with --upload-package.

--bundle-version id

Specify the CFBundleVersion of the app to be uploaded with --upload-package.

--product-id id

Specify the product ID of the hosted content package to be uploaded with --upload-hosted-content.

--sku sku

Specify the SKU of the hosting app associated with the hosted content to be uploaded with --upload-hosted-content.

--asc-provider provider_shortname

Required with --notarize-app and --notarization-history when a user account is associated with multiple providers and using username/password authentication. You can use the --list-providers command to retrieve the providers associated with your accounts. You may instead use --asc-public-id or --team-id.

--asc-public-id public_id

Required with --upload-package, --notarize-app, and --notarization-history when a user account is associated with multiple providers and using username/password authentication. You can use the --list-providers command to retrieve the providers associated with your account. You may instead use --asc-provider or --team-id.

--team-id wwdr_team_id

Required with --notarize-app and --notarization-history when a user account is associated with multiple providers and using username/password authentication. You can use the --list-providers command to retrieve the providers associated with your accounts. You may instead use --asc-provider or --asc-public-id.

--list-providers

Displays a list of the providers associated with your account along with short name, team id, and public id. This command is useful to determine what to use with the --asc-provider, --team-id, and --asc-public-id options. Authentication is required.

--output-format {xml | json | normal}

Specifies how the output is formatted. 'xml' and 'json' display the output in a structured format; 'normal' displays in an unstructured format (default).

--show-progress

Show progress during operation.

--verbose

Enable logging output. Show detailed information during operation.

-h, --help

Display the help page.

--upload-package file_path

Uploads the app archive for App Store submission. file_path, --type, --asc-public-id, --apple-id, --bundle-version, --bundle-short-version-string, --bundle-id, and Authentication are required.

-v, --validate-app

Preflights an app archive for App Store submission. Authentication and -f are required. Information about the archive is sent to the App Store for evaluation. This mode is useful for identifying issues which need to be corrected prior to uploading the entire archive. If successful, the app can be submitted with --upload-app. If the archive fails validation, a list of errors is returned which can be addressed prior to upload. Validation is not required prior to uploading.

--upload-app [DEPRECATED use --upload-package instead]

Uploads the given app archive for App Store submission. Authentication and -f are required. The app archive is submitted to the App Store. If successful, the app begins the process for being accepted into the App Store. If the upload is rejected, a list of errors is returned that need to be addressed before uploading again. It may be useful to use --validate-app first to catch common problems without uploading the entire package.

--upload-hosted-content file_path

Uploads the specified hosted content in-app purchase archive to the App Store. --sku, --type, --product-id, --asc-provider, and Authentication are required.

--list-apps

Returns a list of all app records associated with your account(s). Authentication is required.

--notarize-app

Uploads the given app package, dmg or zip file for notarization. Authentication, -f, and --primary-bundle-id are required. --asc-provider, --asc-public-id, or --team-id is required for an account associated with multiple providers. If successful, the UUID associated with the upload is returned. You can query the status of the upload with the --notarization-info command and specifying the UUID.

--notarization-info uuid

Returns the status and log file URL of a package previously uploaded for notarization with the specified uuid. Authentication is required. The log file can be retrieved with 'curl log_file_url'.

--notarization-history page

Returns a list of all uploads submitted for notarization. page specifies a range of entries where 0 returns the most recent number of entries. A new page value will be returned which can be used as the page value to the next use of --notarization-history and so forth until no more items are returned. Authentication is required. --asc-provider, --asc-public-id, or --team-id is required for an account associated with multiple providers.

--primary-bundle-id bundle_id

Used with --notarize-app to uniquely identify a package.

Uploads the package for App Store submission. The result is either success or a list of errors that need to be addressed before the upload is accepted.

Preflights the app for App Store submission. The result is either success or a list of errors that need to be addressed prior to upload.

Uploads the app for App Store submission. The result is either success or a list of errors that need to be addressed before the upload is accepted.

Returns a list of all app records associated with your account.

Uploads the macOS package to be notarized and identified with bundle_id. A successful upload returns a uuid assigned to that upload.

Returns the status of a package that was previously submitted with --notarize-app which returned uuid.

Returns a list of packages that were previously submitted with --notarize-app along with a new page value that can be used in a subsequent call to --notarization-history to list additional items.