fix: Update metavar in argparse for clarity and consistency

Author: weilycoder

Jiyu_udp_attack/__main__.py

@@ -78,39 +78,39 @@ def format_usage(self) -> str:
         "-f",
         "--teacher-ip",
         type=str,
-        metavar="ip",
+        metavar="<ip>",
         default=None,
         help="Teacher's IP address",
     )
     network_config_group.add_argument(
         "-fp",
         "--teacher-port",
         type=int,
-        metavar="port",
+        metavar="<port>",
         default=None,
         help="Teacher's port (default to random port)",
     )
     network_config_group.add_argument(
         "-t",
         "--target",
         type=str,
-        metavar="ip",
+        metavar="<ip>",
         required=True,
         help="Target IP address",
     )
     network_config_group.add_argument(
         "-tp",
         "--target-port",
         type=int,
-        metavar="port",
+        metavar="<port>",
         default=4705,
         help="Port to send packets to (default: 4705)",
     )
     network_config_group.add_argument(
         "-i",
         "--ip-id",
         type=int,
-        metavar="ip_id",
+        metavar="<ip_id>",
         default=None,
         help="IP ID for the packet (default: random ID)",
     )
@@ -123,21 +123,21 @@ def format_usage(self) -> str:
         "-m",
         "--message",
         type=str,
-        metavar="msg",
+        metavar="<msg>",
         help="Message to send",
     )
     attack_action.add_argument(
         "-w",
         "--website",
         type=str,
-        metavar="url",
+        metavar="<url>",
         help="Website URL to ask to open",
     )
     attack_action.add_argument(
         "-c",
         "--command",
         type=str,
-        metavar="command",
+        metavar="<command>",
         help="Command to execute on the target",
     )
     temp = attack_action.add_argument(
@@ -147,36 +147,36 @@ def format_usage(self) -> str:
         default=None,
         action=ModeOptionalAction,
         modes=("minimize", "maximize"),
-        metavar=("program", "args"),
+        metavar=("<program>", "<args>"),
         help="Execute a program with arguments on the target machine",
     )
     attack_action.add_argument(
         "-s",
         "--shutdown",
         nargs="*",
         default=None,
-        metavar=("timeout", "message"),
+        metavar=("<timeout>", "<message>"),
         help="Shutdown the target machine, optionally with a timeout and message",
     )
     attack_action.add_argument(
         "-r",
         "--reboot",
         nargs="*",
         default=None,
-        metavar=("timeout", "message"),
+        metavar=("<timeout>", "<message>"),
         help="Reboot the target machine, optionally with a timeout and message",
     )
     attack_action.add_argument(
         "-n",
         "--rename",
         nargs=2,
-        metavar=("name", "name_id"),
+        metavar=("<name>", "<name_id>"),
         help="Rename the target machine",
     )
     attack_action.add_argument(
         "--hex",
         type=str,
-        metavar="hex_data",
+        metavar="<hex_data>",
         help="Hexadecimal string to send as a raw packet",
     )
 

README.md

@@ -19,11 +19,12 @@
 使用 `python Jiyu_udp_attack -h` 来获取帮助信息：
 
 ```
-usage: Jiyu_udp_attack [-h] -f ip [-fp port] -t ip [-tp port] [-i ip_id]
-                       (-m msg | -w url | -c command |
-                       -s [timeout [message ...]] |
-                       -r [timeout [message ...]] | -n name name_id |
-                       --hex hex_data)
+usage: Jiyu_udp_attack [-h] [-f <ip>] [-fp <port>] -t <ip> [-tp <port>]
+                       [-i <ip_id>] (-m <msg> | -w <url> | -c <command> |
+                       -e <program> [<args> ...] |
+                       -s [<timeout> [<message> ...]] |
+                       -r [<timeout> [<message> ...]] | -n <name> <name_id> |
+                       --hex <hex_data>)
 
 Jiyu Attack Script
 
@@ -33,30 +34,33 @@ options:
 Network Configuration:
   Specify the network configuration for the attack.
 
-  -f, --teacher-ip ip   Teacher's IP address
-  -fp, --teacher-port port
+  -f, --teacher-ip <ip>
+                        Teacher's IP address
+  -fp, --teacher-port <port>
                         Teacher's port (default to random port)
-  -t, --target ip       Target IP address
-  -tp, --target-port port
+  -t, --target <ip>     Target IP address
+  -tp, --target-port <port>
                         Port to send packets to (default: 4705)
-  -i, --ip-id ip_id     IP ID for the packet (default: random ID)
+  -i, --ip-id <ip_id>   IP ID for the packet (default: random ID)
 
 Attack Action:
   Specify the action to perform on the target machine.
 
-  -m, --message msg     Message to send
-  -w, --website url     Website URL to ask to open
-  -c, --command command
+  -m, --message <msg>   Message to send
+  -w, --website <url>   Website URL to ask to open
+  -c, --command <command>
                         Command to execute on the target
-  -s, --shutdown [timeout [message ...]]
+  -e, --execute, --minimize-execute, --maximize-execute <program> [<args> ...]
+                        Execute a program with arguments on the target machine
+  -s, --shutdown [<timeout> [<message> ...]]
                         Shutdown the target machine, optionally with a timeout
                         and message
-  -r, --reboot [timeout [message ...]]
+  -r, --reboot [<timeout> [<message> ...]]
                         Reboot the target machine, optionally with a timeout
                         and message
-  -n, --rename name name_id
+  -n, --rename <name> <name_id>
                         Rename the target machine
-  --hex hex_data        Hexadecimal string to send as a raw packet
+  --hex <hex_data>      Hexadecimal string to send as a raw packet
 
 Github Repositories: https://github.com/weilycoder/Jiyu_udp_attack/tree/main/
 ```

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Jiyu-udp-attack"
-version = "0.3.0"
+version = "0.4.0"
 description = "Send packets to student machines disguised as Jiyu teacher machine"
 authors = [{ name = "weilycoder", email = "[email protected]" }]
 license = "MIT"