Merge pull request #636 from kinode-dao/hf/update-help

terminal: update `help`

kinode/packages/terminal/help/src/lib.rs

@@ -6,19 +6,36 @@ wit_bindgen::generate!({
 });
 
 const HELP_MESSAGES: [[&str; 2]; 11] = [
-    ["alias", "\n\x1b[1malias\x1b[0m <shorthand> <process_id>: create an alias for a script.\n    - Example: \x1b[1malias get_block get_block:kns-indexer:sys\x1b[0m\n    - note: all of these listed commands are just default aliases for terminal scripts."],
+    ["alias", "\n\x1b[1malias\x1b[0m <shorthand> <process-id>: create an alias for a script.\n    - Example: \x1b[1malias get-block get-block:kns-indexer:sys\x1b[0m\n    - note: all of these listed commands are just default aliases for terminal scripts."],
     ["cat", "\n\x1b[1mcat\x1b[0m <vfs-file-path>: print the contents of a file in the terminal.\n    - Example: \x1b[1mcat /terminal:sys/pkg/scripts.json\x1b[0m"],
     ["echo", "\n\x1b[1mecho\x1b[0m <text>: print text to the terminal.\n    - Example: \x1b[1mecho foo\x1b[0m"],
     ["hi", "\n\x1b[1mhi\x1b[0m <name> <string>: send a text message to another node's command line.\n    - Example: \x1b[1mhi mothu.kino hello world\x1b[0m"],
     ["kfetch", "\n\x1b[1mkfetch\x1b[0m: print system information a la neofetch. No arguments."],
-    ["kill", "\n\x1b[1mkill\x1b[0m <process-id>: terminate a running process. This will bypass any restart behavior–use judiciously.\n    - Example: \x1b[1mkill chess:chess:sys\x1b[0m"],
-    ["m", "\n\x1b[1mm\x1b[0m <address> '<json>': send an inter-process message. <address> is formatted as <node>@<process_id>. <process_id> is formatted as <process_name>:<package_name>:<publisher_node>. JSON containing spaces must be wrapped in single-quotes (\x1b[1m''\x1b[0m).\n    - Example: \x1b[1mm our@eth:distro:sys \"SetPublic\" -a 5\x1b[0m\n    - the '-a' flag is used to expect a response with a given timeout\n    - \x1b[1mour\x1b[0m will always be interpolated by the system as your node's name"],
+    ["kill", "\n\x1b[1mkill\x1b[0m <process-id>: terminate a running process. This will bypass any restart behavior; use judiciously.\n    - Example: \x1b[1mkill chess:chess:sys\x1b[0m"],
+    ["m", "\n\x1b[1mm\x1b[0m <address> '<json>': send an inter-process message. <address> is formatted as <node>@<process-id>. <process-id> is formatted as <process-name>:<package-name>:<publisher-node>. JSON containing spaces must be wrapped in single-quotes (\x1b[1m''\x1b[0m).\n    - Example: \x1b[1mm our@eth:distro:sys \"SetPublic\" -a 5\x1b[0m\n    - the '-a' flag is used to expect a response with a given timeout\n    - \x1b[1mour\x1b[0m will always be interpolated by the system as your node's name"],
     ["net-diagnostics", "\n\x1b[1mnet-diagnostics\x1b[0m: print some useful networking diagnostic data."],
     ["peer", "\n\x1b[1mpeer\x1b[0m <name>: print the peer's PKI info, if it exists."],
     ["peers", "\n\x1b[1mpeers\x1b[0m: print the peers the node currently hold connections with."],
-    ["top", "\n\x1b[1mtop\x1b[0m <process_id>: display kernel debugging info about a process. Leave the process ID blank to display info about all processes and get the total number of running processes.\n    - Example: \x1b[1mtop net:distro:sys\x1b[0m\n    - Example: \x1b[1mtop\x1b[0m"],
+    ["top", "\n\x1b[1mtop\x1b[0m <process-id>: display kernel debugging info about a process. Leave the process ID blank to display info about all processes and get the total number of running processes.\n    - Example: \x1b[1mtop net:distro:sys\x1b[0m\n    - Example: \x1b[1mtop\x1b[0m"],
 ];
 
+const CONTROL_MESSAGES: [&str; 10] = [
+    "\n\x1b[1mCTRL+C\x1b[0m or \x1b[1mCTRL+D\x1b[0m to gracefully shutdown node",
+    "\n\x1b[1mCTRL+V\x1b[0m to toggle through verbose modes (0-3, 0 is default and lowest verbosity)",
+    "\n\x1b[1mCTRL+W\x1b[0m to toggle on/off Process Verbosity Mode, where individual process verbosities may be set",
+    "\n\x1b[1mCTRL+J\x1b[0m to toggle debug mode",
+    "\n\x1b[1mCTRL+S\x1b[0m to step through events in debug mode",
+    "\n\x1b[1mCTRL+L\x1b[0m to toggle logging mode, which writes all terminal output to the .terminal_log file. On by default, this will write all events and verbose prints with timestamps",
+    "\n\x1b[1mCTRL+A\x1b[0m to jump to beginning of input",
+    "\n\x1b[1mCTRL+E\x1b[0m to jump to end of input",
+    "\n\x1b[1mCTRL+P\x1b[0m/\x1b[1mCTRL+N\x1b[0m or \x1b[1mUpArrow\x1b[0m/\x1b[1mDownArrow\x1b[0m to move up and down through command history",
+    "\n\x1b[1mCTRL+R\x1b[0m to search history, \x1b[1mCTRL+R\x1b[0m again to step through search results, \x1b[1mCTRL+G\x1b[0m to cancel search",
+];
+
+pub fn make_remote_link(url: &str, text: &str) -> String {
+    format!("\x1B]8;;{}\x1B\\{}\x1B]8;;\x1B\\", url, text)
+}
+
 script!(init);
 fn init(_our: Address, args: String) -> String {
     // if args is empty, print the entire help message.
@@ -36,10 +53,16 @@ fn init(_our: Address, args: String) -> String {
             help_message.push_str("\n");
         }
 
-        help_message.push_str(
-            "For more help, look to the documentation at book.kinode.org.\n\
+        for message in CONTROL_MESSAGES.iter() {
+            help_message.push_str(message);
+            help_message.push_str("\n");
+        }
+
+        help_message.push_str(&format!(
+            "\nFor more help, look to the documentation at {}.\n\
             ============================================================\n",
-        );
+            make_remote_link("https://book.kinode.org", "book.kinode.org"),
+        ));
 
         return help_message;
     } else if let Some(message) = HELP_MESSAGES.iter().find(|[cmd, _]| cmd == &args) {