Skip to content

Commit 7a447b4

Browse files
committed
Fixes #79 - Update README.md for sample usage of ios-deploy flags and options
1 parent 021c222 commit 7a447b4

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

README.md

+31-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
ios-deploy
22
==========
3-
Install and debug iPhone apps without using Xcode. Designed to work on unjailbroken devices.
3+
Install and debug iOS apps without using Xcode. Designed to work on un-jailbroken devices.
44

55
## Requirements
66

7-
* Mac OS X. Tested on Snow Leopard only.
8-
* You need to have a valid iPhone development certificate installed.
9-
* Xcode must be installed, along with the SDK for your iOS version.
7+
* Mac OS X. Tested on 10.10 Yosemite and iOS 8.1
8+
* You need to have a valid iOS development certificate installed.
9+
* Xcode 6.1 should be installed
1010

1111
## Usage
1212

@@ -31,7 +31,32 @@ Install and debug iPhone apps without using Xcode. Designed to work on unjailbro
3131
-w, --download download app tree
3232
-2, --to <target pathname> use together with up/download file/tree. specify target
3333
-V, --version print the executable version
34-
34+
35+
## Examples
36+
37+
The commands below assume that you have an app called `my.app` with bundle id `bundle.id`. Substitute where necessary.
38+
39+
// deploy and debug your app to a connected device
40+
ios-deploy --debug --bundle my.app
41+
42+
// deploy and launch your app to a connected device, but quit the debugger after
43+
ios-deploy --justlaunch --debug --bundle my.app
44+
45+
// deploy and launch your app to a connected device, quit when app crashes or exits
46+
ios-deploy --noninteractive --debug --bundle my.app
47+
48+
// Upload a file to your app's Documents folder
49+
ios-deploy --bundle_id 'bundle.id' --upload test.txt --to Documents/test.txt
50+
51+
// Download your app's Documents, Library and tmp folders
52+
ios-deploy --bundle_id 'bundle.id' --download --to MyDestinationFolder
53+
54+
// List the contents of your app's Documents, Library and tmp folders
55+
ios-deploy --bundle_id 'bundle.id' --list
56+
57+
// deploy and debug your app to a connected device, uninstall the app first
58+
ios-deploy --uninstall --debug --bundle my.app
59+
3560
## Demo
3661

3762
* The included demo.app represents the minimum required to get code running on iOS.
@@ -40,7 +65,7 @@ Install and debug iPhone apps without using Xcode. Designed to work on unjailbro
4065

4166
## Notes
4267

43-
* With some modifications, it may be possible to use this without Xcode installed; however, you would need a copy of the relevant DeveloperDiskImage.dmg (included with Xcode). GDB would also run slower as symbols would be downloaded from the device on-the-fly.
68+
* With some modifications, it may be possible to use this without Xcode installed; however, you would need a copy of the relevant DeveloperDiskImage.dmg (included with Xcode). lldb would also run slower as symbols would be downloaded from the device on-the-fly.
4469

4570

4671
## Listing Device Ids

0 commit comments

Comments
 (0)