docs: update CLI docs

blacktop · Jul 28, 2024 · 455d715 · 455d715
1 parent ba79d3c
commit 455d715
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 9 deletions.
diff --git a/api/swagger.json b/api/swagger.json
@@ -2233,6 +2233,16 @@
       },
       "x-go-package": "github.com/blacktop/ipsw/pkg/dyld"
     },
+    "CacheSlidePointer": {
+      "type": "object",
+      "properties": {
+        "Raw": {
+          "type": "integer",
+          "format": "uint64"
+        }
+      },
+      "x-go-package": "github.com/blacktop/ipsw/pkg/dyld"
+    },
     "CodeDirectory": {
       "description": "CodeDirectory object",
       "type": "object",
@@ -3912,9 +3922,7 @@
           "x-go-name": "CacheVMAddress"
         },
         "pointer": {
-          "type": "integer",
-          "format": "uint64",
-          "x-go-name": "Pointer"
+          "$ref": "#/definitions/CacheSlidePointer"
         },
         "symbol": {
           "type": "string",

diff --git a/www/docs/cli/ipsw/ota/extract.md b/www/docs/cli/ipsw/ota/extract.md
@@ -11,14 +11,16 @@ description: Extract OTA payload files
 Extract OTA payload files
 
 ```
-ipsw ota extract <OTA> <PATTERN> [flags]
+ipsw ota extract <OTA> [FILENAME]> [flags]
 ```
 
 ### Options
 
 ```
-  -h, --help            help for extract
-  -o, --output string   Output folder
+  -d, --decomp           Decompress pbzx files
+  -h, --help             help for extract
+  -o, --output string    Output folder
+  -p, --pattern string   Regex pattern to match files
 ```
 
 ### Options inherited from parent commands

diff --git a/www/docs/cli/ipsw/ota/ls/ls.md b/www/docs/cli/ipsw/ota/ls/ls.md
@@ -0,0 +1,37 @@
+---
+id: ls
+title: ls
+hide_title: true
+hide_table_of_contents: true
+sidebar_label: ls
+description: List OTA files
+---
+## ipsw ota ls
+
+List OTA files
+
+```
+ipsw ota ls <OTA> [flags]
+```
+
+### Options
+
+```
+  -b, --bom    List the post.bom files
+  -h, --help   help for ls
+```
+
+### 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 ota](/docs/cli/ipsw/ota)	 - Parse OTAs
+* [ipsw ota ls payload](/docs/cli/ipsw/ota/ls/payload)	 - List contents of a payloadv2 file
+
diff --git a/www/docs/cli/ipsw/ota/ls/payload.md b/www/docs/cli/ipsw/ota/ls/payload.md
@@ -0,0 +1,37 @@
+---
+id: payload
+title: payload
+hide_title: true
+hide_table_of_contents: true
+sidebar_label: payload
+description: List contents of a payloadv2 file
+---
+## ipsw ota ls payload
+
+List contents of a payloadv2 file
+
+```
+ipsw ota ls payload <PAYLOAD>|<OTA> <PAYLOAD> [flags]
+```
+
+### Options
+
+```
+  -d, --dirs    Directories only
+  -f, --files   Files only
+  -h, --help    help for payload
+```
+
+### 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 ota ls](/docs/cli/ipsw/ota/ls)	 - List OTA files
+
diff --git a/www/static/api/swagger.json b/www/static/api/swagger.json
@@ -2233,6 +2233,16 @@
       },
       "x-go-package": "github.com/blacktop/ipsw/pkg/dyld"
     },
+    "CacheSlidePointer": {
+      "type": "object",
+      "properties": {
+        "Raw": {
+          "type": "integer",
+          "format": "uint64"
+        }
+      },
+      "x-go-package": "github.com/blacktop/ipsw/pkg/dyld"
+    },
     "CodeDirectory": {
       "description": "CodeDirectory object",
       "type": "object",
@@ -3912,9 +3922,7 @@
           "x-go-name": "CacheVMAddress"
         },
         "pointer": {
-          "type": "integer",
-          "format": "uint64",
-          "x-go-name": "Pointer"
+          "$ref": "#/definitions/CacheSlidePointer"
         },
         "symbol": {
           "type": "string",