docs: Add docs for finch vm settings command

In my previous pull request, we added the functionality to change the number of CPUs and memory size allocated to VMs. - #887 However, at that time, we did not add documentations for the finch vm settings command. Therefore, in this fix, we will add documentations for the finch vm settings command. Signed-off-by: Hayato Kiwata <[email protected]>
runfinch · May 8, 2024 · a88615a · a88615a
1 parent 79eb863
commit a88615a
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/cmd/finch_vm_settings.md b/docs/cmd/finch_vm_settings.md
@@ -0,0 +1,15 @@
+# finch vm settings
+
+Configure the virtual machine instance
+
+```text
+  finch vm settings [flags]
+```
+
+## Options
+
+```text
+      --cpus int        the amount of vCPU to dedicate to the virtual machine (restart the vm when applying this change.)
+  -h, --help            help for settings
+      --memory string   the amount of memory to dedicate to the virtual machine (restart the vm when applying this change.)
+```