diff options
| author | 2020-06-13 02:47:25 +0200 | |
|---|---|---|
| committer | 2020-06-13 02:47:25 +0200 | |
| commit | 8cd780ac676b8060a76af827d8b18b0b295fcbca (patch) | |
| tree | f27d6e25d7a71f68559b9c2bb6b52f8ec29d0ae5 | |
| parent | 6cd36e65435c63bf2569d825e1f42c83721b364a (diff) | |
| download | ideviceinstaller-8cd780ac676b8060a76af827d8b18b0b295fcbca.tar.gz ideviceinstaller-8cd780ac676b8060a76af827d8b18b0b295fcbca.tar.bz2 | |
Improve README.md with feature, installation and usage sections
| -rw-r--r-- | README.md | 100 |
1 files changed, 80 insertions, 20 deletions
| @@ -1,39 +1,99 @@ | |||
| 1 | # ideviceinstaller | 1 | # ideviceinstaller |
| 2 | 2 | ||
| 3 | ## About | 3 | *A command-line application to manage apps and app archives on iOS devices.* |
| 4 | 4 | ||
| 5 | The ideviceinstaller tool allows interacting with the installation_proxy service | 5 | ## Features |
| 6 | of an iOS device allowing to install, upgrade, uninstall, archive, restore | ||
| 7 | and enumerate installed or archived apps. | ||
| 8 | 6 | ||
| 9 | It makes use of the fabulous libimobiledevice library that allows communication | 7 | The ideviceinstaller application allows interacting with the app installation |
| 10 | with iOS devices. | 8 | service of an iOS device. |
| 11 | 9 | ||
| 12 | ## Requirements | 10 | It makes use of the fabulous [libimobiledevice library](https://github.com/libimobiledevice/libimobiledevice) that allows |
| 11 | communication with iOS devices. | ||
| 13 | 12 | ||
| 14 | Development Packages of: | 13 | Some key features are: |
| 15 | * libimobiledevice | ||
| 16 | * libplist | ||
| 17 | * libzip | ||
| 18 | 14 | ||
| 19 | ## Installation | 15 | - **Status:** Install, upgrade, uninstall, archive, restore and enumerate apps |
| 16 | - **Browse**: Allows to retrieve a list of installed apps with filter options | ||
| 17 | - **Install**: Supports app package, carrier bundle and developer .app directory | ||
| 18 | - **Format**: Allows command output in plist format | ||
| 19 | - **Compatibility**: Supports latest device firmware releases | ||
| 20 | - **Cross-Platform:** Tested on Linux, macOS, Windows and Android platforms | ||
| 20 | 21 | ||
| 21 | To compile run: | 22 | ## Installation / Getting started |
| 22 | ```bash | 23 | |
| 24 | ### Debian / Ubuntu Linux | ||
| 25 | |||
| 26 | First install all required dependencies and build tools: | ||
| 27 | ```shell | ||
| 28 | sudo apt-get install \ | ||
| 29 | build-essential \ | ||
| 30 | checkinstall \ | ||
| 31 | git \ | ||
| 32 | autoconf \ | ||
| 33 | automake \ | ||
| 34 | libtool-bin \ | ||
| 35 | libplist-dev \ | ||
| 36 | libimobiledevice-dev \ | ||
| 37 | libzip-dev \ | ||
| 38 | usbmuxd | ||
| 39 | ``` | ||
| 40 | |||
| 41 | Continue with cloning the actual project repository: | ||
| 42 | ```shell | ||
| 43 | git clone https://github.com/libimobiledevice/ideviceinstaller.git | ||
| 44 | cd ideviceinstaller | ||
| 45 | ``` | ||
| 46 | |||
| 47 | Now you can build and install it: | ||
| 48 | ```shell | ||
| 23 | ./autogen.sh | 49 | ./autogen.sh |
| 24 | make | 50 | make |
| 25 | sudo make install | 51 | sudo make install |
| 26 | ``` | 52 | ``` |
| 27 | 53 | ||
| 28 | ## Who/What/Where? | 54 | ## Usage |
| 55 | |||
| 56 | First of all attach your device to your machine. | ||
| 57 | |||
| 58 | Then simply run: | ||
| 59 | ```shell | ||
| 60 | idevicerestore --list-apps | ||
| 61 | ``` | ||
| 62 | |||
| 63 | This will print a list of `<appid>` identifiers (bundle identifiers) for use | ||
| 64 | with other commands (see further below). | ||
| 29 | 65 | ||
| 30 | * Home: https://libimobiledevice.org/ | 66 | To install an app from a package file use: |
| 31 | * Code: `git clone https://git.libimobiledevice.org/ideviceinstaller.git` | 67 | ```shell |
| 32 | * Code (Mirror): `git clone https://github.com/libimobiledevice/ideviceinstaller.git` | 68 | idevicerestore --install <file> |
| 33 | * Tickets: https://github.com/libimobiledevice/ideviceinstaller/issues | 69 | ``` |
| 70 | |||
| 71 | To uninstall an app with the `<appid>` from the device use: | ||
| 72 | ```shell | ||
| 73 | idevicerestore --uninstall <appid> | ||
| 74 | ``` | ||
| 75 | |||
| 76 | Please consult the usage information or manual page for a full documentation of | ||
| 77 | available command line options: | ||
| 78 | ```shell | ||
| 79 | ideviceinstaller --help | ||
| 80 | man ideviceinstaller | ||
| 81 | ``` | ||
| 82 | |||
| 83 | ## Links | ||
| 84 | |||
| 85 | * Homepage: https://libimobiledevice.org/ | ||
| 86 | * Repository: https://git.libimobiledevice.org/ideviceinstaller.git | ||
| 87 | * Repository (Mirror): https://github.com/libimobiledevice/ideviceinstaller.git | ||
| 88 | * Issue Tracker: https://github.com/libimobiledevice/ideviceinstaller/issues | ||
| 34 | * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel | 89 | * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel |
| 35 | * Twitter: https://twitter.com/libimobiledev | 90 | * Twitter: https://twitter.com/libimobiledev |
| 36 | 91 | ||
| 92 | ## License | ||
| 93 | |||
| 94 | This software is licensed under the [GNU General Public License v2.0](https://www.gnu.org/licenses/gpl-2.0.en.html), | ||
| 95 | also included in the repository in the `COPYING` file. | ||
| 96 | |||
| 37 | ## Credits | 97 | ## Credits |
| 38 | 98 | ||
| 39 | Apple, iPhone, iPod, iPad, Apple TV and iPod Touch are trademarks of Apple Inc. | 99 | Apple, iPhone, iPod, iPad, Apple TV and iPod Touch are trademarks of Apple Inc. |
| @@ -41,4 +101,4 @@ Apple, iPhone, iPod, iPad, Apple TV and iPod Touch are trademarks of Apple Inc. | |||
| 41 | ideviceinstaller is an independent software application and has not been | 101 | ideviceinstaller is an independent software application and has not been |
| 42 | authorized, sponsored or otherwise approved by Apple Inc. | 102 | authorized, sponsored or otherwise approved by Apple Inc. |
| 43 | 103 | ||
| 44 | README Updated on: 2020-06-08 | 104 | README Updated on: 2020-06-13 |
