Refactor: Mark all required options as [Required]

Co-authored-by: danieltaox <[email protected]>

Author: cursoragent

src/lib/clusters/clusters.tsx

@@ -50,10 +50,10 @@ export function registerClusters(program: Command) {
   users
     .command("add")
     .description("Add a user to a cluster (always regenerates keys)")
-    .requiredOption("--cluster <cluster>", "name of the cluster")
+    .requiredOption("--cluster <cluster>", "[Required] name of the cluster")
     .requiredOption(
       "--user <username>",
-      "Username to add. Must follow RFC 1123 subdomain rules (lowercase alphanumeric with hyphens). Non-compliant names will be automatically sanitized.",
+      "[Required] Username to add. Must follow RFC 1123 subdomain rules (lowercase alphanumeric with hyphens). Non-compliant names will be automatically sanitized.",
     )
     .option("--json", "Output in JSON format")
     .option("--token <token>", "API token")

src/lib/extend/index.tsx

@@ -24,11 +24,11 @@ function _registerExtend(program: Command) {
     .description("Extend an existing contract")
     .requiredOption(
       "-c, --contract <contract>",
-      "Contract ID to extend e.g. cont_a9IcKaLesUBTHEY",
+      "[Required] Contract ID to extend e.g. cont_a9IcKaLesUBTHEY",
     )
     .requiredOption(
       "-d, --duration <duration>",
-      "Extension duration (rounded up to the nearest hour)",
+      "[Required] Extension duration (rounded up to the nearest hour)",
       parseDuration,
     )
     .option(

src/lib/nodes/image/upload.ts

@@ -48,8 +48,8 @@ async function readChunk(
 
 const upload = new Command("upload")
   .description("Upload a VM image file (multipart)")
-  .requiredOption("-f, --file <file>", "Path to the image file")
-  .requiredOption("-n, --name <name>", "Image name")
+  .requiredOption("-f, --file <file>", "[Required] Path to the image file")
+  .requiredOption("-n, --name <name>", "[Required] Image name")
   .option(
     "-c, --concurrency <number>",
     "Number of parts to upload concurrently",

src/lib/scale/create.tsx

@@ -303,7 +303,7 @@ $ sf scale create -n 8 --horizon '30m'
   .showHelpAfterError()
   .requiredOption(
     "-n, --accelerators <accelerators>",
-    "Desired number of GPUs (0 to turn off)",
+    "[Required] Desired number of GPUs (0 to turn off)",
     parseAccelerators,
   )
   .option("-t, --type <type>", "Specify node type", "h100i")

src/lib/sell.ts

@@ -24,8 +24,8 @@ export function registerSell(program: Command) {
   program
     .command("sell")
     .description("Place a sell order")
-    .requiredOption("-p, --price <price>", "The price in dollars, per GPU hour")
-    .requiredOption("-c, --contract-id <id>", "Specify the contract ID")
+    .requiredOption("-p, --price <price>", "[Required] The price in dollars, per GPU hour")
+    .requiredOption("-c, --contract-id <id>", "[Required] Specify the contract ID")
     .option(
       "-n, --accelerators <quantity>",
       "Specify the number of GPUs",

src/lib/sell/index.tsx

@@ -34,8 +34,8 @@ export function registerSell(program: Command) {
   program
     .command("sell")
     .description("Place a sell order")
-    .requiredOption("-p, --price <price>", "The price in dollars, per GPU hour")
-    .requiredOption("-c, --contract-id <id>", "Specify the contract ID")
+    .requiredOption("-p, --price <price>", "[Required] The price in dollars, per GPU hour")
+    .requiredOption("-c, --contract-id <id>", "[Required] Specify the contract ID")
     .option("-n, --accelerators <quantity>", "Specify the number of GPUs", "8")
     .option(
       "-s, --start <start>",

src/lib/tokens.ts

@@ -43,7 +43,7 @@ export function registerTokens(program: Command) {
     .command("delete")
     .alias("rm")
     .description("Delete a token")
-    .requiredOption("--id <id>", "Specify the token ID")
+    .requiredOption("--id <id>", "[Required] Specify the token ID")
     .option("--yes", "Force delete the token, skipping confirmation")
     .action(deleteTokenAction);
 }

src/lib/vm/logs.ts

@@ -34,7 +34,7 @@ function formatTimestampToISO(timestamp: string): string {
 
 const logs = new Command("logs")
   .description("View or tail VM logs")
-  .requiredOption("-i, --instance <id>", "VM instance ID")
+  .requiredOption("-i, --instance <id>", "[Required] VM instance ID")
   .option(
     "-l, --limit <number>",
     "Number of log lines to fetch",

src/lib/vm/replace.ts

@@ -12,7 +12,7 @@ import { getApiUrl } from "../../helpers/urls.ts";
 
 const replace = new Command("replace")
   .description("Replace a virtual machine")
-  .requiredOption("-i, --id <id>", "ID of the VM to replace")
+  .requiredOption("-i, --id <id>", "[Required] ID of the VM to replace")
   .option("-y, --yes", "Automatically confirm the command.")
   .action(async (options) => {
     if (!options.yes) {

src/lib/vm/script.ts

@@ -10,7 +10,7 @@ import { getApiUrl } from "../../helpers/urls.ts";
 
 const script = new Command("script")
   .description("Push a startup script to VMs")
-  .requiredOption("-f, --file <file>", "Path to startup script file")
+  .requiredOption("-f, --file <file>", "[Required] Path to startup script file")
   .action(async (options) => {
     let script: string;
     try {