Crate ios

Source
Expand description

§iOS-Backup

made-with-rust

crates.io

build none-shall-pass

§Summary

ios is a lightweight CLI tool to extract iPhone backups.

§Installation

cargo add ios

§Usage

Embedded

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.

Download OS specific Executable
§macOS (x86)
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)
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
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
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"

§Crate

https://crates.io/crates/ios

§Cargo Docs - Official Runbook

https://docs.rs/ios/latest/ios/

Generator

cargo doc --document-private-items --no-deps

§Linting

§Requirement

rustup component add clippy

§Usage

cargo clippy --no-deps --fix

§License & copyright

© Vignesh Rao

Licensed under the MIT License

Modules§

backup
Module to handle backup operations
constant
Module to load the required structs
dbutil
Module for database utilities
fileio
Module to handle database operations
logger
Module to construct a custom logger
parser
Module to parse command line arguments
squire
Module for helper functions

Functions§

retriever
Function to parse and extract iOS backup data