This pull request introduces several enhancements and fixes to the ShellGPT project, including improvements to the README.md documentation, and the addition of Fish shell integration.
Changes
README.md
General Improvements: Enhanced readability and formatting throughout the document.
Fish Shell Support: Updated documentation to reflect support for the Fish shell, including installation and usage instructions.
Additional Examples: Added more examples to demonstrate the usage of ShellGPT in various scenarios.
Clarifications: Provided additional clarifications and tips for better user experience.
Code Changes
sgpt/app.py
Shell Integration: Updated the help message for the install_integration option to include Fish shell support.
sgpt/integration.py
Fish Shell Integration: Added a new Fish shell integration script to enable ShellGPT completions directly in the Fish shell.
sgpt/utils.py
Integration Logic: Updated the install_shell_integration function to support Fish shell, in addition to ZSH and Bash.
Installation and Usage
Shell Integration: Users can now install shell integration for ZSH, Bash, and Fish shells using the sgpt --install-integration command.
Hotkeys: Default hotkeys for invoking ShellGPT have been specified for each shell:
ZSH and Bash: Ctrl+l
Fish: Ctrl+/ (Ctrl+/ is already taken in fish)
Documentation
Enhanced Examples: Provided detailed examples for using ShellGPT with various shell commands, code generation, and chat modes.
Function Calling: Explained how to define and use custom functions with ShellGPT.
Roles and Request Cache: Added sections on creating custom roles and controlling request cache.
Conclusion
These changes aim to improve the overall usability and functionality of ShellGPT, making it more versatile and user-friendly across different shell environments. The updated documentation ensures that users have clear and comprehensive guidance on how to leverage the full capabilities of ShellGPT.
Summary
This pull request introduces several enhancements and fixes to the ShellGPT project, including improvements to the
README.md
documentation, and the addition of Fish shell integration.Changes
README.md
Code Changes
sgpt/app.py
install_integration
option to include Fish shell support.sgpt/integration.py
sgpt/utils.py
install_shell_integration
function to support Fish shell, in addition to ZSH and Bash.Installation and Usage
sgpt --install-integration
command.Ctrl+l
Ctrl+/
(Ctrl+/
is already taken in fish)Documentation
Conclusion
These changes aim to improve the overall usability and functionality of ShellGPT, making it more versatile and user-friendly across different shell environments. The updated documentation ensures that users have clear and comprehensive guidance on how to leverage the full capabilities of ShellGPT.