bash-it README

The project's README from github.com/Bash-it/bash-it. As one markdown file: README.md.

logo

Build Status Docs Status License shell

Bash-it is a collection of community Bash commands and scripts for Bash. (And a shameless ripoff of oh-my-zsh :smiley:) 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.

Installation

  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! :smiley:

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

Custom configuration file location

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

Diagnostics

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:

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.

Contributing

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.

Contributors

List of contributors

License

Bash-it is licensed under the MIT License.

bash-it (Bash-it/bash-it)

Searching Database…

15.3K ·GitHub
What is this?Bash-it is a community-maintained framework for organizing Bash configuration: it bundles aliases, custom functions, themes, completions, and plugins so you stop stuffing everything into a single .bashrc file.
Is this a framework like oh-my-zsh, or just a theme pack?It's a full shell framework (explicitly modeled on oh-my-zsh) that provides a structure for enabling/disabling components (aliases, plugins, completions, themes), not just a set of prompt themes.
Do I need a specific Bash version?Most of the code works with Bash 3.2+, though a few of the more complex plugins need Bash 5 features; Bash-it detects an old Bash and disables those modules automatically to avoid errors.
What if I run into a bug or something breaks?Bash-it ships a built-in diagnostics command, bash-it doctor, that reports your OS/Bash version, Bash-it version, config locations, and enabled components; you're asked to include its output when filing an issue.
Can I install Bash-it via Docker?Yes, the README's installation docs mention a Docker install option alongside the standard git clone method, though full details live in the linked docs.
How do I see what components are enabled?Use the search functionality and the bash-it doctor diagnostics command, which lists enabled aliases, plugins, and completions along with your configuration file locations.
Can I undo the install?Yes, Bash-it documents an uninstall process, and since the installer backs up your existing .bashrc before modifying it, you can restore your original setup.
Where does Bash-it keep my personal tweaks?It supports custom scripts, aliases, themes, and functions kept separate from the core framework, so your own additions survive updates.
Creator
Bash-it
Size
42.3 MB
Stars
15.3K
Age
16y
Commits · 90 Days