Shell Integration - TomPlanche/rona GitHub Wiki
Rona provides comprehensive shell integration support for various shells. This guide will help you set up and configure Rona for your preferred shell.
- Bash
- Fish
- Zsh
- PowerShell
- Generate the completion script:
rona completion fish > ~/.config/fish/completions/rona.fish
- Add the function to your Fish configuration:
echo "function rona
command rona \$argv
end" >> ~/.config/fish/functions/rona.fish
- Reload your Fish configuration:
source ~/.config/fish/config.fish
- Add the completion script to your
.bashrc
:
rona completion bash >> ~/.bashrc
- Add the alias:
echo 'alias rona="command rona"' >> ~/.bashrc
- Reload your Bash configuration:
source ~/.bashrc
- Add the completion script to your
.zshrc
:
rona completion zsh >> ~/.zshrc
- Add the alias:
echo 'alias rona="command rona"' >> ~/.zshrc
- Reload your Zsh configuration:
source ~/.zshrc
- Add the completion script to your PowerShell profile:
rona completion powershell | Out-File -Append $PROFILE
- Add the alias:
Set-Alias -Name rona -Value rona
- Reload your PowerShell profile:
. $PROFILE
- Command and flag completion
- Git status file completion
- Context-aware suggestions
- Pattern completion
- Git command integration
- Editor integration
- Pattern matching
- Status tracking
- Shell-specific settings
- Completion customization
- Alias configuration
- Function overrides
# Command completion
rona <TAB>
# Pattern completion
rona -a "*.rs" <TAB>
# Git status completion
rona -a <TAB>
# Command completion
rona <TAB>
# Pattern completion
rona -a "*.rs" <TAB>
# Git status completion
rona -a <TAB>
# Command completion
rona <TAB>
# Pattern completion
rona -a "*.rs" <TAB>
# Git status completion
rona -a <TAB>
# Command completion
rona <TAB>
# Pattern completion
rona -a "*.rs" <TAB>
# Git status completion
rona -a <TAB>
-
Completion Not Working
- Verify the completion script is properly installed
- Check shell configuration file permissions
- Ensure the shell is reloaded
-
Function Not Found
- Verify the function is properly defined
- Check function file permissions
- Ensure the shell is reloaded
-
Alias Not Working
- Verify the alias is properly defined
- Check for conflicts with existing aliases
- Ensure the shell is reloaded
-
Shell Configuration
- Keep shell configuration files organized
- Use version control for shell configurations
- Document custom configurations
-
Completion Scripts
- Update completion scripts regularly
- Test completion in different scenarios
- Report issues to the project
-
Function Integration
- Use consistent function naming
- Document function behavior
- Test function integration
- Check the Usage Guide for practical examples
- Explore the Command Reference for detailed command information
- Visit the FAQ for common questions and answers