gitwrap 0.3.5

GitWrap is a simple wrapper around `git` command
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


# [GitWrap](https://crates.io/crates/gitwrap)

[![Build Status](https://github.com/japiber/gitwrap/actions/workflows/rust.yml/badge.svg)](https://github.com/japiber/gitwrap/actions/workflows/rust.yml) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/xuri/rust-reportcard/blob/master/LICENSE)
[![](https://img.shields.io/crates/v/gitwrap.svg)](https://crates.io/crates/gitwrap)  

GitWrap is a simple wrapper around `git` command.

The purpose of this library is to provide a controlled and reliable method of accessing the git commands in the simplest possible way.

## Credits

This project is inspired and based on [Go Git Cmd Wrapper](https://github.com/ldez/go-git-cmd-wrapper)

## License

The code is licensed under the permissive Apache v2.0 licence. This means you can do what you like with the software, as long as you include the required notices. [Read this](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)) for a summary.

## Install

```
cargo install gitwrap
```

Running the above command will globally install the gitwrap binary.
Install as library

Run the following Cargo command in your project directory:
```
cargo add gitwrap
```

Or add the following line to your Cargo.toml:
```
gitwrap = "0.3.5"
```

## Usage

Here are some examples of use (work in progress)

### 1. cloning a remote repo

```rust
use gitwrap::{clone, CommandOption};
use gitwrap::options::clone;


    fn initialize(repo_url: &str, repo_path: &str, insecure: bool) -> Result<(), RepoErr> {
        let mut opt: Vec<CommandOption> = Vec::new();
        opt.push(clone::repository(repo_url));
        opt.push(clone::directory(repo_path));
        if let Some(auth_header) = build_auth_header() {
            opt.push(clone::config("http.extraHeader", &auth_header))
        }
        if insecure {
            opt.push(clone::config("http.sslVerify", "false"))
        }

        match clone(opt) {
            Ok(_) => Ok(()),
            Err(e) => Err(RepoErr::InitializeError(Box::new(e))),
        }
    }

```