These documents demonstrate how to use the cktool command-line interface to perform various CloudKit container management, data manipulation, and querying operations.

• Xcode 13.0 or later.
• CloudKit Management and User Tokens (obtainable in the Tokens section of CloudKit Console)
• An Apple Developer Program membership is needed if you wish to create your own CloudKit container.

Ensure that cktool is available as part of your Xcode installation. You can check by running the following in your terminal:

$ xcrun cktool help

If you see an error that xcrun is unable to find the utility, update Xcode to a version later than 13.0 and check the active Xcode installation with:

$ xcode-select -p

You can change your currently selected Xcode install with, e.g.:

$ sudo xcode-select -s /Applications/Xcode.app/Contents/Developer

To authenticate with CloudKit you need to provide your CloudKit Management or User Token to cktool. Management operations, such as resetting schema, require a Management Token, while data manipulation and querying operations require a User Token. You can use the CLOUDKIT_MANAGEMENT_TOKEN and CLOUDKIT_USER_TOKEN environment variables to provide these, or using xcrun cktool save-token, following the prompts to save your tokens to the Keychain.

• Schema Management
• get-teams
• export-schema
• import-schema
• validate-schema
• reset-schema

• Record Operations
• create-record
• query-records
• delete-record
• delete-records