https://github.com/cpisciotta/xcbeautify
A little beautifier tool for xcodebuild
https://github.com/cpisciotta/xcbeautify
beautifier prettifier swift swift-5 swift-package-manager xcode xcodebuild xcpretty
Last synced: 6 months ago
JSON representation
A little beautifier tool for xcodebuild
- Host: GitHub
- URL: https://github.com/cpisciotta/xcbeautify
- Owner: cpisciotta
- License: mit
- Created: 2018-09-10T16:13:12.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T01:47:50.000Z (about 1 year ago)
- Last Synced: 2025-05-08T09:03:17.244Z (about 1 year ago)
- Topics: beautifier, prettifier, swift, swift-5, swift-package-manager, xcode, xcodebuild, xcpretty
- Language: Swift
- Homepage:
- Size: 5.48 MB
- Stars: 1,118
- Watchers: 28
- Forks: 78
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- fucking-awesome-swift - xcbeautify - Little beautifier tool for xcodebuild. (Misc / Vim)
- awesome-swift - xcbeautify - Little beautifier tool for xcodebuild. (Misc / Vim)
- awesome-swift - xcbeautify - Make xcodebuild output easier to read. (Developer Tools)
README
# xcbeautify
[](https://swiftpackageindex.com/cpisciotta/xcbeautify)
[](https://github.com/cpisciotta/xcbeautify/actions/workflows/ci.yml)
[](https://github.com/cpisciotta/xcbeautify/releases/latest)
[](LICENSE.md)
**`xcbeautify` is a little beautifier tool for `xcodebuild`.**
A faster alternative to `xcpretty` written in Swift.
## Features
- [x] Human-friendly and colored output.
- [x] Supports the new build system's output.
- [x] Supports Xcode's parallel testing output.
- [x] Supports formatting Swift Package Manager output.
- [x] Supports generating JUnit reports.
- [x] Supports macOS & Linux.
- [x] Written in Swift: `xcbeautify` compiles to a static binary which you can
bring anywhere. This also means less Ruby-dependant in your development
environment and CI.
## Installation
### Homebrew
```bash
brew install xcbeautify
```
### [Mint](https://github.com/yonaskolb/mint)
```bash
mint install cpisciotta/xcbeautify
```
### Build from source
```bash
git clone https://github.com/cpisciotta/xcbeautify.git
cd xcbeautify
make install
```
## Usage
```bash
xcodebuild [flags] | xcbeautify
```
If you want `xcbeautify` to exit with the same status code as `xcodebuild`
(e.g. on a CI):
```bash
set -o pipefail && xcodebuild [flags] | xcbeautify
```
For parallel and concurrent destination testing, it helps to use unbuffered I/O for _stdout_ and to redirect _stderr_ to _stdout_.
```bash
NSUnbufferedIO=YES xcodebuild [flags] 2>&1 | xcbeautify
```
```bash
swift test [flags] 2>&1 | xcbeautify
```
### GitHub Actions
|  |
|:--:|
| *GitHub Actions Summary* |
|  |
|:--:|
| *GitHub Actions Comment* |
`xcbeautify` features an integrated GitHub Actions renderer that harnesses [workflow commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions) to highlight warnings, errors, and results directly within the GitHub user interface. To utilize this function, simply run `xcbeautify` and add the `--renderer github-actions` flag during execution:
```
set -o pipefail && xcodebuild [flags] | xcbeautify --renderer github-actions
```
### TeamCity
`xcbeautify` features an integrated TeamCity renderer that harnesses [service messages](https://www.jetbrains.com/help/teamcity/service-messages.html) to highlight warnings, errors, and results directly within the TeamCity user interface. To utilize this function, simply run `xcbeautify` and add the `--renderer teamcity` flag during execution:
```
set -o pipefail && xcodebuild [flags] | xcbeautify --renderer teamcity
```
### Azure DevOps Pipeline
`xcbeautify` features an integrated Azure DevOps Pipeline renderer that harnesses [logging commands](https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) to highlight warnings, errors and results directly within the Azure DevOps Pipeline user interface. To utilize this function, simply run `xcbeautify` and add the `--renderer azure-devops-pipelines` flag during execution:
```
set -o pipefail && xcodebuild [flags] | xcbeautify --renderer azure-devops-pipelines
```
## Development
Generate Xcode project:
```sh
make xcode
```
Release a new version, e.g. `x.y.z`:
```bash
make release version=x.y.z
```
## Contributing
Please send a PR!