Struct GenerateCompletionArgs

pub struct GenerateCompletionArgs {
    pub shell: Shell,
}

Command-line arguments for generating shell completion scripts.

The generate-completion command creates shell-specific completion scripts that enable intelligent tab completion for SubX commands and arguments. This greatly enhances the command-line user experience by providing context-aware suggestions and reducing typing requirements.

Completion Capabilities

Generated scripts provide completion for:

• Subcommands: match, convert, sync, detect-encoding, etc.
• Flags and Options: --format, --output, --confidence, etc.
• Enum Values: Available formats, AI providers, sync methods
• File Paths: Intelligent file and directory completion
• Configuration Keys: Valid configuration setting names

Shell Integration

Each shell has different integration methods:

• Immediate: Load completion in current session
• Persistent: Add to shell configuration for permanent availability
• System-wide: Install for all users on the system
• Per-project: Enable completion in specific project directories

Performance Considerations

Completion scripts are optimized for performance:

• Lazy Loading: Completions are generated on-demand
• Caching: Results are cached where appropriate
• Minimal Overhead: Scripts add minimal startup time to shell
• Incremental Updates: Only regenerate when command structure changes

Examples

use subx_cli::cli::GenerateCompletionArgs;
use clap_complete::Shell;

// Generate Bash completion
let bash_args = GenerateCompletionArgs {
    shell: Shell::Bash,
};

// Generate Zsh completion
let zsh_args = GenerateCompletionArgs {
    shell: Shell::Zsh,
};

// Generate Fish completion
let fish_args = GenerateCompletionArgs {
    shell: Shell::Fish,
};

Fields

shell: Shell

Target shell for completion script generation.

Specifies which shell environment the completion script should target. Each shell has different syntax and capabilities, so the generated script is optimized for the specific shell’s completion system.

Shell-Specific Features

Bash

• Traditional completion with complete command
• Basic argument and flag completion
• Compatible with most Linux distributions
• Works with Bash 4.0+ (recommended: 4.4+)

Zsh

• Advanced completion with _arguments function
• Rich help text and description display
• Smart caching and performance optimization
• Compatible with Oh My Zsh and other frameworks

Fish

• Native completion with complete command
• Excellent help text integration
• Real-time completion suggestions
• Works with all Fish versions 3.0+

PowerShell

• Register-ArgumentCompleter integration
• Full .NET completion capabilities
• Works on Windows, Linux, and macOS
• Compatible with PowerShell 5.1+ and PowerShell Core

Elvish

• Modern completion with structured data
• Rich metadata and help integration
• Advanced completion customization
• Works with Elvish 0.18+

Installation Instructions

Bash

# Temporary (current session only)
eval "$(subx generate-completion bash)"

# Permanent (add to ~/.bashrc)
echo 'eval "$(subx generate-completion bash)"' >> ~/.bashrc

# System-wide (requires sudo)
subx generate-completion bash > /etc/bash_completion.d/subx

Zsh

# Temporary (current session only)
eval "$(subx generate-completion zsh)"

# Permanent (add to ~/.zshrc)
echo 'eval "$(subx generate-completion zsh)"' >> ~/.zshrc

# Oh My Zsh (create plugin)
mkdir -p ~/.oh-my-zsh/custom/plugins/subx
subx generate-completion zsh > ~/.oh-my-zsh/custom/plugins/subx/_subx

Fish

# Save to Fish completions directory
subx generate-completion fish > ~/.config/fish/completions/subx.fish

# System-wide installation
sudo subx generate-completion fish > /usr/share/fish/completions/subx.fish

PowerShell

# Add to PowerShell profile
subx generate-completion powershell | Out-String | Invoke-Expression

# Permanent installation (add to profile)
Add-Content $PROFILE "subx generate-completion powershell | Out-String | Invoke-Expression"

Troubleshooting

Common issues and solutions:

• Completion not working: Verify shell version compatibility
• Slow completion: Check for conflicting completion scripts
• Missing commands: Ensure SubX is in PATH
• Permission errors: Use appropriate installation method for your system

Examples

# Generate and view Bash completion
subx generate-completion bash

# Generate and install Fish completion
subx generate-completion fish > ~/.config/fish/completions/subx.fish

# Generate PowerShell completion and execute immediately
subx generate-completion powershell | Out-String | Invoke-Expression

Trait Implementations

impl Args for GenerateCompletionArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for GenerateCompletionArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for GenerateCompletionArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.