docs: update CLI docs

blacktop · Jun 18, 2024 · 8747c8f · 8747c8f
1 parent 98c50ba
commit 8747c8f
Show file tree

Hide file tree

Showing 8 changed files with 2,311 additions and 884 deletions.
diff --git a/www/docs/cli/ipsw/download/appledb.md b/www/docs/cli/ipsw/download/appledb.md
@@ -32,6 +32,8 @@ ipsw download appledb [flags]
       --api-token string      Github API Token
       --beta                  Download beta IPSWs
       --dyld                  Extract dyld_shared_cache(s) from remote OTA
+      --fcs-keys              Download AEA1 DMG fcs-key pem files
+      --fcs-keys-json         Download AEA1 DMG fcs-keys as JSON
   -f, --flat                  Do NOT perserve directory structure when downloading with --pattern
   -h, --help                  help for appledb
   -j, --json                  Dump DB query results as JSON

diff --git a/www/docs/cli/ipsw/download/ipsw.md b/www/docs/cli/ipsw/download/ipsw.md
@@ -20,6 +20,8 @@ ipsw download ipsw [flags]
       --decrypt                 Attempt to decrypt the partial files if keys are available
       --dyld                    Extract dyld_shared_cache(s) from remote IPSW
   -a, --dyld-arch stringArray   dyld_shared_cache architecture(s) to remote extract
+      --fcs-keys                Download AEA1 DMG fcs-key pem files
+      --fcs-keys-json           Download AEA1 DMG fcs-keys as JSON
   -f, --flat                    Do NOT perserve directory structure when downloading with --pattern
   -h, --help                    help for ipsw
       --ibridge                 Download iBridge IPSWs

diff --git a/www/docs/cli/ipsw/ent.md b/www/docs/cli/ipsw/ent.md
@@ -39,12 +39,13 @@ ipsw ent [flags]
       --db string           Folder to r/w entitlement databases
   -d, --diff                Diff entitlements
   -f, --file string         Dump entitlements for MachO as plist
+      --file-only           Only output the file path of matches
   -h, --help                help for ent
       --input stringArray   Folders of MachOs to analyze
       --ipsw stringArray    IPSWs to analyze
-  -k, --key string          Entitlement KEY to search for
+  -k, --key string          Entitlement KEY regex to search for
   -m, --md                  Markdown style output
-  -v, --val string          Entitlement VALUE to search for (i.e. <array> strings)
+  -v, --val string          Entitlement VALUE regex to search for (i.e. <array> strings)
 ```
 
 ### Options inherited from parent commands

diff --git a/www/docs/cli/ipsw/extract.md b/www/docs/cli/ipsw/extract.md
@@ -24,6 +24,7 @@ ipsw extract <IPSW/OTA | URL> [flags]
   -d, --dyld                    Extract dyld_shared_cache
   -a, --dyld-arch stringArray   dyld_shared_cache architecture to extract
   -x, --exclave                 Extract Exclave Bundle
+      --fcs-key                 Extract AEA1 DMG fcs-key pem files
   -f, --files                   Extract File System files
       --flat                    Do NOT perserve directory structure when extracting
   -h, --help                    help for extract

diff --git a/www/docs/cli/ipsw/fw/aea.md b/www/docs/cli/ipsw/fw/aea.md
@@ -0,0 +1,40 @@
+---
+id: aea
+title: aea
+hide_title: true
+hide_table_of_contents: true
+sidebar_label: aea
+description: Parse ANE1 DMGs
+---
+## ipsw fw aea
+
+Parse ANE1 DMGs
+
+```
+ipsw fw aea [flags]
+```
+
+### Options
+
+```
+  -f, --fcs-key         Get fcs-key JSON
+  -h, --help            help for aea
+  -i, --info            Print info
+  -k, --key             Get archive decryption key
+  -o, --output string   Folder to extract files to
+  -p, --pem string      AEA private_key.pem file
+```
+
+### Options inherited from parent commands
+
+```
+      --color           colorize output
+      --config string   config file (default is $HOME/.config/ipsw/config.yaml)
+      --no-color        disable colorize output
+  -V, --verbose         verbose output
+```
+
+### SEE ALSO
+
+* [ipsw fw](/docs/cli/ipsw/fw)	 - Firmware commands
+
diff --git a/www/docs/cli/ipsw/fw/fw.md b/www/docs/cli/ipsw/fw/fw.md
@@ -32,6 +32,6 @@ ipsw fw [flags]
 ### SEE ALSO
 
 * [ipsw](/docs/cli/ipsw)	 - Download and Parse IPSWs (and SO much more)
+* [ipsw fw aea](/docs/cli/ipsw/fw/aea)	 - Parse ANE1 DMGs
 * [ipsw fw iboot](/docs/cli/ipsw/fw/iboot)	 - Dump firmwares
-* [ipsw fw sepfw](/docs/cli/ipsw/fw/sepfw)	 - Dump MachOs
 
diff --git a/www/docs/getting-started/installation.md b/www/docs/getting-started/installation.md
@@ -104,9 +104,12 @@ sudo snap install ipsw
 
 ## Via `deb`/`rpm`/`apk` debian packages in the [releases](https://github.com/blacktop/ipsw/releases) page
 
+To install, after downloading the files, run:
+
 ```bash
-wget https://github.com/blacktop/ipsw/releases/download/v3.1.199/ipsw_3.1.199_linux_x86_64.deb
-sudo dpkg -i ipsw_3.1.199_linux_x86_64.deb
+dpkg -i ipsw*.deb
+rpm -ivh ipsw*.rpm
+apk add --allow-untrusted ipsw*.apk
 ```
 
 ## Install [archlinux](https://aur.archlinux.org/packages/ipsw-bin/) package from AUR