Add documentation to the commands for the CLI

src/cli/commands/mnemonic.ts

@@ -41,9 +41,11 @@ export const handleMnemonicCommand = async (
   args: string[],
   options: Record<string, string>,
 ): Promise<{ savedAs?: string; count?: number; mnemonic?: string }> => {
+  // Get the sub-command from the arguments
   const subCommand = args[0];
   const { mnemonicsDir } = deps.paths;
 
+  // If no sub-command is provided, print the help message and throw an error
   if (!subCommand) {
     deps.io.verbose("No sub-command provided");
     printMnemonicHelp(deps.io);
@@ -53,22 +55,29 @@ export const handleMnemonicCommand = async (
     );
   }
 
+  // Handle the sub-command
   switch (subCommand) {
     case "create": {
+      // Create a new mnemonic seed
       const mnemonicSeed = createMnemonicSeed();
+
+      // Create a new mnemonic file
       const savedAs = createMnemonicFile(
         mnemonicsDir,
         mnemonicSeed,
         options["output"],
       );
 
+      // Display the mnemonic file to the user
       deps.io.out(`Mnemonic file created: ${savedAs} (${mnemonicSeed})`);
       return { savedAs };
     }
 
     case "import": {
+      // Get the mnemonic seed from the arguments
       const mnemonicSeed = args.slice(1).join(" ");
 
+      // If no mnemonic seed is provided, print the help message and throw an error
       if (!mnemonicSeed) {
         deps.io.verbose("No mnemonic seed provided");
         printMnemonicHelp(deps.io);
@@ -78,25 +87,33 @@ export const handleMnemonicCommand = async (
         );
       }
 
+      // Create a new mnemonic file
       deps.io.verbose(`Mnemonic seed: ${mnemonicSeed}`);
       const savedAs = createMnemonicFile(
         mnemonicsDir,
         mnemonicSeed,
         options["output"],
       );
+
+      // Display the mnemonic file to the user
       deps.io.out(`Mnemonic file created: ${savedAs}`);
       return { savedAs };
     }
 
     case "list": {
+      // List all the mnemonic files
       const mnemonicFiles = listMnemonicFiles(mnemonicsDir);
       deps.io.out(mnemonicFiles.join("\n"));
+
+      // Return the number of mnemonic files
       return { count: mnemonicFiles.length };
     }
 
     case "expose": {
+      // Get the mnemonic file from the arguments
       const mnemonicFile = args[1];
 
+      // If no mnemonic file is provided, print the help message and throw an error
       if (!mnemonicFile) {
         deps.io.verbose("No mnemonic file provided");
         printMnemonicHelp(deps.io);
@@ -106,11 +123,15 @@ export const handleMnemonicCommand = async (
         );
       }
 
+      // Try to load the mnemonic file
       try {
         const mnemonic = loadMnemonic(mnemonicsDir, mnemonicFile);
         deps.io.out(mnemonic);
+
+        // Return the mnemonic
         return { mnemonic };
       } catch (error) {
+        // If the mnemonic file is not found, print an error and throw an error
         throw new CommandError(
           "mnemonic.expose.file_not_found",
           `Mnemonic file not found: ${mnemonicFile}`,
@@ -119,6 +140,7 @@ export const handleMnemonicCommand = async (
     }
 
     default:
+      // If the sub-command is not found, print an error and throw an error
       deps.io.err(`Unknown sub-command: ${subCommand}`);
       printMnemonicHelp(deps.io);
       throw new CommandError(