Skip to content

Commit 3b4f011

Browse files
authored
Update the help output
We were missing several options in the main README
1 parent ff9e97c commit 3b4f011

File tree

1 file changed

+37
-31
lines changed

1 file changed

+37
-31
lines changed

README.md

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -50,37 +50,43 @@ python -m py_compile src/scripts/*.py && xcodebuild -target ios-deploy-lib && xc
5050
## Usage
5151

5252
Usage: ios-deploy [OPTION]...
53-
-d, --debug launch the app in lldb after installation
54-
-i, --id <device_id> the id of the device to connect to
55-
-c, --detect only detect if the device is connected
56-
-b, --bundle <bundle.app> the path to the app bundle to be installed
57-
-a, --args <args> command line arguments to pass to the app when launching it
58-
-s, --envs <envs> environment variables, space separated key-value pairs, to pass to the app when launching it
59-
-t, --timeout <timeout> number of seconds to wait for a device to be connected
60-
-u, --unbuffered don't buffer stdout
61-
-n, --nostart do not start the app when debugging
62-
-I, --noninteractive start in non interactive mode (quit when app crashes or exits)
63-
-L, --justlaunch just launch the app and exit lldb
64-
-v, --verbose enable verbose output
65-
-m, --noinstall directly start debugging without app install (-d not required)
66-
-A, --app_deltas incremental install. must specify a directory to store app deltas to determine what needs to be installed
67-
-p, --port <number> port used for device, default: dynamic
68-
-r, --uninstall uninstall the app before install (do not use with -m; app cache and data are cleared)
69-
-9, --uninstall_only uninstall the app ONLY. Use only with -1 <bundle_id>
70-
-1, --bundle_id <bundle id> specify bundle id for list and upload
71-
-l, --list[=<dir>] list all app files or the specified directory
72-
-o, --upload <file> upload file
73-
-w, --download[=<path>] download app tree or the specified file/directory
74-
-f, --file_system access the raw file system
75-
-2, --to <target pathname> use together with up/download file/tree. specify target
76-
-D, --mkdir <dir> make directory on device
77-
-R, --rm <path> remove file or directory on device (directories must be empty)
78-
-V, --version print the executable version
79-
-e, --exists check if the app with given bundle_id is installed or not
80-
-B, --list_bundle_id list bundle_id
81-
-W, --no-wifi ignore wifi devices
82-
-O, --output <file> write stdout and stderr to this file
83-
--detect_deadlocks <sec> start printing backtraces for all threads periodically after specific amount of seconds
53+
-d, --debug launch the app in lldb after installation
54+
-i, --id <device_id> the id of the device to connect to
55+
-c, --detect only detect if the device is connected
56+
-b, --bundle <bundle.app> the path to the app bundle to be installed
57+
-a, --args <args> command line arguments to pass to the app when launching it
58+
-s, --envs <envs> environment variables, space separated key-value pairs, to pass to the app when launching it
59+
-t, --timeout <timeout> number of seconds to wait for a device to be connected
60+
-u, --unbuffered don't buffer stdout
61+
-n, --nostart do not start the app when debugging
62+
-N, --nolldb start debugserver only. do not run lldb. Can not be used with args or envs options
63+
-I, --noninteractive start in non interactive mode (quit when app crashes or exits)
64+
-L, --justlaunch just launch the app and exit lldb
65+
-v, --verbose enable verbose output
66+
-m, --noinstall directly start debugging without app install (-d not required)
67+
-A, --app_deltas incremental install. must specify a directory to store app deltas to determine what needs to be installed
68+
-p, --port <number> port used for device, default: dynamic
69+
-r, --uninstall uninstall the app before install (do not use with -m; app cache and data are cleared)
70+
-9, --uninstall_only uninstall the app ONLY. Use only with -1 <bundle_id>
71+
-1, --bundle_id <bundle id> specify bundle id for list and upload
72+
-l, --list[=<dir>] list all app files or the specified directory
73+
-o, --upload <file> upload file
74+
-w, --download[=<path>] download app tree or the specified file/directory
75+
-2, --to <target pathname> use together with up/download file/tree. specify target
76+
-D, --mkdir <dir> make directory on device
77+
-R, --rm <path> remove file or directory on device (directories must be empty)
78+
-X, --rmtree <path> remove directory and all contained files recursively on device
79+
-V, --version print the executable version
80+
-e, --exists check if the app with given bundle_id is installed or not
81+
-B, --list_bundle_id list bundle_id
82+
-W, --no-wifi ignore wifi devices
83+
-C, --get_battery_level get battery current capacity
84+
-O, --output <file> write stdout to this file
85+
-E, --error_output <file> write stderr to this file
86+
--detect_deadlocks <sec> start printing backtraces for all threads periodically after specific amount of seconds
87+
-f, --file_system specify file system for mkdir / list / upload / download / rm
88+
-F, --non-recursively specify non-recursively walk directory
89+
-j, --json format output as JSON
8490

8591
## Examples
8692

0 commit comments

Comments
 (0)