How to Ignore UserInterfaceState.xcuserstate in Git for Xcode Projects

28 February 2025 Stephan Petzl Leave a comment Xcode

If you’re using Git for version control in your Xcode projects, you may encounter a situation where certain files, like UserInterfaceState.xcuserstate, refuse to be ignored despite being explicitly listed in your .gitignore file. This guide will walk you through the steps to solve this issue effectively.

Understanding the Issue

The UserInterfaceState.xcuserstate file is often automatically tracked by Git if it has been committed before being added to the .gitignore. As a result, Git continues to track changes to this file, which can be frustrating if you want to exclude it from version control.

Solution: Stop Tracking the File

To resolve this issue, you need to stop Git from tracking this file. Follow these simple steps:

1. Open your terminal.
2. Navigate to your project directory.
3. Remove the file from Git’s index using the following command, replacing [project] and [username] with your specific details:

   git rm --cached [project].xcodeproj/project.xcworkspace/xcuserdata/[username].xcuserdatad/UserInterfaceState.xcuserstate

4. Commit the changes to your repository:

   git commit -m "Removed file that shouldn't be tracked"

Alternative Approaches

If the file still appears in your untracked list, consider using git clean to clear untracked files. However, be cautious as this command can remove uncommitted changes. Always use git clean -f -d --dry-run first to preview the changes.

Practical Tip

For a more universal solution that applies across multiple environments (e.g., different Macs), you can remove the file for every user:

git rm --cached */UserInterfaceState.xcuserstate

Enhancing Your Workflow with Repeato

If you’re looking for ways to streamline your development workflow beyond version control, consider using tools like Repeato. As a no-code test automation tool, Repeato simplifies the process of creating, running, and maintaining automated tests for iOS, Android, and web apps. Its intuitive test recorder and fast execution capabilities can save you significant time and effort, allowing you to focus more on developing great software.

Check it out!

Like this article? there’s more where that came from!

• Resolving the “xcrun: error: invalid active developer path” Error on macOS
• Adding Existing Frameworks in Xcode 4: A Comprehensive Guide
• Disabling ARC for a Single File in Xcode: A Step-by-Step Guide
• Resolving the Xcode-Select Active Developer Directory Error
• Resolving the “Multiple Commands Produce” Error in Xcode 10