How do I copy the framework after building in Xcode using a Zsh script?

To copy a framework after building in Xcode using a Zsh script, you'll need to extract the built framework from Xcode's build directory and copy it to a desired location. Here’s a detailed breakdown:

1. Identify the Build Products Directory: Xcode typically places the build products in a directory inside the `DerivedData` folder. You’ll need to dynamically locate the built framework, as the exact path can vary based on your project settings.

2. Crafting the Zsh Script:

Here's a sample Zsh script that finds the built framework and copies it:

#!/bin/zsh

# Set the name of your framework
FRAMEWORK_NAME="YourFrameworkName"

# Set the destination directory where you want to copy the framework
DESTINATION_DIR="/path/to/your/destination"

# Find the DerivedData directory
DERIVED_DATA=$(xcodebuild -showBuildSettings | grep -m 1 'BUILD_DIR =' | sed 's/BUILD_DIR = //')

# Find the build directory which contains the .framework file.
FRAMEWORK_DIR=$(find "$DERIVED_DATA" -type d -name "${FRAMEWORK_NAME}.framework" 2>/dev/null)

# Check if framework was found.
if [[ -z "$FRAMEWORK_DIR" ]]; then
  echo "Error: Framework directory not found."
  exit 1
fi

# Construct the full path to the framework file
FRAMEWORK_PATH="$FRAMEWORK_DIR"

# Check if the framework file exists
if [[ ! -d "$FRAMEWORK_PATH" ]]; then
  echo "Error: Framework file not found: $FRAMEWORK_PATH"
  exit 1
fi

# Create the destination directory if it doesn't exist
mkdir -p "$DESTINATION_DIR"

# Copy the framework to the destination directory
cp -R "$FRAMEWORK_PATH" "$DESTINATION_DIR"

# Success message
echo "Framework copied to: $DESTINATION_DIR"


3. Explanation of the Script:

- `FRAMEWORK_NAME="YourFrameworkName"`: Replace `YourFrameworkName` with the actual name of your framework without the `.framework` extension.

- `DESTINATION_DIR="/path/to/your/destination"`: Set the absolute path where you want to copy the framework. For example, `/Users/YourUserName/Desktop/MyFramework`.

- `DERIVED_DATA=$(xcodebuild -showBuildSettings | grep -m 1 'BUILD_DIR =' | sed 's/BUILD_DIR = //')`: This line extracts the `BUILD_DIR` path from Xcode's build settings using `xcodebuild` command and `grep`.

- `FRAMEWORK_DIR=$(find "$DERIVED_DATA" -type d -name "${FRAMEWORK_NAME}.framework" 2>/dev/null)`: This command searches within the DerivedData directory to locate a directory named as your framework, and saves it to variable `FRAMEWORK_DIR`. It's important that your project has build the framework before running this script

- The script includes error checks to make sure the framework directory and the framework file are found and exit if not.

- `mkdir -p "$DESTINATION_DIR"`: Creates the destination directory if it does not exist.

- `cp -R "$FRAMEWORK_PATH" "$DESTINATION_DIR"`: Copies the framework directory to your desired location.

4. How to Use the Script:

- Save the script to a file, such as `copy_framework.zsh`.

- Make the script executable: `chmod +x copy_framework.zsh`.

- Run the script in your terminal: `./copy_framework.zsh`.

5. Integrating with Xcode:

- You can add this script as a "Run Script" build phase in your Xcode project, so it executes automatically after each build. To do this:

- Navigate to your project settings in Xcode.

- Select your target and go to the "Build Phases" tab.

- Click the "+" button at the top left and select "New Run Script Phase".

- Paste the script into the text area, adjust the paths accordingly and make sure the framework name is correct.

By following these steps, you can easily automate the copying of your framework after every build using a Zsh script within or outside of Xcode.

Learn more about this