docs: options docs

Author: BioPhoton

packages/cli/README.md

@@ -207,20 +207,38 @@ Each example is fully tested to demonstrate best practices for plugin testing as
 
 ### Common Command Options
 
-| Option                      | Type                 | Default  | Description                                                                 |
-| --------------------------- | -------------------- | -------- | --------------------------------------------------------------------------- |
-| **`--persist.outputDir`**   | `string`             | n/a      | Directory for the produced reports.                                         |
-| **`--persist.filename`**    | `string`             | `report` | Filename for the produced reports without extension.                        |
-| **`--persist.format`**      | `('json' \| 'md')[]` | `json`   | Format(s) of the report file.                                               |
-| **`--persist.skipReports`** | `boolean`            | `false`  | Skip generating report files. (useful in combination with caching)          |
-| **`--upload.organization`** | `string`             | n/a      | Organization slug from portal.                                              |
-| **`--upload.project`**      | `string`             | n/a      | Project slug from portal.                                                   |
-| **`--upload.server`**       | `string`             | n/a      | URL to your portal server.                                                  |
-| **`--upload.apiKey`**       | `string`             | n/a      | API key for the portal server.                                              |
-| **`--cache.read`**          | `boolean`            | `false`  | If plugin audit outputs should be read from file system cache.              |
-| **`--cache.write`**         | `boolean`            | `false`  | If plugin audit outputs should be written to file system cache.             |
-| **`--onlyPlugins`**         | `string[]`           | `[]`     | Only run the specified plugins. Applicable to all commands except `upload`. |
-| **`--skipPlugins`**         | `string[]`           | `[]`     | Skip the specified plugins. Applicable to all commands except `upload`.     |
+#### Global Options
+
+| Option              | Type       | Default | Description                                                                 |
+| ------------------- | ---------- | ------- | --------------------------------------------------------------------------- |
+| **`--onlyPlugins`** | `string[]` | `[]`    | Only run the specified plugins. Applicable to all commands except `upload`. |
+| **`--skipPlugins`** | `string[]` | `[]`    | Skip the specified plugins. Applicable to all commands except `upload`.     |
+
+#### Cache Options
+
+| Option              | Type      | Default | Description                                                     |
+| ------------------- | --------- | ------- | --------------------------------------------------------------- |
+| **`--cache`**       | `boolean` | `false` | Cache runner outputs (both read and write).                     |
+| **`--cache.read`**  | `boolean` | `false` | If plugin audit outputs should be read from file system cache.  |
+| **`--cache.write`** | `boolean` | `false` | If plugin audit outputs should be written to file system cache. |
+
+#### Persist Options
+
+| Option                      | Type                 | Default  | Description                                                        |
+| --------------------------- | -------------------- | -------- | ------------------------------------------------------------------ |
+| **`--persist.outputDir`**   | `string`             | n/a      | Directory for the produced reports.                                |
+| **`--persist.filename`**    | `string`             | `report` | Filename for the produced reports without extension.               |
+| **`--persist.format`**      | `('json' \| 'md')[]` | `json`   | Format(s) of the report file.                                      |
+| **`--persist.skipReports`** | `boolean`            | `false`  | Skip generating report files. (useful in combination with caching) |
+
+#### Upload Options
+
+| Option                      | Type     | Default | Description                    |
+| --------------------------- | -------- | ------- | ------------------------------ |
+| **`--upload.organization`** | `string` | n/a     | Organization slug from portal. |
+| **`--upload.project`**      | `string` | n/a     | Project slug from portal.      |
+| **`--upload.server`**       | `string` | n/a     | URL to your portal server.     |
+| **`--upload.apiKey`**       | `string` | n/a     | API key for the portal server. |
 
 > [!NOTE]  
 > All common options, except `--onlyPlugins` and `--skipPlugins`, can be specified in the configuration file as well.

packages/cli/docs/nx-caching.md

@@ -77,8 +77,12 @@ export default {
       "options": {
         "command": "npx @code-pushup/cli",
         "config": "{projectRoot}/code-pushup.config.ts",
-        "cache.read": true,
-        "upload.project": "{projectName}",
+        "cache": {
+          "read": true
+        },
+        "upload": {
+          "project": "{projectName}"
+        },
         "outputPath": "{projectRoot}/.code-pushup"
       },
       "dependsOn": ["code-pushup:coverage"]