Clarify CLI vs. Keybind Actions documentation

#4107 (comment)
ghostty-org · Jan 1, 2025 · 57ace2d · 57ace2d
1 parent 60611b8
commit 57ace2d
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/src/cli/help.zig b/src/cli/help.zig
@@ -63,7 +63,7 @@ pub fn run(alloc: Allocator) !u8 {
     try stdout.writeAll(
         \\
         \\Specify `+<action> --help` to see the help for a specific action,
-        \\where `<action>` is one of actions listed below.
+        \\where `<action>` is one of actions listed above.
         \\
     );
 

diff --git a/src/cli/list_actions.zig b/src/cli/list_actions.zig
@@ -20,8 +20,9 @@ pub const Options = struct {
     }
 };
 
-/// The `list-actions` command is used to list all the available keybind actions
-/// for Ghostty.
+/// The `list-actions` command is used to list all the available keybind
+/// actions for Ghostty. These are distinct from the CLI Actions which can
+/// be listed via `+help`
 ///
 /// The `--docs` argument will print out the documentation for each action.
 pub fn run(alloc: Allocator) !u8 {

diff --git a/src/main_ghostty.zig b/src/main_ghostty.zig
@@ -49,7 +49,8 @@ pub fn main() !MainReturn {
 
             error.InvalidAction => try stderr.print(
                 "Error: unknown CLI action specified. CLI actions are specified with\n" ++
-                    "the '+' character.\n",
+                    "the '+' character.\n\n" ++
+                    "All valid CLI actions can be listed with `ghostty +help`\n",
                 .{},
             ),