ios 0.2.0

Light-weight CLI tool to extract iOS backup
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# iOS-Backup

[![made-with-rust][rust-logo]][rust-src-page]

[![crates.io][crates-logo]][crate]

[![build][gh-logo]][build]
[![none-shall-pass][nsp-logo]][nsp]

#### Summary
[`ios`][repo] is a lightweight CLI tool to extract iPhone backups.

### Installation

```shell
cargo add ios
```

### Usage

**Embedded**
```rust
use ios;

fn main() {
    match ios::retriever() {
        Ok(res) => {
            println!("{}", res);
        }
        Err(err) => {
            println!("{}", err);
        }
    };
}
```

**CLI**
```
./ios
```

`ios` crate takes the following arguments

- `--version` - Print project version.
- `--list` - List the available backups.
- `--debug` - Enable debug level logging.
- `--all` - Extract all available backups.
- `--serial` - Initiate backup extraction for given serial number(s).
- `--organize` - Organize the extracted files by `type`, `size`, `root`, and `auto`.
- `--workers` | `--threads` - Numbers of workers (threads) to spin up for extraction.
- `--backup-dir` | `--source` - Custom path for the backup. Defaults to OS specific path.
- `--output-dir` | `--destination` - Destination directory. Defaults to 'extracted' in current path.

<br>

<details>
<summary><strong>Download OS specific Executable</strong></summary>

###### macOS (x86)
```shell
curl -o ios-Darwin-x86_64.tar.gz -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/ios/releases/latest/download/ios-Darwin-x86_64.tar.gz"
```

###### macOS (ARM)
```shell
curl -o ios-Darwin-arm64.tar.gz -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/ios/releases/latest/download/ios-Darwin-arm64.tar.gz"
```

###### Linux
```shell
curl -o ios-Linux-x86_64.tar.gz -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/ios/releases/latest/download/ios-Linux-x86_64.tar.gz"
```

###### Windows
```shell
curl -o ios-Windows-x86_64.zip -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/ios/releases/latest/download/ios-Windows-x86_64.zip"
```
</details>

## Crate
[https://crates.io/crates/ios][crate]

### Cargo Docs - Official Runbook
[https://docs.rs/ios/latest/ios/][docs]

**Generator**
```shell
cargo doc --document-private-items --no-deps
```

## Linting
### Requirement
```shell
rustup component add clippy
```
### Usage
```shell
cargo clippy --no-deps --fix
```

## License & copyright

&copy; Vignesh Rao

Licensed under the [MIT License][license]

[repo]: https://github.com/thevickypedia/iOS-Backup
[license]: https://github.com/thevickypedia/iOS-Backup/blob/main/LICENSE
[build]: https://github.com/thevickypedia/iOS-Backup/actions/workflows/rust.yml
[rust-src-page]: https://www.rust-lang.org/
[rust-logo]: https://img.shields.io/badge/Made%20with-Rust-black?style=for-the-badge&logo=Rust
[gh-logo]: https://github.com/thevickypedia/iOS-Backup/actions/workflows/rust.yml/badge.svg
[nsp-logo]: https://github.com/thevickypedia/iOS-Backup/actions/workflows/none.yml/badge.svg
[nsp]: https://github.com/thevickypedia/iOS-Backup/actions/workflows/none.yml
[crate]: https://crates.io/crates/ios
[gh-checks]: https://github.com/thevickypedia/iOS-Backup/actions/workflows/rust.yml
[crates-logo]: https://img.shields.io/crates/v/ios.svg
[gh-wiki]: https://github.com/thevickypedia/iOS-Backup/wiki
[gh-wiki-env]: https://github.com/thevickypedia/iOS-Backup/wiki/Environment-Variables
[docs]: https://docs.rs/ios/latest/ios/