xcspec

A tool to extract and format information of iOS, macOS, and Apple-like frameworks & libraries. It provides details about the framework, including its name, version, supported platforms, architectures, Swift version, and more.

Features
Installation
Usage
Example Output
- JSON
- YAML
Contributing
Author

Features

Extracts framework name and version
Checks if the framework is mergeable
Extracts Swift compiler and Swift version details
Provides details about available libraries within the framework
Provides information about Privacy Manifests (if PrivacyInfo.xcprivacy file exists)

Installation

You can install xcspec using Homebrew:

brew tap eaceto/tools
brew install eaceto/tools/xcspec

Usage

After installation, you can use the xcspec command to inspect a zipped framework file.

Basic Usage

xcspec path_to_xcframework.zip
xcspec -f path_to_xcframework.zip
xcspec --file path_to_xcframework.zip

Output formats

By default, the output is in JSON format. You can also export the result as YAML using the -t or --output-format flag.

JSON Output (default)

xcspec --file path_to_xcframework.zip
xcspec --file path_to_xcframework.zip -t json
xcspec --file path_to_xcframework.zip --output-format json

YAML Output

xcspec --file path_to_xcframework.zip -t yaml
xcspec --file path_to_xcframework.zip --output-format yaml

Output to a File

Write the output to a file can be addressed directly from the tool by defining an output (-o / --output) flag.

xcspec --file path_to_xcframework.zip -t yaml -o info.yaml
xcspec --file path_to_xcframework.zip -o info.json
xcspec --file path_to_xcframework.zip -output info.json

Example Output

JSON

{
  "framework_name": "TestFramework",
  "is_mergeable": true,
  "swift_compiler_info": "Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)",
  "swift_compiler_version": "5.10.0.13",
  "swift_version": "5",
  "library_evolution_enabled": true,
  "built_for_distribution": true,
  "available_libraries": [
    {
      "binary_path": "TestFramework.framework/TestFramework",
      "library_identifier": "ios-arm64_x86_64-simulator",
      "library_path": "TestFramework.framework",
      "marketing_version": "1.0",
      "mergeable_metadata": true,
      "supported_architectures": [
        "arm64",
        "x86_64"
      ],
      "supported_platform": "ios",
      "supported_platform_variant": "simulator",
      "size": "170.85 KB",
      "dependencies": [
        "AVRouting",
        "Accounts",
        "ContactsUI",
        "Foundation",
        "Swift",
        "_Concurrency",
        "_StringProcessing",
        "_SwiftConcurrencyShims"
      ],
      "privacy_info": {
        "present": true,
        "tracking": true,
        "tracking_domains": [
          "domain1.com",
          "domain2.com"
        ],
        "collected_data_types": [
          {
            "data_type": "NSPrivacyCollectedDataTypeUserID",
            "linked_to_user": true,
            "tracking": false,
            "purposes": [
              "NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising",
              "NSPrivacyCollectedDataTypePurposeDeveloperAdvertising",
              "NSPrivacyCollectedDataTypePurposeAnalytics",
              "NSPrivacyCollectedDataTypePurposeProductPersonalization"
            ]
          },
          {
            "data_type": "NSPrivacyCollectedDataTypeDeviceID",
            "linked_to_user": true,
            "tracking": true,
            "purposes": [
              "",
              "NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising",
              "NSPrivacyCollectedDataTypePurposeDeveloperAdvertising",
              "NSPrivacyCollectedDataTypePurposeAnalytics",
              "NSPrivacyCollectedDataTypePurposeProductPersonalization"
            ]
          },
          {
            "data_type": "NSPrivacyCollectedDataTypeProductInteraction",
            "linked_to_user": true,
            "tracking": true,
            "purposes": [
              "NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising",
              "NSPrivacyCollectedDataTypePurposeDeveloperAdvertising",
              "NSPrivacyCollectedDataTypePurposeAnalytics",
              "NSPrivacyCollectedDataTypePurposeProductPersonalization",
              "NSPrivacyCollectedDataTypePurposeAppFunctionality"
            ]
          },
          {
            "data_type": "NSPrivacyCollectedDataTypeAdvertisingData",
            "linked_to_user": true,
            "tracking": true,
            "purposes": [
              "NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising",
              "NSPrivacyCollectedDataTypePurposeDeveloperAdvertising"
            ]
          },
          {
            "data_type": "NSPrivacyCollectedDataTypeOtherUsageData",
            "linked_to_user": true,
            "tracking": true,
            "purposes": [
              "NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising",
              "NSPrivacyCollectedDataTypePurposeDeveloperAdvertising",
              "NSPrivacyCollectedDataTypePurposeAnalytics",
              "NSPrivacyCollectedDataTypePurposeProductPersonalization",
              "NSPrivacyCollectedDataTypePurposeAppFunctionality"
            ]
          },
          {
            "data_type": "NSPrivacyCollectedDataTypeCrashData",
            "linked_to_user": true,
            "tracking": false,
            "purposes": [
              "NSPrivacyCollectedDataTypePurposeAnalytics",
              "NSPrivacyCollectedDataTypePurposeAppFunctionality"
            ]
          },
          {
            "data_type": "NSPrivacyCollectedDataTypeOtherDiagnosticData",
            "linked_to_user": true,
            "tracking": true,
            "purposes": [
              "NSPrivacyCollectedDataTypePurposeAnalytics",
              "NSPrivacyCollectedDataTypePurposeAppFunctionality"
            ]
          }
        ],
        "accessed_api_types": [
          {
            "api": "NSPrivacyAccessedAPICategoryUserDefaults",
            "reasons": [
              "1C8F.1"
            ]
          },
          {
            "api": "NSPrivacyAccessedAPICategoryFileTimestamp",
            "reasons": [
              "C617.1"
            ]
          },
          {
            "api": "NSPrivacyAccessedAPICategoryUserDefaults",
            "reasons": [
              "CA92.1"
            ]
          },
          {
            "api": "NSPrivacyAccessedAPICategorySystemBootTime",
            "reasons": [
              "35F9.1"
            ]
          },
          {
            "api": "NSPrivacyAccessedAPICategoryDiskSpace",
            "reasons": [
              "E174.1"
            ]
          }
        ]
      }
    }
  ]
}

YAML

framework_name: TestFramework
is_mergeable: true
swift_compiler_info: Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)
swift_compiler_version: 5.10.0.13
swift_version: '5'
library_evolution_enabled: true
built_for_distribution: true
available_libraries:
  - binary_path: TestFramework.framework/TestFramework
    library_identifier: ios-arm64_x86_64-simulator
    library_path: TestFramework.framework
    marketing_version: '1.0'
    mergeable_metadata: true
    supported_architectures:
      - arm64
      - x86_64
    supported_platform: ios
    supported_platform_variant: simulator
    size: 170.85 KB
    dependencies:
      - AVRouting
      - Accounts
      - ContactsUI
      - Foundation
      - Swift
      - _Concurrency
      - _StringProcessing
      - _SwiftConcurrencyShims
    privacy_info:
      present: true
      tracking: true
      tracking_domains:
        - domain1.com
        - domain2.com
      collected_data_types:
        - data_type: NSPrivacyCollectedDataTypeUserID
          linked_to_user: true
          tracking: false
          purposes:
            - NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising
            - NSPrivacyCollectedDataTypePurposeDeveloperAdvertising
            - NSPrivacyCollectedDataTypePurposeAnalytics
            - NSPrivacyCollectedDataTypePurposeProductPersonalization
        - data_type: NSPrivacyCollectedDataTypeDeviceID
          linked_to_user: true
          tracking: true
          purposes:
            - ''
            - NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising
            - NSPrivacyCollectedDataTypePurposeDeveloperAdvertising
            - NSPrivacyCollectedDataTypePurposeAnalytics
            - NSPrivacyCollectedDataTypePurposeProductPersonalization
        - data_type: NSPrivacyCollectedDataTypeProductInteraction
          linked_to_user: true
          tracking: true
          purposes:
            - NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising
            - NSPrivacyCollectedDataTypePurposeDeveloperAdvertising
            - NSPrivacyCollectedDataTypePurposeAnalytics
            - NSPrivacyCollectedDataTypePurposeProductPersonalization
            - NSPrivacyCollectedDataTypePurposeAppFunctionality
        - data_type: NSPrivacyCollectedDataTypeAdvertisingData
          linked_to_user: true
          tracking: true
          purposes:
            - NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising
            - NSPrivacyCollectedDataTypePurposeDeveloperAdvertising
        - data_type: NSPrivacyCollectedDataTypeOtherUsageData
          linked_to_user: true
          tracking: true
          purposes:
            - NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising
            - NSPrivacyCollectedDataTypePurposeDeveloperAdvertising
            - NSPrivacyCollectedDataTypePurposeAnalytics
            - NSPrivacyCollectedDataTypePurposeProductPersonalization
            - NSPrivacyCollectedDataTypePurposeAppFunctionality
        - data_type: NSPrivacyCollectedDataTypeCrashData
          linked_to_user: true
          tracking: false
          purposes:
            - NSPrivacyCollectedDataTypePurposeAnalytics
            - NSPrivacyCollectedDataTypePurposeAppFunctionality
        - data_type: NSPrivacyCollectedDataTypeOtherDiagnosticData
          linked_to_user: true
          tracking: true
          purposes:
            - NSPrivacyCollectedDataTypePurposeAnalytics
            - NSPrivacyCollectedDataTypePurposeAppFunctionality
      accessed_api_types:
        - api: NSPrivacyAccessedAPICategoryUserDefaults
          reasons:
            - 1C8F.1
        - api: NSPrivacyAccessedAPICategoryFileTimestamp
          reasons:
            - C617.1
        - api: NSPrivacyAccessedAPICategoryUserDefaults
          reasons:
            - CA92.1
        - api: NSPrivacyAccessedAPICategorySystemBootTime
          reasons:
            - 35F9.1
        - api: NSPrivacyAccessedAPICategoryDiskSpace
          reasons:
            - E174.1

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or bug fixes.

Author

Ezequiel (Kimi) Aceto

eaceto/xcspec