docs: document app and plugin options on start script

dhis2 · May 30, 2024 · 0ab866e · 0ab866e
1 parent 462f970
commit 0ab866e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/cli/src/commands/start.js b/cli/src/commands/start.js
@@ -186,6 +186,16 @@ const command = {
             description: 'The port to use when running the proxy',
             default: 8080,
         },
+        // todo: change with Vite
+        app: {
+            type: 'boolean',
+            description:
+                'Start a dev server for just the app entrypoint (instead of both app and plugin, if this app has a plugin)',
+        },
+        plugin: {
+            type: 'boolean',
+            description: 'Start a dev server for just the plugin entrypoint',
+        },
     },
     handler,
 }

diff --git a/docs/scripts/start.md b/docs/scripts/start.md
@@ -23,4 +23,7 @@ Options:
   --port, -p  The port to use when running the development server       [number]
   --proxy, -P  The remote DHIS2 instance the proxy should point to      [string]
   --proxyPort  The port to use when running the proxy   [number] [default: 8080]
+  --app        Start a dev server for just the app entrypoint (instead of both
+               app and plugin, if this app has a plugin)               [boolean]
+  --plugin     Start a dev server for just the plugin entrypoint       [boolean]
 ```