Skip to content

Commit eee3416

Browse files
authored
Update readme (#48)
1 parent 2f3b033 commit eee3416

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

README.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,14 @@ OVERVIEW: Search for iOS apps available on the App Store.
4747
USAGE: ipatool search <term> [--limit <limit>] [--country <country>] [--device-family <device-family>] [--log-level <log-level>]
4848
4949
ARGUMENTS:
50-
<term> The term to search for.
50+
<term> The term to search for.
5151
5252
OPTIONS:
53-
-l, --limit <limit> The maximum amount of search results to retrieve.
54-
(default: 5)
55-
-c, --country <country> The two-letter (ISO 3166-1 alpha-2) country code for
56-
the iTunes Store. (default: US)
53+
-l, --limit <limit> The maximum amount of search results to retrieve. (default: 5)
54+
-c, --country <country> The two-letter (ISO 3166-1 alpha-2) country code for the
55+
iTunes Store. (default: US)
5756
-d, --device-family <device-family>
58-
The device family to limit the search query to.
59-
(default: iPhone)
57+
The device family to limit the search query to. (default: iPhone)
6058
--log-level <log-level> The log level. (default: info)
6159
--version Show the version.
6260
-h, --help Show help information.
@@ -67,21 +65,24 @@ To download a copy of the ipa file, use the `download` command.
6765
```
6866
OVERVIEW: Download (encrypted) iOS app packages from the App Store.
6967
70-
USAGE: ipatool download --bundle-identifier <bundle-identifier> [--email <email>] [--password <password>] [--auth-code <auth-code>] [--country <country>] [--device-family <device-family>] [--log-level <log-level>]
68+
USAGE: ipatool download --bundle-identifier <bundle-identifier> [--email <email>] [--password <password>] [--auth-code <auth-code>] [--country <country>] [--device-family <device-family>] [--output <output>] [--log-level <log-level>]
7169
7270
OPTIONS:
7371
-b, --bundle-identifier <bundle-identifier>
74-
The bundle identifier of the target iOS app.
75-
-e, --email <email> The email address for the Apple ID.
72+
The bundle identifier of the target iOS app.
73+
-e, --email <email> The email address for the Apple ID.
7674
-p, --password <password>
77-
The password for the Apple ID.
78-
--auth-code <auth-code> The 2FA code for the Apple ID.
79-
-c, --country <country> The two-letter (ISO 3166-1 alpha-2) country code for the iTunes Store. (default: US)
75+
The password for the Apple ID.
76+
--auth-code <auth-code> The 2FA code for the Apple ID.
77+
-c, --country <country> The two-letter (ISO 3166-1 alpha-2)
78+
country code for the iTunes Store. (default: US)
8079
-d, --device-family <device-family>
8180
The device family to limit the search query to. (default: iPhone)
81+
-o, --output <output> The destination path of the downloaded app package.
8282
--log-level <log-level> The log level. (default: info)
8383
--version Show the version.
8484
-h, --help Show help information.
85+
8586
```
8687

8788
**Note:** You can specify the Apple ID email address and username as arguments when using the tool or by setting them as environment variables (`IPATOOL_EMAIL` and `IPATOOL_PASSWORD`). If you do not specify this information using either of those methods, the tool will prompt for user input in an interactive session. Similarly, you can supply the 2FA code interactively or using the environment variable `IPATOOL_2FA_CODE`.

demo.gif

43.3 KB
Loading

0 commit comments

Comments
 (0)