{"id":13420474,"url":"https://github.com/libimobiledevice/libirecovery","last_synced_at":"2025-04-12T18:53:48.292Z","repository":{"id":6929583,"uuid":"8180767","full_name":"libimobiledevice/libirecovery","owner":"libimobiledevice","description":"Library and utility to talk to iBoot/iBSS via USB on Mac OS X, Windows, and Linux","archived":false,"fork":false,"pushed_at":"2024-05-31T17:11:54.000Z","size":438,"stargazers_count":540,"open_issues_count":35,"forks_count":207,"subscribers_count":55,"default_branch":"master","last_synced_at":"2024-07-31T22:55:19.503Z","etag":null,"topics":["dfu","iboot","ibss","ios","irecovery","library"],"latest_commit_sha":null,"homepage":"https://libimobiledevice.org","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libimobiledevice.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-02-13T14:38:54.000Z","updated_at":"2024-07-19T13:00:11.000Z","dependencies_parsed_at":"2022-09-04T06:20:50.821Z","dependency_job_id":"cc31df6c-48f2-4f45-b837-b5b9db79ec5c","html_url":"https://github.com/libimobiledevice/libirecovery","commit_stats":{"total_commits":341,"total_committers":22,"mean_commits":15.5,"dds":0.5454545454545454,"last_synced_commit":"3962e480ca13e4ac2a3c4f6f62b5daa5f557851c"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibirecovery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibirecovery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibirecovery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibirecovery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libimobiledevice","download_url":"https://codeload.github.com/libimobiledevice/libirecovery/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618262,"owners_count":21134200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dfu","iboot","ibss","ios","irecovery","library"],"created_at":"2024-07-30T22:01:34.414Z","updated_at":"2025-04-12T18:53:48.258Z","avatar_url":"https://github.com/libimobiledevice.png","language":"C","funding_links":[],"categories":["TODO scan for Android support in followings","Uncategorized","C"],"sub_categories":["Uncategorized"],"readme":"# libirecovery\n\n*The libirecovery library allows communication with iBoot/iBSS of iOS devices\nvia USB.*\n\n![](https://github.com/libimobiledevice/libirecovery/workflows/build/badge.svg)\n\n## Table of Contents\n- [Features](#features)\n- [Building](#building)\n  - [Prerequisites](#prerequisites)\n    - [Linux (Debian/Ubuntu based)](#linux-debianubuntu-based)\n    - [macOS](#macos)\n    - [Windows](#windows)\n  - [Configuring the source tree](#configuring-the-source-tree)\n  - [Building and installation](#building-and-installation)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [Links](#links)\n- [License](#license)\n- [Credits](#credits)\n\n## Features\n\nlibirecovery is a cross-platform library which implements communication to\niBoot/iBSS found on Apple's iOS devices via USB. A command-line utility named\n`irecovery` is also provided.\n\nThis is a fork of an older version from former openjailbreak.org and is meant to\nbe used with [idevicerestore](https://github.com/libimobiledevice/idevicerestore.git/) from the [libimobiledevice](https://github.com/libimobiledevice/) project.\n\n## Building\n\n### Prerequisites\n\nYou need to have a working compiler (gcc/clang) and development environent\navailable. This project uses autotools for the build process, allowing to\nhave common build steps across different platforms.\nOnly the prerequisites differ and they are described in this section.\n\nlibirecovery requires [libimobiledevice-glue](https://github.com/libimobiledevice/libimobiledevice-glue).\nCheck the [Building](https://github.com/libimobiledevice/libimobiledevice-glue?tab=readme-ov-file#building)\nsection of the README on how to build it. Note that some platforms might have it as a package.\n\n#### Linux (Debian/Ubuntu based)\n\n* Install all required dependencies and build tools:\n  ```shell\n  sudo apt-get install \\\n  \tbuild-essential \\\n  \tpkg-config \\\t\n  \tcheckinstall \\\n  \tgit \\\n  \tautoconf \\\n  \tautomake \\\n  \tlibtool-bin \\\n  \tlibimobiledevice-glue-dev \\\n  \tlibreadline-dev \\\n  \tlibusb-1.0-0-dev\n  ```\n\n  In case libimobiledevice-glue-dev is not available, you can manually build and install it. See note above.\n\n#### macOS\n\n* Make sure the Xcode command line tools are installed. Then, use either [MacPorts](https://www.macports.org/)\n  or [Homebrew](https://brew.sh/) to install `automake`, `autoconf`, `libtool`, etc.\n\n  Using MacPorts:\n  ```shell\n  sudo port install libtool autoconf automake pkgconfig\n  ```\n\n  Using Homebrew:\n  ```shell\n  brew install libtool autoconf automake pkg-config\n  ```\n\n#### Windows\n\n* Using [MSYS2](https://www.msys2.org/) is the official way of compiling this project on Windows. Download the MSYS2 installer\n  and follow the installation steps.\n\n  It is recommended to use the _MSYS2 MinGW 64-bit_ shell. Run it and make sure the required dependencies are installed:\n\n  ```shell\n  pacman -S base-devel \\\n  \tgit \\\n  \tmingw-w64-x86_64-gcc \\\n  \tmake \\\n  \tlibtool \\\n  \tautoconf \\\n  \tautomake-wrapper \\\n  \tpkg-config \\\n  \tmingw-w64-x86_64-readline\n  ```\n  NOTE: You can use a different shell and different compiler according to your needs. Adapt the above command accordingly.\n\n### Configuring the source tree\n\nYou can build the source code from a git checkout, or from a `.tar.bz2` release tarball from [Releases](https://github.com/libimobiledevice/libirecovery/releases).\nBefore we can build it, the source tree has to be configured for building. The steps depend on where you got the source from.\n\nSince libirecovery depends on other packages, you should set the pkg-config environment variable `PKG_CONFIG_PATH`\naccordingly. Make sure to use a path with the same prefix as the dependencies. If they are installed in `/usr/local` you would do\n\n```shell\nexport PKG_CONFIG_PATH=/usr/local/lib/pkgconfig\n```\n\n* **From git**\n\n  If you haven't done already, clone the actual project repository and change into the directory.\n  ```shell\n  git clone https://github.com/libimobiledevice/libirecovery\n  cd libirecovery\n  ```\n\n  Configure the source tree for building:\n  ```shell\n  ./autogen.sh\n  ```\n\n* **From release tarball (.tar.bz2)**\n\n  When using an official [release tarball](https://github.com/libimobiledevice/libirecovery/releases) (`libirecovery-x.y.z.tar.bz2`)\n  the procedure is slightly different.\n\n  Extract the tarball:\n  ```shell\n  tar xjf libirecovery-x.y.z.tar.bz2\n  cd libirecovery-x.y.z\n  ```\n\n  Configure the source tree for building:\n  ```shell\n  ./configure\n  ```\n\nBoth `./configure` and `./autogen.sh` (which generates and calls `configure`) accept a few options, for example `--prefix` to allow\nbuilding for a different target folder. You can simply pass them like this:\n\n```shell\n./autogen.sh --prefix=/usr/local\n```\nor\n```shell\n./configure --prefix=/usr/local\n```\n\nOnce the command is successful, the last few lines of output will look like this:\n```\n[...]\nconfig.status: creating config.h\nconfig.status: executing depfiles commands\nconfig.status: executing libtool commands\n\nConfiguration for libirecovery 1.2.0:\n-------------------------------------------\n\n  Install prefix: .........: /usr/local\n  USB backend: ............: IOKit\n\n  Now type 'make' to build libirecovery 1.2.0,\n  and then 'make install' for installation.\n```\n\n### Building and installation\n\nIf you followed all the steps successfully, and `autogen.sh` or `configure` did not print any errors,\nyou are ready to build the project. This is simply done with\n\n```shell\nmake\n```\n\nIf no errors are emitted you are ready for installation. Depending on whether\nthe current user has permissions to write to the destination directory or not,\nyou would either run\n```shell\nmake install\n```\n_OR_\n```shell\nsudo make install\n```\n\nIf you are on Linux, you want to run `sudo ldconfig` after installation to\nmake sure the installed libraries are made available.\n\n## Usage\n\nFirst of all attach your device to your machine. Make sure your device is not\nin normal mode. You can use the `ideviceenterrecovery` application from\n[libimobiledevice](https://github.com/libimobiledevice/libimobiledevice.git/)\nto let your device boot into recovery mode if you need it.\n\nThen simply run:\n```shell\nirecovery --shell\n```\n\nThis connects to your device and opens a simple shell to interact with the\ndevice.\n\nFor instance to make your device boot into normal mode again use:\n```shell\nsetenv auto-boot true\nsaveenv\nreboot\n```\n\nPlease consult the usage information or manual page for a full documentation of\navailable command line options:\n```shell\nirecovery --help\nman irecovery\n```\n\n## Contributing\n\nWe welcome contributions from anyone and are grateful for every pull request!\n\nIf you'd like to contribute, please fork the `master` branch, change, commit and\nsend a pull request for review. Once approved it can be merged into the main\ncode base.\n\nIf you plan to contribute larger changes or a major refactoring, please create a\nticket first to discuss the idea upfront to ensure less effort for everyone.\n\nPlease make sure your contribution adheres to:\n* Try to follow the code style of the project\n* Commit messages should describe the change well without being too short\n* Try to split larger changes into individual commits of a common domain\n* Use your real name and a valid email address for your commits\n\n## Links\n\n* Homepage: https://libimobiledevice.org/\n* Repository: https://github.com/libimobiledevice/libirecovery.git\n* Repository (Mirror): https://git.libimobiledevice.org/libirecovery.git\n* Issue Tracker: https://github.com/libimobiledevice/libirecovery/issues\n* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel\n* Twitter: https://twitter.com/libimobiledev\n\n## License\n\nThis project is licensed under the [GNU Lesser General Public License v2.1](https://www.gnu.org/licenses/lgpl-2.1.en.html),\nalso included in the repository in the `COPYING` file.\n\n## Credits\n\nApple, iPhone, iPad, iPod, iPod Touch, Apple TV, Apple Watch, Mac, iOS,\niPadOS, tvOS, watchOS, and macOS are trademarks of Apple Inc.\n\nThis project is an independent software library and has not been authorized,\nsponsored, or otherwise approved by Apple Inc.\n\nREADME Updated on: 2024-10-22\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibimobiledevice%2Flibirecovery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibimobiledevice%2Flibirecovery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibimobiledevice%2Flibirecovery/lists"}