{"id":13496587,"url":"https://github.com/xcpretty/xcpretty","last_synced_at":"2025-05-13T20:16:12.456Z","repository":{"id":12383228,"uuid":"15035229","full_name":"xcpretty/xcpretty","owner":"xcpretty","description":"Flexible and fast xcodebuild formatter","archived":false,"fork":false,"pushed_at":"2025-03-26T19:42:24.000Z","size":3830,"stargazers_count":3970,"open_issues_count":118,"forks_count":290,"subscribers_count":61,"default_branch":"master","last_synced_at":"2025-05-13T01:53:06.776Z","etag":null,"topics":["ci","continuous-integration","ios"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xcpretty.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-12-09T01:31:14.000Z","updated_at":"2025-05-09T09:20:59.000Z","dependencies_parsed_at":"2024-02-26T01:48:58.216Z","dependency_job_id":"529e50c3-c027-4f7a-bf22-dc9bd5bf76c1","html_url":"https://github.com/xcpretty/xcpretty","commit_stats":{"total_commits":538,"total_committers":44,"mean_commits":"12.227272727272727","dds":0.6133828996282528,"last_synced_commit":"456604313faf4a1de6a4e687c2412eaf6097c4b0"},"previous_names":["supermarin/xcpretty","mneorr/xcpretty"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcpretty%2Fxcpretty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcpretty%2Fxcpretty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcpretty%2Fxcpretty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcpretty%2Fxcpretty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xcpretty","download_url":"https://codeload.github.com/xcpretty/xcpretty/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253942573,"owners_count":21988084,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","continuous-integration","ios"],"created_at":"2024-07-31T19:01:52.243Z","updated_at":"2025-05-13T20:16:12.439Z","avatar_url":"https://github.com/xcpretty.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"![logo](http://i.imgur.com/i2fElxx.png)\n\n__`xcpretty` is a fast and flexible formatter for `xcodebuild`__.\u003cbr/\u003e\nIt does one thing, and it should do it well.\n\n[![Gem version](http://img.shields.io/gem/v/xcpretty.svg)](http://rubygems.org/gems/xcpretty)\n[![Build Status](https://travis-ci.org/supermarin/xcpretty.svg?branch=master)](https://travis-ci.org/supermarin/xcpretty)\n[![Code Climate](http://img.shields.io/codeclimate/github/supermarin/xcpretty.svg)](https://codeclimate.com/github/supermarin/xcpretty)\n[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)\n\n## Installation\n``` bash\n$ gem install xcpretty\n```\n\n## Usage\n``` bash\n$ xcodebuild [flags] | xcpretty\n```\n`xcpretty` is designed to be piped with `xcodebuild` and thus keeping 100%\ncompatibility with it. It's even a bit faster than `xcodebuild` itself, since\nit saves your terminal some prints.\n\n__Important:__ If you're running `xcpretty` on a CI like Travis or Jenkins, you\nmay want to exit with same status code as `xcodebuild`.\nCI systems usually use status codes to determine if the build has failed.\n\n``` bash\n$ set -o pipefail \u0026\u0026 xcodebuild [flags] | xcpretty\n#\n# OR\n#\n$ xcodebuild [flags] | xcpretty \u0026\u0026 exit ${PIPESTATUS[0]}\n```\n\n## Raw xcodebuild output\nYou might want to use `xcpretty` together with `tee` to store the raw log in a\nfile, and get the pretty output in the terminal. This might be useful if you\nwant to inspect a failure in detail and aren't able to tell from the pretty\noutput.\n\nHere's a way of doing it:\n``` bash\n$ xcodebuild [flags] | tee xcodebuild.log | xcpretty\n```\n\n## Formats\n\n- `--simple`, `-s` (default)\n![xcpretty --simple](http://i.imgur.com/LdmozBS.gif)\n\n- `--test`, `-t` (RSpec style)\n![xcpretty alpha](http://i.imgur.com/VeTQQub.gif)\n- `--tap` ([Test Anything Protocol](http://testanything.org)-compatible output)\n- `--knock`, `-k` (a [simplified version](https://github.com/chneukirchen/knock) of the Test Anything Protocol)\n\n## ANSI / UTF-8\n\n- `--[no-]color`: Show build icons in color. (you can add it to `--simple` or `--test` format).\n  Defaults to auto-detecting color availability.\n- `--[no-]utf`: Use unicode characters in build output or only ASCII.\n  Defaults to auto-detecting the current locale.\n\n## Reporters\n\n- `--report junit`, `-r junit`: Creates a JUnit-style XML report at `build/reports/junit.xml`, compatible with Jenkins and TeamCity CI.\n\n- `--report html`, `-r html`: Creates a simple HTML report at `build/reports/tests.html`.\n![xcpretty html](http://i.imgur.com/0Rnux3v.gif)\n\n- `--report json-compilation-database`, `-r json-compilation-database`: Creates a [JSON compilation database](http://clang.llvm.org/docs/JSONCompilationDatabase.html) at `build/reports/compilation_db.json`. This is a format to replay single compilations independently of the build system.\n\nWriting a report to a custom path can be specified using `--output PATH`.\n\n## Extensions\n\n`xcpretty` supports custom formatters through the use of the\n`--formatter` flag, which takes a path to a file as an argument. The\nfile must contain a Ruby subclass of `XCPretty::Formatter`, and\nreturn that class at the end of the file. The class\ncan override the `format_*` methods to hook into output parsing\nevents.\n\n### Known extensions\n\n* [xcpretty-travis-formatter](https://github.com/kattrali/xcpretty-travis-formatter): support for cleaner output in TravisCI using code folding\n\nThe recommended format is a gem containing the formatter and named\nwith an `xcpretty-` prefix, for easier discovery.\n\n\n## Team\n\n- [Marin Usalj](http://github.com/supermarin) http://supermar.in\n- [Delisa Mason](http://github.com/kattrali) http://delisa.me\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxcpretty%2Fxcpretty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxcpretty%2Fxcpretty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxcpretty%2Fxcpretty/lists"}