# Belay [![crates.io badge](https://img.shields.io/crates/v/belay.svg)](https://crates.io/crates/belay) [![github action badge](https://github.com/JoshMcguigan/belay/workflows/Rust/badge.svg)](https://github.com/JoshMcguigan/belay/actions)

Belay makes it easy to run your CI checks locally, so you can `git push` with confidence.

[![asciicast](https://asciinema.org/a/okeJVtb2YJFHneYnS9ZnObBmK.svg)](https://asciinema.org/a/okeJVtb2YJFHneYnS9ZnObBmK)

### Usage

In a git repo with either Gitlab or GitHub CI configured, running `belay` with no arguments will parse your CI configuration and run your CI scripts on your local machine.

```bash
$ belay
Checking 'build':
Success!
Checking 'test':
... test output
..
.
Success!
```

Belay can also setup pre-commit or pre-push git hooks in your repo.

```bash
# to create a pre-push hook
$ belay hook push

# to create a pre-commit hook
$ belay hook commit
```

### Install

```bash
cargo install --force belay
```

### Configuration

Belay creates a configuration file in the following location:

* Linux:   /home/alice/.config/belay/config.yml
* Windows: C:\Users\Alice\AppData\Roaming\cargo\belay\config.yml
* macOS:   /Users/Alice/Library/Preferences/com.cargo.belay/config.yml

The keys of the config file are described below:

* command\_blacklist
  * array of strings
  * belay will skip CI tasks which contain any string in the command blacklist

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.