Bash-it/bash-it

Bash-it is a collection of community Bash commands and scripts for Bash. (And a shameless ripoff of oh-my-zsh 😃) 97% of the code is compatible with bash 3.2+ but we are geared also toward power users, and one or two of the more complex plugins may need bash 5 features to run. If you happen to be "stuck" on an older version of bash, we have code in place to prevent you from running those modules and getting errors. It's a short list though, and none of the core code.

Includes autocompletion, themes, aliases, custom functions, a few stolen pieces from Steve Losh, and more.

Bash-it provides a solid framework for using, developing and maintaining shell scripts and custom commands for your daily work. If you're using the Bourne Again Shell (Bash) regularly and have been looking for an easy way on how to keep all of these nice little scripts and aliases under control, then Bash-it is for you! Stop polluting your ~/bin directory and your .bashrc file, fork/clone Bash-it and start hacking away.

• Main Page
• Contributing
• Installation
  • Install Options
  • via Docker
  • Updating
• Help
• Diagnostics
• Search
  • Syntax
  • Searching with Negations
  • Using Search to Enable or Disable Components
  • Disabling ASCII Color
• Custom scripts, aliases, themes, and functions
• Themes
• Uninstalling
• Misc
• Help Out
• Contributors

1. Clone this repo to a location of your choice, such as git clone --depth=1 https://github.com/Bash-it/bash-it.git ~/.bash_it
2. Run ~/.bash_it/install.sh

That's it! 😃

You can check out more components of Bash-it, and customize it to your desire. For more information, see detailed instructions here.

By default, the installer modifies/creates ~/.bashrc in place. If a config file already exists, a backup will be made. If this is undesirable, you can create another file, by run the installer:

BASH_IT_CONFIG_FILE=path/to/my/custom/location.bash ~/.bash_it/install.sh

If you're experiencing issues with Bash-it or need to report a bug, use the built-in diagnostics tool:

bash-it doctor

This command provides a comprehensive summary including:

• Environment information (OS, Bash version)
• Bash-it version and update status
• Configuration file locations and how Bash-it is loaded
• List of enabled components (aliases, plugins, completions)

When reporting bugs, please include the full output of bash-it doctor in your issue report.

The doctor command can also help you update Bash-it - if you're behind the latest version and it's safe to update, you'll be prompted to merge the latest changes.

Please take a look at the Contribution Guidelines before reporting a bug or providing a new feature.

When reporting bugs, always run bash-it doctor and include its output in your issue report to help maintainers diagnose the problem quickly.

The Development Guidelines have more information on some of the internal workings of Bash-it, please feel free to read through this page if you're interested in how Bash-it loads its components.

List of contributors

Bash-it is licensed under the MIT License.