Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix readme #79

Merged
merged 1 commit into from
Nov 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 38 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,54 @@

# xcresults

A command line tool to extract test summaries & screenshots from Xcode 11 XCResult files.
**xcresults** is a command-line tool designed to extract test summaries and screenshots from XCResult files generated by Xcode 11.

## Installation

Download latest version from github releases:
### For M1 CPU (arm64)

`wget https://github.com/eroshenkoam/xcresults/releases/latest/download/xcresults`
1. Download the executable file:
```bash
wget https://github.com/eroshenkoam/xcresults/releases/latest/download/xcresults
```
2. Make the file executable:
```bash
chmod +x xcresults
```

And make it executable:
### For Intel CPU (i386)

`chmod +x xcresults`
1. Download the appropriate executable file:
```bash
wget https://github.com/eroshenkoam/xcresults/releases/latest/download/xcresults-i386 -o xcresults
```
2. Make the file executable:
```bash
chmod +x xcresults
```

## Usage

`xcresults <command> <options>`

Below are a few examples of common commands. For further assistance, use the --help option on any command
The general command format:
```bash
xcresults <command> <options>
```
For further assistance on any command, use the `--help` option.

### Export to Allure2 results
### Exporting Results in Allure 2 Format

Single source:
`xcresults export /path/to/Test.xcresult -o /path/to/outputDirectory`
**For a single file:**
```bash
xcresults export /path/to/Test.xcresult -o /path/to/outputDirectory
```

Multiple sources:
`xcresults export /path/to/First.xcresult /path/to/Second.xcresult -o /path/to/outputDirectory`
**For multiple files:**
```bash
xcresults export /path/to/First.xcresult /path/to/Second.xcresult -o /path/to/outputDirectory
```

After that you can generate Allure report by following command:
After exporting, you can generate an Allure report with the following command:

`allure serve /path/to/outputDirectory`
```bash
allure serve /path/to/outputDirectory
```
Loading