# Installation

## CLI

### Building from source

1. Clone the repository
```sh
git clone https://github.com/bloomberg/xcdiff.git
cd xcdiff
```

2. Build the project
```sh
swift build -c release
```

The binary will be created in `.build/x86_64-apple-macosx/release/xcdiff`. You can export this path to be able to use the executable from any location in your file system without specifying the full path.

```sh
export PATH="$PATH:$(swift build -c release --show-bin-path)"
```

### Homebrew

To install xcdiff using [Homebrew](https://brew.sh):

```sh
brew install xcdiff
```

### Mint

To run xcdiff using [Mint](https://github.com/yonaskolb/Mint):

```sh
mint run bloomberg/xcdiff xcdiff --help
```

To install xcdiff using [Mint](https://github.com/yonaskolb/Mint):

```sh
mint install bloomberg/xcdiff
```

Once installed, you can use xcdiff directly:

```sh
xcdiff --help
```

### Make

1. Clone the repository
```sh
git clone https://github.com/bloomberg/xcdiff.git
cd xcdiff
```

2. Build and copy to `/usr/local/bin`
```sh
make install
```

## Framework

### Swift Package Manager

Add xcdiff to your `Package.swift` file:

```swift
dependencies: [
    // ...
    .package(url: "https://github.com/bloomberg/xcdiff", .upToNextMinor(from: "0.12.0")),
]
```

Then add `XCDiffCore` as a dependency of your target:

```swift
// ...
.target(
    name: "MyTool",
    dependencies: ["XCDiffCore"]
)
```

See the [Framework](Framework.md) documentation for more details on how to leverage `XCDiffCore`.