docs: add docs for --force option on start

dhis2 · Jul 24, 2024 · 4bcb812 · 4bcb812
1 parent eb2cc58
commit 4bcb812
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/cli/src/commands/start.js b/cli/src/commands/start.js
@@ -177,10 +177,16 @@ const command = {
     aliases: 's',
     desc: 'Start a development server running a DHIS2 app within the DHIS2 app-shell',
     builder: {
+        force: {
+            type: 'boolean',
+            description:
+                'Force updating the app shell. Normally, this is only done when a new version of @dhis2/cli-app-scripts is detected',
+        },
         port: {
             alias: 'p',
             type: 'number',
             description: 'The port to use when running the development server',
+            default: defaultPort,
         },
         proxy: {
             alias: 'P',

diff --git a/docs/scripts/start.md b/docs/scripts/start.md
@@ -19,10 +19,13 @@ Global Options:
   --config       Path to JSON config file
 
 Options:
-  --cwd       working directory to use (defaults to cwd)
-  --port, -p  The port to use when running the development server       [number]
+  --cwd        working directory to use (defaults to cwd)
+  --force      Force updating the app shell. Normally, this is only done when a
+               new version of @dhis2/cli-app-scripts is detected       [boolean]
+  --port, -p   The port to use when running the development server
+                                                        [number] [default: 3000]
   --proxy, -P  The remote DHIS2 instance the proxy should point to      [string]
   --proxyPort  The port to use when running the proxy   [number] [default: 8080]
   --host       Exposes the server on the local network. Can optionally provide
-              an address to use. [boolean or string]
+               an address to use. [boolean or string]
 ```