binswap-github 0.1.3

Download and swap binaries from GitHub
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

[![Crates.io](https://img.shields.io/crates/v/binswap-github.svg)](https://crates.io/crates/binswap-github)
[![Workflow Status](https://github.com/oeb25/binswap/workflows/main/badge.svg)](https://github.com/oeb25/binswap/actions?query=workflow%3A%22main%22)

# binswap-github

Download and swap binaries from GitHub

## Usage

`binswap` uses the same infrastructure as
[`cargo-binstall`](https://github.com/cargo-bins/cargo-binstall) to
determine where the latest binaries are stored. `binswap-github` is the
backend to do this for GitHub specifically. It uses the GitHub releases to
download binaries for a supported target, and then downloads them to a
specified location, or optionally swaps them with the currently executed
binary.

This is particularly useful if you distribute binaries outside of package
managers or in environments where the users are not expected to have Rust
nor installed. With crate, you can bundle the updating mechanism into the
distributed binary.

## Example

The following example downloads the latest release [`ripgrep` from
GitHub](https://github.com/BurntSushi/ripgrep/releases), and swaps it with
the currently executed binary. `.dry_run(true)` is added here to simulate
the execution, but not perform the update.

```rust
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    binswap_github::builder()
        .repo_author("BurntSushi")
        .repo_name("ripgrep")
        .asset_name("ripgrep")
        .bin_name("rg")
        .dry_run(true)
        .build()?
        .fetch_and_write_in_place_of_current_exec()
        .await?;

    Ok(())
}
```

The following does the same, but just writes the resulting binary to a new
file.

```rust
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    binswap_github::builder()
        .repo_author("BurntSushi")
        .repo_name("ripgrep")
        .asset_name("ripgrep")
        .bin_name("rg")
        .dry_run(true)
        .build()?
        .fetch_and_write_to("./rg")
        .await?;

    Ok(())
}
```

## License

Licensed under either of

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

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.