xcbeautify
A Swift-based formatter that beautifies xcodebuild output with human-friendly, colored logs and CI integration.
What is xcbeautify?
xcbeautify is a command-line tool that formats and beautifies the output of xcodebuild, Apple's build system for Xcode projects. It transforms raw, hard-to-read build and test logs into clean, colorized, and structured output, making it easier for developers to identify issues and monitor progress. It solves the problem of noisy xcodebuild output by providing a human-friendly alternative that integrates seamlessly into local development and CI/CD pipelines.
iOS and macOS developers who regularly use xcodebuild for building, testing, and archiving projects, especially those working in team environments or CI/CD setups where log clarity is critical.
Developers choose xcbeautify for its speed, being a Swift-native alternative to xcpretty, and its out-of-the-box integrations with CI platforms like GitHub Actions, TeamCity, and Azure DevOps. Its static binary distribution eliminates Ruby dependencies and works consistently across macOS and Linux.
Overview
An xcodebuild formatter
Use Cases
Best For
- Cleaning up xcodebuild logs in terminal for local development
- Integrating formatted build output into GitHub Actions workflows
- Generating JUnit test reports from Xcode test runs
- Improving log readability in TeamCity or Azure DevOps CI pipelines
- Parsing Swift Package Manager test output with colorization
- Replacing xcpretty with a faster, Swift-based formatter
Not Ideal For
- Projects not using xcodebuild or Swift Package Manager for builds
- Teams that rely on raw, unfiltered log output for deep debugging
- Environments with established Ruby-based toolchains like xcpretty that would require rewrites
Pros & Cons
Pros
Compiled as a static Swift binary, it runs quickly without Ruby dependencies, ensuring portability across macOS and Linux, as highlighted in the README for reduced environment complexity.
Includes built-in renderers for GitHub Actions, TeamCity, and Azure DevOps, directly integrating warnings and errors into CI interfaces via workflow commands, as shown with examples in the README.
Fully compatible with Xcode's new build system and parallel testing output, handling complex formats seamlessly, which is essential for contemporary iOS/macOS development workflows.
Produces JUnit XML reports from test runs, facilitating automated test result analysis in CI systems, a feature specifically listed in the README for enhanced reporting.
Cons
Only works with xcodebuild and Swift Package Manager output, making it irrelevant for other build tools or programming languages, which narrows its utility strictly to Apple ecosystems.
Requires precise piping and environment variables (e.g., `set -o pipefail`, `NSUnbufferedIO=YES`) for optimal use, as noted in the README, which can be error-prone and cumbersome in scripting.
Focuses on basic beautification without extensive plugin support or configuration options, lacking the extensibility found in alternatives like xcpretty with its larger plugin ecosystem.
Open Source Alternative To
xcbeautify is an open-source alternative to the following products:
Frequently Asked Questions
Related Projects
SwiftGenThe Swift code generator for your assets, storyboards, Localizable.strings, … — Get rid of all String-based APIs!
XcodeGenA Swift command line tool for generating your Xcode project
TuistYour platform team, as a service
xcproj📝 Read, update and write your Xcode projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.