Merge pull request #11147 from gitbutlerapp/sc-fix-but-help2

fix but help

Author: schacon

crates/but/src/args.rs

@@ -28,6 +28,7 @@ pub struct Args {
 #[derive(Debug, clap::Subcommand)]
 pub enum Subcommands {
     /// Show commits on active branches in your workspace.
+    #[clap(hide = true)]
     Log,
     /// Overview of the uncommitted changes in the repository.
     #[clap(alias = "st")]
@@ -154,6 +155,7 @@ For examples see `but rub --help`."
         message: Option<String>,
     },
     /// Starts up the MCP server.
+    #[clap(hide = true)]
     Mcp {
         /// Starts the internal MCP server which has more granular tools.
         #[clap(long, short = 'i', hide = true)]
@@ -181,11 +183,13 @@ For examples see `but rub --help`."
     /// Command for creating and publishing code reviews to a forge.
     Review(forge::review::Platform),
     /// Generate shell completion scripts for the specified or inferred shell.
+    #[clap(hide = true)]
     Completions {
         /// The shell to generate completions for, or the one extracted from the `SHELL` environment variable.
         #[clap(value_enum)]
         shell: Option<clap_complete::Shell>,
     },
+    /// Automatically absorb uncomitted changes to an existing commit
     Absorb {
         /// If the CliID is an uncommitted change - the change will be absorbed
         /// If the CliID is a stack - anything assigned to the stack will be absorbed accordingly

crates/but/src/lib.rs

@@ -494,12 +494,19 @@ fn print_grouped_help() -> std::io::Result<()> {
 
     // Define command groupings and their order (excluding MISC)
     let groups = [
-        ("Inspection".yellow(), vec!["status", "log"]),
+        ("Inspection".yellow(), vec!["status"]),
         (
             "Branching and Committing".yellow(),
-            vec!["commit", "push", "new", "branch", "base", "mark", "unmark"],
+            vec!["commit", "new", "branch", "base", "mark", "unmark"],
+        ),
+        (
+            "Server Interactions".yellow(),
+            vec!["push", "review", "forge"],
+        ),
+        (
+            "Editing Commits".yellow(),
+            vec!["rub", "describe", "absorb"],
         ),
-        ("Editing Commits".yellow(), vec!["rub", "describe"]),
         (
             "Operation History".yellow(),
             vec!["oplog", "undo", "restore", "snapshot"],
@@ -515,6 +522,24 @@ fn print_grouped_help() -> std::io::Result<()> {
     writeln!(stdout, "Usage: but [OPTIONS] <COMMAND>")?;
     writeln!(stdout, "       but [OPTIONS] [RUB-SOURCE] [RUB-TARGET]")?;
     writeln!(stdout)?;
+    writeln!(
+        stdout,
+        "The GitButler CLI can be used to do nearly anything the desktop client can do (and more)."
+    )?;
+    writeln!(
+        stdout,
+        "It is a drop in replacement for most of the Git commands you would normally use, but Git"
+    )?;
+    writeln!(
+        stdout,
+        "commands (blame, log, etc) can also be used, as GitButler is fully Git compatible."
+    )?;
+    writeln!(stdout)?;
+    writeln!(
+        stdout,
+        "Checkout the full docs here: https://docs.gitbutler.com/cli-overview"
+    )?;
+    writeln!(stdout)?;
 
     // Keep track of which commands we've already printed
     let mut printed_commands = HashSet::new();
@@ -567,6 +592,24 @@ fn print_grouped_help() -> std::io::Result<()> {
         writeln!(stdout)?;
     }
 
+    // Add command completion instructions
+    writeln!(
+        stdout,
+        "To add command completion, add this to your shell rc: (for example ~/.zshrc)"
+    )?;
+    writeln!(stdout, "  eval \"$(but completions zsh)\"")?;
+    writeln!(stdout)?;
+
+    writeln!(
+        stdout,
+        "To use the GitButler CLI with coding agents (Claude Code hooks, Cursor hooks, MCP), see:"
+    )?;
+    writeln!(
+        stdout,
+        "  https://docs.gitbutler.com/features/ai-integration/ai-overview"
+    )?;
+    writeln!(stdout)?;
+
     writeln!(stdout, "{}:", "Options".yellow())?;
     // Truncate long option descriptions if needed
     let option_descriptions = [