refactor: update description for cli options and config fields (#423)

4 files changed, 66 insertions, 66 deletions

diff --git a/scripts/completions/aichat.fish b/scripts/completions/aichat.fish
index 1169cd6..8141666 100644
--- a/scripts/completions/aichat.fish
+++ b/scripts/completions/aichat.fish
@@ -1,16 +1,16 @@
-complete -c aichat -s m -l model -x -a "(aichat --list-models)" -d 'Choose a LLM model' -r
-complete -c aichat -s r -l role -x -a "(aichat --list-roles)" -d 'Choose a role' -r
-complete -c aichat -s s -l session -x  -a"(aichat --list-sessions)" -d 'Create or reuse a session' -r
-complete -c aichat -s f -l file -d 'Attach files to the message' -r -F
-complete -c aichat -s w -l wrap -d 'Specify the text-wrapping mode (no, auto, <max-width>)'
-complete -c aichat -l save-session -d 'Whether to save the session'
-complete -c aichat -s e -l execute -d 'Execute commands using natural language'
-complete -c aichat -s c -l code -d 'Generate only code'
-complete -c aichat -s H -l no-highlight -d 'Disable syntax highlighting'
-complete -c aichat -s S -l no-stream -d 'No stream output'
+complete -c aichat -s m -l model -x -a "(aichat --list-models)" -d 'Select a LLM model' -r
+complete -c aichat -s r -l role -x -a "(aichat --list-roles)" -d 'Select a role' -r
+complete -c aichat -s s -l session -x  -a"(aichat --list-sessions)" -d 'Start or join a session' -r
+complete -c aichat -s f -l file -d 'Include files with the message' -r -F
+complete -c aichat -s w -l wrap -d 'Control text wrapping (no, auto, <max-width>)'
+complete -c aichat -l save-session -d 'Forces the session to be saved'
+complete -c aichat -s e -l execute -d 'Execute commands in natural language'
+complete -c aichat -s c -l code -d 'Output code only'
+complete -c aichat -s H -l no-highlight -d 'Turn off syntax highlighting'
+complete -c aichat -s S -l no-stream -d 'Turns off stream mode'
 complete -c aichat -l light-theme -d 'Use light theme'
-complete -c aichat -l dry-run -d 'Run in dry run mode'
-complete -c aichat -l info -d 'Print related information'
+complete -c aichat -l dry-run -d 'Display the message without sending it'
+complete -c aichat -l info -d 'Dispaly information'
 complete -c aichat -l list-models -d 'List all available models'
 complete -c aichat -l list-roles -d 'List all available roles'
 complete -c aichat -l list-sessions -d 'List all available sessions'
diff --git a/scripts/completions/aichat.nu b/scripts/completions/aichat.nu
index 19b382e..54922de 100644
--- a/scripts/completions/aichat.nu
+++ b/scripts/completions/aichat.nu
@@ -24,19 +24,19 @@ module completions {
 
   # All-in-one chat and copilot CLI that integrates 10+ AI platforms
   export extern aichat [
-    --model(-m): string@"nu-complete aichat model"    # Choose a LLM model
-    --role(-r): string@"nu-complete aichat role"      # Choose a role
-    --session(-s): string@"nu-complete aichat role"   # Create or reuse a session
-    --save-session                                    # Whether to save the session
-    --execute(-e)                                     # Execute commands using natural language
-    --code(-c)                                        # Generate only code
-    --file(-f): string                                # Attach files to the message
-    --no-highlight(-H)                                # Disable syntax highlighting
-    --no-stream(-S)                                   # No stream output
-    --wrap(-w): string                                # Specify the text-wrapping mode (no, auto, <max-width>)
+    --model(-m): string@"nu-complete aichat model"    # Select a LLM model
+    --role(-r): string@"nu-complete aichat role"      # Select a role
+    --session(-s): string@"nu-complete aichat role"   # Start or join a session
+    --save-session                                    # Forces the session to be saved
+    --execute(-e)                                     # Execute commands in natural language
+    --code(-c)                                        # Output code only
+    --file(-f): string                                # Include files with the message
+    --no-highlight(-H)                                # Turn off syntax highlighting
+    --no-stream(-S)                                   # Turns off stream mode
+    --wrap(-w): string                                # Control text wrapping (no, auto, <max-width>)
     --light-theme                                     # Use light theme
-    --dry-run                                         # Run in dry run mode
-    --info                                            # Print related information
+    --dry-run                                         # Display the message without sending it
+    --info                                            # Dispaly information
     --list-models                                     # List all available models
     --list-roles                                      # List all available roles
     --list-sessions                                   # List all available sessions
diff --git a/scripts/completions/aichat.ps1 b/scripts/completions/aichat.ps1
index 7d5a7cf..d74f52b 100644
--- a/scripts/completions/aichat.ps1
+++ b/scripts/completions/aichat.ps1
@@ -20,28 +20,28 @@ Register-ArgumentCompleter -Native -CommandName 'aichat' -ScriptBlock {
 
     $completions = @(switch ($command) {
         'aichat' {
-            [CompletionResult]::new('-m', '-m', [CompletionResultType]::ParameterName, 'Choose a LLM model')
-            [CompletionResult]::new('--model', '--model', [CompletionResultType]::ParameterName, 'Choose a LLM model')
-            [CompletionResult]::new('-r', '-r', [CompletionResultType]::ParameterName, 'Choose a role')
-            [CompletionResult]::new('--role', '--role', [CompletionResultType]::ParameterName, 'Choose a role')
-            [CompletionResult]::new('-s', '-s', [CompletionResultType]::ParameterName, 'Create or reuse a session')
-            [CompletionResult]::new('--session', '--session', [CompletionResultType]::ParameterName, 'Create or reuse a session')
-            [CompletionResult]::new('-f', '-f', [CompletionResultType]::ParameterName, 'Attach files to the message')
-            [CompletionResult]::new('--file', '--file', [CompletionResultType]::ParameterName, 'Attach files to the message')
-            [CompletionResult]::new('-w', '-w', [CompletionResultType]::ParameterName, 'Specify the text-wrapping mode (no, auto, <max-width>)')
-            [CompletionResult]::new('--wrap', '--wrap', [CompletionResultType]::ParameterName, 'Specify the text-wrapping mode (no, auto, <max-width>)')
-            [CompletionResult]::new('--save-session', '--save-session', [CompletionResultType]::ParameterName, 'Whether to save the session')
-            [CompletionResult]::new('-e', '-e', [CompletionResultType]::ParameterName, 'Execute commands using natural language')
-            [CompletionResult]::new('--execute', '--execute', [CompletionResultType]::ParameterName, 'Execute commands using natural language')
-            [CompletionResult]::new('-c', '-c', [CompletionResultType]::ParameterName, 'Generate only code')
-            [CompletionResult]::new('--code', '--code', [CompletionResultType]::ParameterName, 'Generate only code')
-            [CompletionResult]::new('-H', '-H', [CompletionResultType]::ParameterName, 'Disable syntax highlighting')
-            [CompletionResult]::new('--no-highlight', '--no-highlight', [CompletionResultType]::ParameterName, 'Disable syntax highlighting')
-            [CompletionResult]::new('-S', '-S', [CompletionResultType]::ParameterName, 'No stream output')
-            [CompletionResult]::new('--no-stream', '--no-stream', [CompletionResultType]::ParameterName, 'No stream output')
+            [CompletionResult]::new('-m', '-m', [CompletionResultType]::ParameterName, 'Select a LLM model')
+            [CompletionResult]::new('--model', '--model', [CompletionResultType]::ParameterName, 'Select a LLM model')
+            [CompletionResult]::new('-r', '-r', [CompletionResultType]::ParameterName, 'Select a role')
+            [CompletionResult]::new('--role', '--role', [CompletionResultType]::ParameterName, 'Select a role')
+            [CompletionResult]::new('-s', '-s', [CompletionResultType]::ParameterName, 'Start or join a session')
+            [CompletionResult]::new('--session', '--session', [CompletionResultType]::ParameterName, 'Start or join a session')
+            [CompletionResult]::new('-f', '-f', [CompletionResultType]::ParameterName, 'Include files with the message')
+            [CompletionResult]::new('--file', '--file', [CompletionResultType]::ParameterName, 'Include files with the message')
+            [CompletionResult]::new('-w', '-w', [CompletionResultType]::ParameterName, 'Control text wrapping (no, auto, <max-width>)')
+            [CompletionResult]::new('--wrap', '--wrap', [CompletionResultType]::ParameterName, 'Control text wrapping (no, auto, <max-width>)')
+            [CompletionResult]::new('--save-session', '--save-session', [CompletionResultType]::ParameterName, 'Forces the session to be saved')
+            [CompletionResult]::new('-e', '-e', [CompletionResultType]::ParameterName, 'Execute commands in natural language')
+            [CompletionResult]::new('--execute', '--execute', [CompletionResultType]::ParameterName, 'Execute commands in natural language')
+            [CompletionResult]::new('-c', '-c', [CompletionResultType]::ParameterName, 'Output code only')
+            [CompletionResult]::new('--code', '--code', [CompletionResultType]::ParameterName, 'Output code only')
+            [CompletionResult]::new('-H', '-H', [CompletionResultType]::ParameterName, 'Turn off syntax highlighting')
+            [CompletionResult]::new('--no-highlight', '--no-highlight', [CompletionResultType]::ParameterName, 'Turn off syntax highlighting')
+            [CompletionResult]::new('-S', '-S', [CompletionResultType]::ParameterName, 'Turns off stream mode')
+            [CompletionResult]::new('--no-stream', '--no-stream', [CompletionResultType]::ParameterName, 'Turns off stream mode')
             [CompletionResult]::new('--light-theme', '--light-theme', [CompletionResultType]::ParameterName, 'Use light theme')
-            [CompletionResult]::new('--dry-run', '--dry-run', [CompletionResultType]::ParameterName, 'Run in dry run mode')
-            [CompletionResult]::new('--info', '--info', [CompletionResultType]::ParameterName, 'Print related information')
+            [CompletionResult]::new('--dry-run', '--dry-run', [CompletionResultType]::ParameterName, 'Display the message without sending it')
+            [CompletionResult]::new('--info', '--info', [CompletionResultType]::ParameterName, 'Dispaly information')
             [CompletionResult]::new('--list-models', '--list-models', [CompletionResultType]::ParameterName, 'List all available models')
             [CompletionResult]::new('--list-roles', '--list-roles', [CompletionResultType]::ParameterName, 'List all available roles')
             [CompletionResult]::new('--list-sessions', '--list-sessions', [CompletionResultType]::ParameterName, 'List all available sessions')
diff --git a/scripts/completions/aichat.zsh b/scripts/completions/aichat.zsh
index 83ad751..b14bd74 100644
--- a/scripts/completions/aichat.zsh
+++ b/scripts/completions/aichat.zsh
@@ -15,28 +15,28 @@ _aichat() {
 
     local context curcontext="$curcontext" state line
      local common=(
-'-m+[Choose a LLM model]:MODEL:->models' \
-'--model=[Choose a LLM model]:MODEL:->models' \
-'-r+[Choose a role]:ROLE:->roles' \
-'--role=[Choose a role]:ROLE:->roles' \
-'-s+[Create or reuse a session]:SESSION:->sessions' \
-'--session=[Create or reuse a session]:SESSION:->sessions' \
-'*-f+[Attach files to the message]:FILE:_files' \
-'*--file=[Attach files to the message]:FILE:_files' \
-'-w+[Specify the text-wrapping mode (no, auto, <max-width>)]:WRAP: ' \
-'--wrap=[Specify the text-wrapping mode (no, auto, <max-width>)]:WRAP: ' \
-'--save-session[Whether to save the session]' \
-'-e[Execute commands using natural language]' \
-'--execute[Execute commands using natural language]' \
-'-c[Generate only code]' \
-'--code[Generate only code]' \
-'-H[Disable syntax highlighting]' \
-'--no-highlight[Disable syntax highlighting]' \
-'-S[No stream output]' \
-'--no-stream[No stream output]' \
+'-m+[Select a LLM model]:MODEL:->models' \
+'--model=[Select a LLM model]:MODEL:->models' \
+'-r+[Select a role]:ROLE:->roles' \
+'--role=[Select a role]:ROLE:->roles' \
+'-s+[Start or join a session]:SESSION:->sessions' \
+'--session=[Start or join a session]:SESSION:->sessions' \
+'*-f+[Include files with the message]:FILE:_files' \
+'*--file=[Include files with the message]:FILE:_files' \
+'-w+[Control text wrapping (no, auto, <max-width>)]:WRAP: ' \
+'--wrap=[Control text wrapping (no, auto, <max-width>)]:WRAP: ' \
+'--save-session[Forces the session to be saved]' \
+'-e[Execute commands in natural language]' \
+'--execute[Execute commands in natural language]' \
+'-c[Output code only]' \
+'--code[Output code only]' \
+'-H[Turn off syntax highlighting]' \
+'--no-highlight[Turn off syntax highlighting]' \
+'-S[Turns off stream mode]' \
+'--no-stream[Turns off stream mode]' \
 '--light-theme[Use light theme]' \
-'--dry-run[Run in dry run mode]' \
-'--info[Print related information]' \
+'--dry-run[Display the message without sending it]' \
+'--info[Dispaly information]' \
 '--list-models[List all available models]' \
 '--list-roles[List all available roles]' \
 '--list-sessions[List all available sessions]' \