Files
iDescriptor/README.md
T
2025-11-23 04:15:53 +00:00

204 lines
8.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<p align="center" style="text-align: center">
<img src="./resources/icons/app-icon/icon.png" width="25%"><br/>
</p>
<p align="center">
Cross platform, open-source and free idevice management tool written in C++
<br/>
<br/>
<a href="https://github.com/iDescriptor/iDescriptor/blob/master/LICENSE">
<img alt="GitHub" src="https://img.shields.io/github/license/iDescriptor/iDescriptor"/>
</a>
<a href="https://github.com/iDescriptor/iDescriptor/issues">
<img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="CodeFactor" />
</a>
<a href="https://github.com/iDescriptor/iDescriptor/actions/workflows/build-and-test.yml" rel="nofollow">
<img src="https://img.shields.io/github/actions/workflow/status/iDescriptor/iDescriptor/build-linux.yml?branch=main&logo=Github" alt="Build" />
</a>
<a href="https://github.com/iDescriptor/iDescriptor/tags" rel="nofollow">
<img alt="GitHub tag (latest SemVer pre-release)" src="https://img.shields.io/github/v/tag/iDescriptor/iDescriptor?include_prereleases&label=version"/>
</a>
<img alt="Platform" src="https://img.shields.io/badge/Platform-Windows%20%7C%20macOS%20%7C%20Linux-blue.svg"/>
<img alt="Language" src="https://img.shields.io/badge/C++-20-hotpink.svg"/>
<img alt="Qt" src="https://img.shields.io/badge/Qt-6-brightgreen.svg"/>
<a href="https://github.com/iDescriptor/iDescriptor/releases">
<img src="https://img.shields.io/badge/AppImage-available-brightgreen" alt="AppImage"/>
</a>
<a href="https://github.com/iDescriptor/iDescriptor/releases">
<img src="https://img.shields.io/badge/Arch_AUR-available-brightgreen" alt="AppImage"/>
</a>
<br/>
<br/>
<a href="https://aur.archlinux.org/packages/idescriptor-git/">
<img src="https://img.shields.io/badge/OpenCollective-1F87FF?style=for-the-badge&logo=OpenCollective&logoColor=white" alt="AppImage"/>
</a>
</p>
<p align="center">
<img src="./resources/repo/crossplatform.png"><br/>
</p>
## Features
### Connection
| Feature | Status | Notes |
| --------------------------- | -------------------- | --------------------------------------------- |
| USB Connection | ✅ Implemented | Fully supported on Windows, macOS, and Linux. |
| Wireless Connection (WiFi) | ⚠️ To be implemented | - |
### Tools
| Feature | Status | Notes |
| ------------------------------------------------------ | -------------- | ------------------------------------------------------------------------------------- |
| [AirPlay](#airplay) | ✅ Implemented | Cast your device screen to your computer. |
| [Download & Install Apps From Apple Store](#app-store) | ✅ Implemented | Download and install apps directly from the Apple Store. |
| [Virtual Location](#virtual-location) | ✅ Implemented | Simulate GPS location. Requires a mounted Developer Disk Image. **( iOS 6 - iOS 16)** |
| [iFuse Filesystem Mount](#ifuse-filesystem-mount) | ✅ Implemented | Mount the device's filesystem. (Windows & Linux only) |
| Gallery | ✅ Implemented | - |
| File Explorer | ✅ Implemented | Explore the device's filesystem. |
| Wireless Gallery Import | ✅ Implemented | Import photos wirelessly (requires the Shortcuts app on the iDevice). |
| [Cable Info](#cable-info) | ✅ Implemented | Check authenticity of connected USB cables and more. |
| [Network Device Discovery](#network-device-discovery) | ✅ Implemented | Discover and monitor devices on your local network. |
| [SSH Terminal](#ssh-terminal) **(Jailbroken)** | ✅ Implemented | Open up a terminal on your iDevice. |
| Query MobileGestalt | ✅ Implemented | Read detailed hardware and software information from the device. |
| [Live Screen](#live-screen) | ✅ Implemented | View your device's screen in real-time **(wired)**. |
| Developer Disk Images | ✅ Implemented | Manage and mount developer disk images. **( iOS 6 - iOS 16)** |
### Device Actions
| Feature | Status | Notes |
| ------------------- | -------------- | ----- |
| Restart Device | ✅ Implemented | - |
| Shutdown Device | ✅ Implemented | - |
| Enter Recovery Mode | ✅ Implemented | - |
## Fully Theme Aware
<p align="center">
<img src="./resources/repo/macos-theme.gif"><br/>
</p>
<p align="center">
<img src="./resources/repo/ubuntu-theme.gif"><br/>
</p>
## AirPlay
### Cast your device screen to your computer!
<p align="center">
<img src="./resources/repo/airplay.gif"><br/>
</p>
## App Store
### Download and Install Apps directly from the Apple Store!
You need to sign in with your Apple ID to use this feature.
<p align="center">
<img src="./resources/repo/ipatool.png"><br/>
</p>
## Virtual Location
### Simulate GPS location on your iDevice! (iOS 6 - iOS 16)
<p align="center">
<img src="./resources/repo/virtual-location.png"><br/>
</p>
## iFuse Filesystem Mount
### Use your iDevice as a regular DRIVE!
Literally mount your iDevice filesystem and use it as a regular drive , read and write are both allowed. Don't try to import photos or videos because it won't work that way, use the Gallery Import feature for that.
#### Windows
<p align="center">
<img src="./resources/repo/win-ifuse.gif"><br/>
</p>
#### Ubuntu / Linux
<p align="center">
<img src="./resources/repo/ifuse.gif"><br/>
</p>
### Gallery
<p align="center">
<img src="./resources/repo/gallery.png"><br/>
</p>
### File Explorer
<p align="center">
<img src="./resources/repo/file-explorer.png"><br/>
</p>
## Cable Info
<p align="center">
<img src="./resources/repo/cable-info-genuine.png"><br/>
</p>
## Network Device Discovery
<p align="center">
<img src="./resources/repo/network-devices.png"><br/>
</p>
## SSH Terminal
### Open up a terminal on your Jailbroken iDevice!
<p align="center">
<img src="./resources/repo/ssh-terminal.gif"><br/>
</p>
## Live Screen
Useful if your device does not support AirPlay
<p align="center">
<img src="./resources/repo/live-screen.png"><br/>
</p>
## **Authentication Required** ?
You might get this pop-up on any platform this is because this app uses secure backends to retrieve and store your Apple credentials. You can disable this in settings but it is not recommended and not safe for your Apple account. Also if you leave this enabled and sign in you can use the same credentials in ipatool without signing in again.
<p align="center">
<img src="./resources/repo/authentication-required.png"><br/>
</p>
## Become a Sponsor
If you like this project and want to support its development, consider becoming a sponsor on [GitHub Sponsors](https://github.com/sponsors/yourusername).
## Thanks
- [libimobiledevice](https://libimobiledevice.org/) - Cross-platform software library that talks the protocols to support iPhone, iPad, iPod Touch devices.
- [ipatool](https://github.com/majd/ipatool) - A command-line tool for managing iOS apps and devices.
## Linux Udev Rules
iDescriptor will check for udev rules but in case it fails, you can manually add the udev rules by doing similar to the following:
```bash
@uncore  sudo cat /etc/udev/rules.d/99-idevice.rules
SUBSYSTEM=="usb", ATTR{idVendor}=="05ac", MODE="0666"
✘  Sun 6 Jul - 14:29  ~ 
@uncore  sudo groupadd idevice
Sun 6 Jul - 14:30  ~ 
@uncore  sudo usermod -aG idevice $USER
Sun 6 Jul - 14:30  ~ 
@uncore  sudo udevadm control --reload-rules
sudo udevadm trigger
```