Merge pull request #80 from nihaltp/des

anshumanjadiya1102 · web-flow · commit d9ef9fa89525 · 2025-10-28T16:02:33.000+05:30
update description &amp; usage
diff --git a/src/main/java/com/mycmd/commands/AliasCommand.java b/src/main/java/com/mycmd/commands/AliasCommand.java
@@ -26,7 +26,7 @@ public void execute(String[] args, ShellContext context) throws IOException {
             String name = parts[0].trim();
             String cmd = parts[1].trim();
             if (name.isEmpty() || cmd.isEmpty()) {
-                System.out.println("Invalid alias format. Usage: alias name=command");
+                System.out.println("Invalid alias format. Usage: \n" + usage());
                 return;
             }
             context.addAlias(name, cmd);
@@ -44,15 +44,15 @@ public void execute(String[] args, ShellContext context) throws IOException {
             }
             String cmd = sb.toString();
             if (name.trim().isEmpty() || cmd.trim().isEmpty()) {
-                System.out.println("Invalid alias. Usage: alias name command... or alias name=command");
+                System.out.println("Invalid alias. Usage: \n" + usage());
                 return;
             }
             context.addAlias(name, cmd);
             System.out.println("Alias added: " + name + "=" + cmd);
             return;
         }
 
-        System.out.println("Invalid usage. Usage: alias [name=command] | alias [name command...]");
+        System.out.println("Invalid usage. Usage: " + usage());
     }
 
     @Override
diff --git a/src/main/java/com/mycmd/commands/CdCommand.java b/src/main/java/com/mycmd/commands/CdCommand.java
@@ -53,4 +53,14 @@ public void execute(String[] args, ShellContext context) {
             System.out.println("The system cannot find the path specified.");
         }
     }
+
+    @Override
+    public String description() {
+        return "Change the current working directory or display it.";
+    }
+
+    @Override
+    public String usage() {
+        return "cd [path]";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/ClsCommand.java b/src/main/java/com/mycmd/commands/ClsCommand.java
@@ -34,4 +34,14 @@ public void execute(String[] args, ShellContext context) {
             System.out.println("Error while clearing the screen: " + e.getMessage());
         }
     }
+
+    @Override
+    public String description() {
+        return "Clear the console screen.";
+    }
+
+    @Override
+    public String usage() {
+        return "cls";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/ColorCommand.java b/src/main/java/com/mycmd/commands/ColorCommand.java
@@ -26,7 +26,7 @@ public void execute(String[] args, ShellContext context) {
             String color = args[0];
 
             if (color.length() != 2) {
-                System.out.println("Usage: color <background><text>");
+                System.out.println("Usage: " + usage());
                 return;
             }
 
@@ -67,4 +67,17 @@ public void execute(String[] args, ShellContext context) {
             System.out.println("\033[0m");
         }
     }
+
+    @Override
+    public String description() {
+        return "Change console text and background colors.";
+    }
+
+    @Override
+    public String usage() {
+        return "color [<background><text>]\n" +
+               "  <background> and <text> are hexadecimal digits (0-9, A-F).\n" +
+               "  Example: color 0A sets black background with bright green text.\n" +
+               "  Call without arguments to reset to default colors.";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/CopyCommand.java b/src/main/java/com/mycmd/commands/CopyCommand.java
@@ -22,7 +22,7 @@ public class CopyCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) {
         if (args.length < 2) {
-            System.out.println("Usage: copy <source> <destination>");
+            System.out.println("Usage: " + usage());
             return;
         }
         File src = new File(context.getCurrentDir(), args[0]);
@@ -43,4 +43,14 @@ public void execute(String[] args, ShellContext context) {
             System.out.println("Error copying file: " + e.getMessage());
         }
     }
+
+    @Override
+    public String description() {
+        return "Copy a file from source to destination.";
+    }
+
+    @Override
+    public String usage() {
+        return "copy <source> <destination>";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/DelCommand.java b/src/main/java/com/mycmd/commands/DelCommand.java
@@ -21,7 +21,7 @@ public class DelCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) {
         if (args.length == 0) {
-            System.out.println("Usage: del <file_name>");
+            System.out.println("Usage: " + usage());
             return;
         }
         for (String name : args) {
@@ -35,4 +35,14 @@ public void execute(String[] args, ShellContext context) {
             }
         }
     }
+
+    @Override
+    public String description() {
+        return "Delete one or more files.";
+    }
+
+    @Override
+    public String usage() {
+        return "del <file1> [file2 ...]";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/HistoryCommand.java b/src/main/java/com/mycmd/commands/HistoryCommand.java
@@ -20,4 +20,14 @@ public void execute(String[] args, ShellContext context) {
             System.out.println((i + 1) + ". " + history.get(i));
         }
     }
+
+    @Override
+    public String description() {
+        return "Display the list of previously executed commands.";
+    }
+
+    @Override
+    public String usage() {
+        return "history";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/HostnameCommand.java b/src/main/java/com/mycmd/commands/HostnameCommand.java
@@ -31,4 +31,14 @@ public void execute(String[] args, ShellContext context) {
         }
         System.out.println(hostname);
     }
+
+    @Override
+    public String description() {
+        return "Display the hostname of the current computer.";
+    }
+
+    @Override
+    public String usage() {
+        return "hostname";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/MkdirCommand.java b/src/main/java/com/mycmd/commands/MkdirCommand.java
@@ -20,7 +20,7 @@ public class MkdirCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) {
         if (args.length == 0) {
-            System.out.println("Usage: mkdir <directory_name>");
+            System.out.println("Usage: " + usage());
             return;
         }
         File dir = new File(context.getCurrentDir(), args[0]);
@@ -32,4 +32,14 @@ public void execute(String[] args, ShellContext context) {
             System.out.println("Failed to create directory.");
         }
     }
+
+    @Override
+    public String description() {
+        return "Create a new directory.";
+    }
+
+    @Override
+    public String usage() {
+        return "mkdir <directory_name>";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/MoveCommand.java b/src/main/java/com/mycmd/commands/MoveCommand.java
@@ -23,7 +23,7 @@ public class MoveCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) throws IOException {
         if (args.length < 2) {
-            System.out.println("Usage: move <source> <destination>");
+            System.out.println("Usage: " + usage());
             return;
         }
 
diff --git a/src/main/java/com/mycmd/commands/RmdirCommand.java b/src/main/java/com/mycmd/commands/RmdirCommand.java
@@ -23,7 +23,7 @@ public class RmdirCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) {
         if (args.length == 0) {
-            System.out.println("Usage: rmdir <directory_name>");
+            System.out.println("Usage: " + usage());
             return;
         }
         File dir = new File(context.getCurrentDir(), args[0]);
@@ -37,4 +37,14 @@ public void execute(String[] args, ShellContext context) {
             System.out.println("Failed to delete directory.");
         }
     }
+
+    @Override
+    public String description() {
+        return "Remove an empty directory.";
+    }
+
+    @Override
+    public String usage() {
+        return "rmdir <directory_name>";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/TelnetCommand.java b/src/main/java/com/mycmd/commands/TelnetCommand.java
@@ -19,7 +19,7 @@ public class TelnetCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) throws IOException {
         if (args.length < 1) {
-            System.out.println("Usage: telnet <host> [port]");
+            System.out.println("Usage: " + usage());
             return;
         }
 
diff --git a/src/main/java/com/mycmd/commands/TimeCommand.java b/src/main/java/com/mycmd/commands/TimeCommand.java
@@ -32,4 +32,14 @@ public void execute(String[] args, ShellContext context) {
         String formattedTime = now.format(formatter);
         System.out.println("The current time is: " + formattedTime);
     }
+
+    @Override
+    public String description() {
+        return "Display the current local time.";
+    }
+
+    @Override
+    public String usage() {
+        return "time";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/TitleCommand.java b/src/main/java/com/mycmd/commands/TitleCommand.java
@@ -23,8 +23,17 @@ public void execute(String[] args, ShellContext context) {
             String title = String.join(" ", args);
             System.out.println("\033]0;" + title + "\007");
         } else {
-            System.out.println("Usage: title <new title>");
+            System.out.println("Usage: " + usage());
         }
     }
     
+    @Override
+    public String description() {
+        return "Set the terminal window title.";
+    }
+
+    @Override
+    public String usage() {
+        return "title <new title>";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/TouchCommand.java b/src/main/java/com/mycmd/commands/TouchCommand.java
@@ -22,8 +22,8 @@
 public class TouchCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) throws IOException {
-        if (args.length < 1) {  // ✅ Check for at least 1 argument
-            System.out.println("Usage: touch <filename>");
+        if (args.length < 1) { // ✅ Check for at least 1 argument
+            System.out.println("Usage: " + usage());
             return;
         }
         
@@ -36,4 +36,14 @@ public void execute(String[] args, ShellContext context) throws IOException {
             System.out.println("File timestamp updated: " + args[0]);  // ✅ Use args[0]
         }
     }
+
+    @Override
+    public String description() {
+        return "Create a new empty file or update the timestamp of an existing file.";
+    }
+
+    @Override
+    public String usage() {
+        return "touch <filename>";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/TreeCommand.java b/src/main/java/com/mycmd/commands/TreeCommand.java
@@ -51,4 +51,14 @@ private void printDirectory(File[] files, String prefix, boolean isLast) {
             }
         }
     }
+
+    @Override
+    public String description() {
+        return "Display the directory tree structure.";
+    }
+
+    @Override
+    public String usage() {
+        return "tree";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/TypeCommand.java b/src/main/java/com/mycmd/commands/TypeCommand.java
@@ -23,7 +23,7 @@ public class TypeCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) {
         if (args.length == 0) {
-            System.out.println("Usage: type <file_name>");
+            System.out.println("Usage: " + usage());
             return;
         }
         File file = new File(context.getCurrentDir(), args[0]);
@@ -40,4 +40,14 @@ public void execute(String[] args, ShellContext context) {
             System.out.println("Error reading file: " + e.getMessage());
         }
     }
+
+    @Override
+    public String description() {
+        return "Display the contents of a text file.";
+    }
+
+    @Override
+    public String usage() {
+        return "type <file_name>";
+    }
 }
diff --git a/src/main/java/com/mycmd/commands/UnaliasCommand.java b/src/main/java/com/mycmd/commands/UnaliasCommand.java
@@ -9,7 +9,7 @@ public class UnaliasCommand implements Command {
     @Override
     public void execute(String[] args, ShellContext context) throws IOException {
         if (args == null || args.length == 0) {
-            System.out.println("Usage: unalias name [name2 ...]");
+            System.out.println("Usage: " + usage());
             return;
         }
 
diff --git a/src/main/java/com/mycmd/commands/VersionCommand.java b/src/main/java/com/mycmd/commands/VersionCommand.java
@@ -20,4 +20,14 @@ public class VersionCommand implements Command {
     public void execute(String[] args, ShellContext context) {
         System.out.println("MyCMD Java Shell v1.0");
     }
+
+    @Override
+    public String description() {
+        return "Display the version information of the MyCMD shell.";
+    }
+
+    @Override
+    public String usage() {
+        return "ver";
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public void execute(String[] args, ShellContext context) throws IOException {`
`26`	`26`	`String name = parts[0].trim();`
`27`	`27`	`String cmd = parts[1].trim();`
`28`	`28`	`if (name.isEmpty() \|\| cmd.isEmpty()) {`
`29`		`- System.out.println("Invalid alias format. Usage: alias name=command");`
	`29`	`+ System.out.println("Invalid alias format. Usage: \n" + usage());`
`30`	`30`	`return;`
`31`	`31`	`}`
`32`	`32`	`context.addAlias(name, cmd);`
`@@ -44,15 +44,15 @@ public void execute(String[] args, ShellContext context) throws IOException {`
`44`	`44`	`}`
`45`	`45`	`String cmd = sb.toString();`
`46`	`46`	`if (name.trim().isEmpty() \|\| cmd.trim().isEmpty()) {`
`47`		`- System.out.println("Invalid alias. Usage: alias name command... or alias name=command");`
	`47`	`+ System.out.println("Invalid alias. Usage: \n" + usage());`
`48`	`48`	`return;`
`49`	`49`	`}`
`50`	`50`	`context.addAlias(name, cmd);`
`51`	`51`	`System.out.println("Alias added: " + name + "=" + cmd);`
`52`	`52`	`return;`
`53`	`53`	`}`
`54`	`54`
`55`		`- System.out.println("Invalid usage. Usage: alias [name=command] \| alias [name command...]");`
	`55`	`+ System.out.println("Invalid usage. Usage: " + usage());`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -53,4 +53,14 @@ public void execute(String[] args, ShellContext context) {`
`53`	`53`	`System.out.println("The system cannot find the path specified.");`
`54`	`54`	`}`
`55`	`55`	`}`
	`56`	`+`
	`57`	`+ @Override`
	`58`	`+ public String description() {`
	`59`	`+ return "Change the current working directory or display it.";`
	`60`	`+ }`
	`61`	`+`
	`62`	`+ @Override`
	`63`	`+ public String usage() {`
	`64`	`+ return "cd [path]";`
	`65`	`+ }`
`56`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,14 @@ public void execute(String[] args, ShellContext context) {`
`34`	`34`	`System.out.println("Error while clearing the screen: " + e.getMessage());`
`35`	`35`	`}`
`36`	`36`	`}`
	`37`	`+`
	`38`	`+ @Override`
	`39`	`+ public String description() {`
	`40`	`+ return "Clear the console screen.";`
	`41`	`+ }`
	`42`	`+`
	`43`	`+ @Override`
	`44`	`+ public String usage() {`
	`45`	`+ return "cls";`
	`46`	`+ }`
`37`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public class CopyCommand implements Command {`
`22`	`22`	`@Override`
`23`	`23`	`public void execute(String[] args, ShellContext context) {`
`24`	`24`	`if (args.length < 2) {`
`25`		`- System.out.println("Usage: copy <source> <destination>");`
	`25`	`+ System.out.println("Usage: " + usage());`
`26`	`26`	`return;`
`27`	`27`	`}`
`28`	`28`	`File src = new File(context.getCurrentDir(), args[0]);`
`@@ -43,4 +43,14 @@ public void execute(String[] args, ShellContext context) {`
`43`	`43`	`System.out.println("Error copying file: " + e.getMessage());`
`44`	`44`	`}`
`45`	`45`	`}`
	`46`	`+`
	`47`	`+ @Override`
	`48`	`+ public String description() {`
	`49`	`+ return "Copy a file from source to destination.";`
	`50`	`+ }`
	`51`	`+`
	`52`	`+ @Override`
	`53`	`+ public String usage() {`
	`54`	`+ return "copy <source> <destination>";`
	`55`	`+ }`
`46`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public class DelCommand implements Command {`
`21`	`21`	`@Override`
`22`	`22`	`public void execute(String[] args, ShellContext context) {`
`23`	`23`	`if (args.length == 0) {`
`24`		`- System.out.println("Usage: del <file_name>");`
	`24`	`+ System.out.println("Usage: " + usage());`
`25`	`25`	`return;`
`26`	`26`	`}`
`27`	`27`	`for (String name : args) {`
`@@ -35,4 +35,14 @@ public void execute(String[] args, ShellContext context) {`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`	`}`
	`38`	`+`
	`39`	`+ @Override`
	`40`	`+ public String description() {`
	`41`	`+ return "Delete one or more files.";`
	`42`	`+ }`
	`43`	`+`
	`44`	`+ @Override`
	`45`	`+ public String usage() {`
	`46`	`+ return "del <file1> [file2 ...]";`
	`47`	`+ }`
`38`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,14 @@ public void execute(String[] args, ShellContext context) {`
`20`	`20`	`System.out.println((i + 1) + ". " + history.get(i));`
`21`	`21`	`}`
`22`	`22`	`}`
	`23`	`+`
	`24`	`+ @Override`
	`25`	`+ public String description() {`
	`26`	`+ return "Display the list of previously executed commands.";`
	`27`	`+ }`
	`28`	`+`
	`29`	`+ @Override`
	`30`	`+ public String usage() {`
	`31`	`+ return "history";`
	`32`	`+ }`
`23`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,14 @@ public void execute(String[] args, ShellContext context) {`
`31`	`31`	`}`
`32`	`32`	`System.out.println(hostname);`
`33`	`33`	`}`
	`34`	`+`
	`35`	`+ @Override`
	`36`	`+ public String description() {`
	`37`	`+ return "Display the hostname of the current computer.";`
	`38`	`+ }`
	`39`	`+`
	`40`	`+ @Override`
	`41`	`+ public String usage() {`
	`42`	`+ return "hostname";`
	`43`	`+ }`
`34`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public class MkdirCommand implements Command {`
`20`	`20`	`@Override`
`21`	`21`	`public void execute(String[] args, ShellContext context) {`
`22`	`22`	`if (args.length == 0) {`
`23`		`- System.out.println("Usage: mkdir <directory_name>");`
	`23`	`+ System.out.println("Usage: " + usage());`
`24`	`24`	`return;`
`25`	`25`	`}`
`26`	`26`	`File dir = new File(context.getCurrentDir(), args[0]);`
`@@ -32,4 +32,14 @@ public void execute(String[] args, ShellContext context) {`
`32`	`32`	`System.out.println("Failed to create directory.");`
`33`	`33`	`}`
`34`	`34`	`}`
	`35`	`+`
	`36`	`+ @Override`
	`37`	`+ public String description() {`
	`38`	`+ return "Create a new directory.";`
	`39`	`+ }`
	`40`	`+`
	`41`	`+ @Override`
	`42`	`+ public String usage() {`
	`43`	`+ return "mkdir <directory_name>";`
	`44`	`+ }`
`35`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public class MoveCommand implements Command {`
`23`	`23`	`@Override`
`24`	`24`	`public void execute(String[] args, ShellContext context) throws IOException {`
`25`	`25`	`if (args.length < 2) {`
`26`		`- System.out.println("Usage: move <source> <destination>");`
	`26`	`+ System.out.println("Usage: " + usage());`
`27`	`27`	`return;`
`28`	`28`	`}`
`29`	`29`