Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steeve/itool
Single binary easy and composable iOS device interaction CLI
https://github.com/steeve/itool
Last synced: 2 months ago
JSON representation
Single binary easy and composable iOS device interaction CLI
- Host: GitHub
- URL: https://github.com/steeve/itool
- Owner: steeve
- License: apache-2.0
- Created: 2019-12-09T05:03:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-14T12:44:51.000Z (over 3 years ago)
- Last Synced: 2024-06-20T14:27:18.921Z (7 months ago)
- Language: Go
- Homepage:
- Size: 90.8 KB
- Stars: 70
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# itool
[](https://opensource.org/licenses/Apache-2.0)
[](https://twitter.com/steeve)
`itool` is an easy iOS and composable device management command line interface.
It was made to simplify and automate common development and provisioning tasks.
**This is very much a side project and a work in progress.**
## Goals
- Single binary distribution on macOS, Linux and Windows
- Simple, reusable, composable and embeddable
- Feature parity with Xcode
## Install
Head over to the [Releases](https://github.com/steeve/itool/releases) page and
download the `itool` binary for you OS/Arch.
On macOS and Windows, having iTunes installed is sufficient, since `itool` talks
directly to `usbmuxd`. The device should already be paired, as `itool` will
fetch the keys from `usbmuxd`.
On Linux, you'll need to install `usbmuxd` first, but since the pairing command
isn't done yet, there is no way to interact with the device fully.
## Usage
```
$ itool
Easy iOS management
Usage:
itool [command]
Available Commands:
afc Manage Apple File Conduit (AFC)
apps Manage apps
debugserver Debugserver proxy
devices Manage devices
diagnostics Manage diagnostics
fetchsymbols Manage fetchsymbols
help Help about any command
info Queries device information keys
location Simulate location
mount Manage mounts
notification Manage device notifications
provision Manage provisioning profiles
proxy Proxy TCP connection to device
screenshot Saves a screenshot as a PNG file
syslog Relays Syslog to stdout
Flags:
-h, --help help for itool
--json JSON output (not all commands)
-u, --udid string UDID
Use "itool [command] --help" for more information about a command.
$
```
## Examples
#### Run an app bundle
Run an app bundle directly from the command line and get the standard output
there provided the following requirements are met:
- bundle has debug entitlements
- device has developer image mounted
- Although it can list and umount, itool doesn't implement mounting developer
images yet. Xcode does it automatically until then, and the image stays
mounted until reboot.
When `itool` exists (either `Ctrl-C` or killed), the app will be killed on the
device also.
```
$ itool apps run my.app.bundle
Hello world!
^C
$
```
#### Install/uninstall apps
```
$ itool apps install myapp.ipa
```
#### Simulate locations from a `.gpx` file
```
$ itool location play route.gpx
```
#### Take a screenshot
```
$ itool screenshot -o shot.png
```
#### Proxy a TCP connection to a local port on the device
```
$ itool proxy :5000 :3215
```
#### Compose device information with `jq`
```
$ itool info --json | jq '.ProductName + " " + .ProductVersion'
```
#### Manage files
```
$ itool afc ls /
```
## Plans / Work In Progress
Some of those commands are sort of working, some are pure plans.
#### `itool devices pair`
Nescessary to make Linux work properly.
#### `itool apps attach`
Attach to an already running process. While this is not that hard, there is
no way yet to get the standard output of an already running process with
`gdbserver`.
#### `itool pcap`
Capture network packets and dump a `.pcap` file for later analysis.
#### `itool ps`
List running processes on a device.
## Building
```
$ go build github.com/steeve/itool/cmd/itool
```
## Packages
One important aspect of `itool` is that all commands are implemented using the
public APIs of Go packages. This means that it should be simple to use those
packages directly, for instance in a gRPC server.