Update documents

Author: lusingander

README.md

@@ -104,8 +104,8 @@ For detailed information about the config file format, see [Config File Format](
 
 ### User command
 
-The User command view allows you to display the output (stdout) of your custom external commands.
-This allows you to do things like view commit diffs using your favorite tools.
+The User command feature allows you to execute custom external commands.
+You can display the output of commands like `git diff` in a dedicated view, or execute commands like branch deletion in the background.
 
 For details on how to set commands, see [User Command](https://lusingander.github.io/serie/features/user-command.html).
 

config.schema.json

@@ -98,12 +98,26 @@
                   "type": "string",
                   "description": "The name of the command to be displayed."
                 },
+                "type": {
+                  "type": "string",
+                  "description": "The type of user command.",
+                  "enum": [
+                    "inline",
+                    "silent"
+                  ],
+                  "default": "inline"
+                },
                 "commands": {
                   "type": "array",
                   "description": "The command and its arguments to execute.",
                   "items": {
                     "type": "string"
                   }
+                },
+                "refresh": {
+                  "type": "boolean",
+                  "description": "Whether to reload the repository and refresh the display after executing the command. Only available for 'silent' commands.",
+                  "default": false
                 }
               },
               "required": [

docs/src/configurations/config-file-format.md

@@ -182,17 +182,25 @@ Whether to enable fuzzy matching by default.
 
 ### `core.user_command.commands_{n}`
 
-The command definition for generating the content displayed in the user command view.
+The command definition for executing external commands.
 
 Multiple commands can be specified in the format `commands_{n}`.
 For details about user command, see the separate [User command](../features/user-command.md) section.
 
 - type: `object`
 - fields:
   - `name`: `string` - The name of the user command.
+  - `type`: `string` (enum) - The type of user command.
+    - default: `inline`
+    - possible values:
+      - `inline`: Display the output of the command in the user command view.
+      - `silent`: Execute the command in the background without opening a view.
   - `commands`: `array of strings` - The command and its arguments.
+  - `refresh`: `boolean` - Whether to reload the repository and refresh the display after executing the command. Only available for `silent` commands.
+    - default: `false`
 - examples:
     - `commands_1 = { name = "git diff", commands = ["git", "--no-pager", "diff", "--color=always", "{{first_parent_hash}}", "{{target_hash}}"]}`
+    - `commands_2 = { name = "delete branch", type = "silent", commands = ["git", "branch", "-D", "{{branches}}"], refresh = true }`
 
 ### `core.user_command.tab_width`
 

docs/src/features/user-command.md

@@ -1,10 +1,17 @@
 # User Command
 
-The User command view allows you to display the output (stdout) of your custom external commands.
-This allows you to do things like view commit diffs using your favorite tools.
+The User command feature allows you to execute custom external commands.
+There are two types of user commands: `inline` and `silent`.
+
+- `inline` (default)
+  - Displays the output (stdout) of the command in a dedicated view within the TUI.
+  - This allows you to do things like view commit diffs using your favorite tools.
+- `silent`
+  - Executes the command in the background without opening a view.
+  - This is useful for operations that don't require checking output, such as deleting branches or adding tags.
 
 To define a user command, you need to configure the following two settings:
-- Keybinding definition. Specify the key to display each user command.
+- Keybinding definition. Specify the key to execute each user command.
   - Config: `keybind.user_command_{n}`
 - Command definition. Specify the actual command you want to execute.
   - Config: `core.user_command.commands_{n}`
@@ -15,12 +22,24 @@ To define a user command, you need to configure the following two settings:
 [keybind]
 user_command_1 = ["d"]
 user_command_2 = ["shift-d"]
+user_command_3 = ["b"]
 
 [core.user_command]
+# Inline command (default)
 commands_1 = { "name" = "git diff", commands = ["git", "--no-pager", "diff", "--color=always", "{{first_parent_hash}}", "{{target_hash}}"] }
+# Inline command with custom area size
 commands_2 = { "name" = "xxx", commands = ["xxx", "{{first_parent_hash}}", "{{target_hash}}", "--width", "{{area_width}}", "--height", "{{area_height}}"] }
+# Silent command with refresh
+commands_3 = { "name" = "delete branch", type = "silent", commands = ["git", "branch", "-D", "{{branches}}"], refresh = true }
 ```
 
+## Refresh
+
+For `silent` commands, you can set `refresh = true` to automatically reload the repository and refresh the display (e.g., commit list) after the command is executed.
+This is useful when the command modifies the repository state.
+
+Note that `refresh = true` cannot be used with `inline` commands.
+
 ## Variables
 
 The following variables can be used in command definitions.

src/view/help.rs

@@ -221,7 +221,7 @@ fn build_lines(
                 .user_command
                 .commands
                 .get(&n.to_string())
-                .map(|c| format!("Toggle user command {} - {}", n, c.name))
+                .map(|c| format!("Execute user command {} - {}", n, c.name))
                 .map(|desc| (vec![UserEvent::UserCommand(n)], desc))
         })
         .collect::<Vec<_>>();