feat: Add automated CLI documentation generator

docs.json

@@ -623,9 +623,11 @@
                       {
                         "group": "wandb artifact",
                         "pages": [
+                          "models/ref/cli/wandb-artifact",
                           {
-                            "group": "wandb artifact cache",
+                            "group": "artifact cache",
                             "pages": [
+                              "models/ref/cli/wandb-artifact/wandb-artifact-cache",
                               "models/ref/cli/wandb-artifact/wandb-artifact-cache/wandb-artifact-cache-cleanup"
                             ]
                           },
@@ -637,6 +639,8 @@
                       {
                         "group": "wandb beta",
                         "pages": [
+                          "models/ref/cli/wandb-beta",
+                          "models/ref/cli/wandb-beta/wandb-beta-leet",
                           "models/ref/cli/wandb-beta/wandb-beta-sync"
                         ]
                       },
@@ -649,23 +653,25 @@
                       {
                         "group": "wandb job",
                         "pages": [
+                          "models/ref/cli/wandb-job",
                           "models/ref/cli/wandb-job/wandb-job-create",
                           "models/ref/cli/wandb-job/wandb-job-describe",
                           "models/ref/cli/wandb-job/wandb-job-list"
                         ]
                       },
-                      "models/ref/cli/wandb-launch",
-                      "models/ref/cli/wandb-launch-agent",
-                      "models/ref/cli/wandb-launch-sweep",
+                      "models/ref/cli/wandb-local",
                       "models/ref/cli/wandb-login",
+                      "models/ref/cli/wandb-off",
                       "models/ref/cli/wandb-offline",
+                      "models/ref/cli/wandb-on",
                       "models/ref/cli/wandb-online",
+                      "models/ref/cli/wandb-projects",
                       "models/ref/cli/wandb-pull",
                       "models/ref/cli/wandb-restore",
-                      "models/ref/cli/wandb-scheduler",
                       {
                         "group": "wandb server",
                         "pages": [
+                          "models/ref/cli/wandb-server",
                           "models/ref/cli/wandb-server/wandb-server-start",
                           "models/ref/cli/wandb-server/wandb-server-stop"
                         ]
@@ -2299,15 +2305,15 @@
     {
       "source": "/guides/integrations/pytorch",
       "destination": "/models/integrations"
-    },   
+    },
     {
       "source": "/guides/launch/:slug*",
       "destination": "/platform/launch/:slug*"
     },
     {
       "source": "/models/registry/model_registry/:slug*",
       "destination": "/models/registry"
-    }, 
+    },
     {
       "source": "/guides/registry/:slug*",
       "destination": "/models/registry/:slug*"
@@ -2490,4 +2496,4 @@
     }
   ],
   "baseUrl": "https://docs.wandb.ai"
-}
+}

models/ref/cli.mdx

@@ -3,45 +3,52 @@ title: CLI overview
 description: Use the W&B Command Line Interface (CLI) to log in, run jobs, execute sweeps, and more using shell commands
 ---
 
-**Usage**
+{/* AUTO-GENERATED CONTENT STARTS HERE */}
+{/* WARNING: Do not edit below this line. This content is auto-generated by scripts/cli-docs-generator.py */}
 
-`wandb [OPTIONS] COMMAND [ARGS]...`
+## Usage
 
+```bash
+wandb [OPTIONS] COMMAND [ARGS]...
+```
 
+## Options
 
-**Options**
-
-| **Option** | **Description** |
+| Option | Description |
 | :--- | :--- |
-| `--version` | Show the version and exit. |
-
+| `--version` | Show the version and exit. (default: False) |
 
-**Commands**
+## Commands
 
-| **Command** | **Description** |
+| Command | Description |
 | :--- | :--- |
 | [agent](/models/ref/cli/wandb-agent) | Run the W&B agent |
 | [artifact](/models/ref/cli/wandb-artifact) | Commands for interacting with artifacts |
 | [beta](/models/ref/cli/wandb-beta) | Beta versions of wandb CLI commands. |
 | [controller](/models/ref/cli/wandb-controller) | Run the W&B local sweep controller |
 | [disabled](/models/ref/cli/wandb-disabled) | Disable W&B. |
 | [docker](/models/ref/cli/wandb-docker) | Run your code in a docker container. |
-| [docker-run](/models/ref/cli/wandb-docker-run) | Wrap `docker run` and adds WANDB_API_KEY and WANDB_DOCKER... |
+| [docker-run](/models/ref/cli/wandb-docker-run) | Wrap `docker run` and adds WANDB_API_KEY and WANDB_DOCKER environment variables. |
 | [enabled](/models/ref/cli/wandb-enabled) | Enable W&B. |
 | [init](/models/ref/cli/wandb-init) | Configure a directory with Weights & Biases |
 | [job](/models/ref/cli/wandb-job) | Commands for managing and viewing W&B jobs |
 | [launch](/models/ref/cli/wandb-launch) | Launch or queue a W&B Job. |
 | [launch-agent](/models/ref/cli/wandb-launch-agent) | Run a W&B launch agent. |
 | [launch-sweep](/models/ref/cli/wandb-launch-sweep) | Run a W&B launch sweep (Experimental). |
-| [login](/models/ref/cli/wandb-login) | Login to Weights & Biases |
-| [offline](/models/ref/cli/wandb-offline) | Disable W&B sync |
-| [online](/models/ref/cli/wandb-online) | Enable W&B sync |
+| [local](/models/ref/cli/wandb-local) | Start a local W&B container (deprecated, see wandb server --help) |
+| [login](/models/ref/cli/wandb-login) | Verify and store your API key for authentication with W&B services. |
+| [off](/models/ref/cli/wandb-off) | No description available |
+| [offline](/models/ref/cli/wandb-offline) | Save data logged to W&B locally without uploading it to the cloud. |
+| [on](/models/ref/cli/wandb-on) | No description available |
+| [online](/models/ref/cli/wandb-online) | Undo `wandb offline`. |
+| [projects](/models/ref/cli/wandb-projects) | List projects |
 | [pull](/models/ref/cli/wandb-pull) | Pull files from Weights & Biases |
 | [restore](/models/ref/cli/wandb-restore) | Restore code, config and docker state for a run. |
 | [scheduler](/models/ref/cli/wandb-scheduler) | Run a W&B launch sweep scheduler (Experimental) |
 | [server](/models/ref/cli/wandb-server) | Commands for operating a local W&B server |
 | [status](/models/ref/cli/wandb-status) | Show configuration settings |
 | [sweep](/models/ref/cli/wandb-sweep) | Initialize a hyperparameter sweep. |
-| [sync](/models/ref/cli/wandb-sync) | Upload an offline training directory to W&B |
+| [sync](/models/ref/cli/wandb-sync) | Synchronize W&B run data to the cloud. |
 | [verify](/models/ref/cli/wandb-verify) | Checks and verifies local instance of W&B. |
 
+{/* AUTO-GENERATED CONTENT ENDS HERE */}

models/ref/cli/wandb-agent.mdx

@@ -1,23 +1,25 @@
 ---
-title: "wandb agent"
+title: wandb agent
 ---
 
-**Usage**
+Run the W&B agent
 
-`wandb agent [OPTIONS] SWEEP_ID`
+## Usage
 
-**Summary**
+```bash
+wandb agent SWEEP_ID [OPTIONS]
+```
 
-Run the W&B agent
+## Arguments
 
+| Argument | Description | Required |
+| :--- | :--- | :--- |
+| `SWEEP_ID` | No description available | Yes |
 
-**Options**
+## Options
 
-| **Option** | **Description** |
+| Option | Description |
 | :--- | :--- |
-| `-p, --project` | The name of the project where W&B runs created from the   sweep are sent to. If the project is not specified, the run is sent to a project labeled 'Uncategorized'. |
-| `-e, --entity` | The username or team name where you want to send W&B   runs created by the sweep to. Ensure that the entity you specify already exists. If you don't specify an entity,   the run will be sent to your default entity, which is usually your username. |
+| `--project`, `-p` | The name of the project where W&B runs created from the sweep are sent to. If the project is not specified, the run is sent to a project labeled 'Uncategorized'. |
+| `--entity`, `-e` | The username or team name where you want to send W&B runs created by the sweep to. Ensure that the entity you specify already exists. If you don't specify an entity, the run will be sent to your default entity, which is usually your username. |
 | `--count` | The max number of runs for this agent. |
-
-
-

models/ref/cli/wandb-artifact.mdx

@@ -1,28 +1,20 @@
----
-title: wandb artifact
----
-
-**Usage**
-
-`wandb artifact [OPTIONS] COMMAND [ARGS]...`
-
-**Summary**
-
-Commands for interacting with artifacts
-
-
-**Options**
-
-| **Option** | **Description** |
-| :--- | :--- |
-
-
-**Commands**
-
-| **Command** | **Description** |
-| :--- | :--- |
-| cache | Commands for interacting with the artifact cache |
-| get | Download an artifact from wandb |
-| ls | List all artifacts in a wandb project |
-| put | Upload an artifact to wandb |
-
+---
+title: wandb artifact
+---
+
+Commands for interacting with artifacts
+
+## Usage
+
+```bash
+wandb artifact COMMAND [ARGS]...
+```
+
+## Commands
+
+| Command | Description |
+| :--- | :--- |
+| [cache](/models/ref/cli/wandb-artifact/wandb-artifact-cache) | Commands for interacting with the artifact cache |
+| [get](/models/ref/cli/wandb-artifact/wandb-artifact-get) | Download an artifact from wandb |
+| [ls](/models/ref/cli/wandb-artifact/wandb-artifact-ls) | List all artifacts in a wandb project |
+| [put](/models/ref/cli/wandb-artifact/wandb-artifact-put) | Upload an artifact to wandb |

models/ref/cli/wandb-artifact/wandb-artifact-cache.mdx

@@ -1,25 +1,17 @@
----
-title: wandb artifact cache
----
-
-**Usage**
-
-`wandb artifact cache [OPTIONS] COMMAND [ARGS]...`
-
-**Summary**
-
-Commands for interacting with the artifact cache
-
-
-**Options**
-
-| **Option** | **Description** |
-| :--- | :--- |
-
-
-**Commands**
-
-| **Command** | **Description** |
-| :--- | :--- |
-| cleanup | Clean up less frequently used files from the artifacts cache |
-
+---
+title: wandb artifact cache
+---
+
+Commands for interacting with the artifact cache
+
+## Usage
+
+```bash
+wandb artifact cache COMMAND [ARGS]...
+```
+
+## Commands
+
+| Command | Description |
+| :--- | :--- |
+| [cleanup](/models/ref/cli/wandb-artifact/wandb-artifact-cache/wandb-artifact-cache-cleanup) | Clean up less frequently used files from the artifacts cache |

models/ref/cli/wandb-artifact/wandb-artifact-cache/wandb-artifact-cache-cleanup.mdx

@@ -1,21 +1,23 @@
 ---
-title: "wandb artifact cache cleanup"
+title: wandb artifact cache cleanup
 ---
 
-**Usage**
-
-`wandb artifact cache cleanup [OPTIONS] TARGET_SIZE`
-
-**Summary**
-
 Clean up less frequently used files from the artifacts cache
 
+## Usage
 
-**Options**
+```bash
+wandb cleanup TARGET_SIZE [OPTIONS]
+```
 
-| **Option** | **Description** |
-| :--- | :--- |
-| `--remove-temp / --no-remove-temp` | Remove temp files |
+## Arguments
 
+| Argument | Description | Required |
+| :--- | :--- | :--- |
+| `TARGET_SIZE` | No description available | Yes |
 
+## Options
 
+| Option | Description |
+| :--- | :--- |
+| `--remove-temp` | Remove temp files (default: False) |

models/ref/cli/wandb-artifact/wandb-artifact-get.mdx

@@ -1,22 +1,24 @@
 ---
-title: "wandb artifact get"
+title: wandb artifact get
 ---
 
-**Usage**
+Download an artifact from wandb
 
-`wandb artifact get [OPTIONS] PATH`
+## Usage
 
-**Summary**
+```bash
+wandb get PATH [OPTIONS]
+```
 
-Download an artifact from wandb
+## Arguments
 
+| Argument | Description | Required |
+| :--- | :--- | :--- |
+| `PATH` | No description available | Yes |
 
-**Options**
+## Options
 
-| **Option** | **Description** |
+| Option | Description |
 | :--- | :--- |
 | `--root` | The directory you want to download the artifact to |
 | `--type` | The type of artifact you are downloading |
-
-
-

models/ref/cli/wandb-artifact/wandb-artifact-ls.mdx

@@ -1,21 +1,23 @@
 ---
-title: "wandb artifact ls"
+title: wandb artifact ls
 ---
 
-**Usage**
-
-`wandb artifact ls [OPTIONS] PATH`
-
-**Summary**
-
 List all artifacts in a wandb project
 
+## Usage
 
-**Options**
+```bash
+wandb ls PATH [OPTIONS]
+```
 
-| **Option** | **Description** |
-| :--- | :--- |
-| `-t, --type` | The type of artifacts to list |
+## Arguments
 
+| Argument | Description | Required |
+| :--- | :--- | :--- |
+| `PATH` | No description available | Yes |
 
+## Options
 
+| Option | Description |
+| :--- | :--- |
+| `--type`, `-t` | The type of artifacts to list |