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
Что это такое?Bash-it — это поддерживаемый сообществом фреймворк для организации конфигурации Bash: он объединяет алиасы, пользовательские функции, темы, автодополнения и плагины, чтобы не приходилось складывать всё в один файл .bashrc.
Это фреймворк вроде oh-my-zsh или просто набор тем?Это полноценный фреймворк для оболочки (прямо построенный по образцу oh-my-zsh), который предоставляет структуру для включения и отключения компонентов (алиасов, плагинов, автодополнений, тем), а не только набор тем оформления приглашения командной строки.
Нужна ли определённая версия Bash?Большая часть кода работает с Bash 3.2+, однако некоторым более сложным плагинам нужны возможности Bash 5; Bash-it определяет старую версию Bash и автоматически отключает эти модули, чтобы избежать ошибок.
Что делать, если я наткнусь на баг или что-то сломается?В Bash-it есть встроенная команда диагностики bash-it doctor, которая выводит версию ОС и Bash, версию Bash-it, расположение конфигурационных файлов и список включённых компонентов; при создании issue вас попросят приложить её вывод.
Можно ли установить Bash-it через Docker?Да, в документации по установке в README упоминается вариант установки через Docker наряду со стандартным способом через git clone, но все подробности находятся в связанной документации.
Как посмотреть, какие компоненты включены?Используйте функцию поиска и команду диагностики bash-it doctor, которая показывает включённые алиасы, плагины и автодополнения, а также расположение ваших конфигурационных файлов.
Можно ли откатить установку?Да, в Bash-it описан процесс удаления, а так как установщик создаёт резервную копию существующего .bashrc перед его изменением, вы можете восстановить исходную настройку.
Где Bash-it хранит мои личные настройки?Он поддерживает пользовательские скрипты, алиасы, темы и функции, которые хранятся отдельно от основного фреймворка, поэтому ваши дополнения сохраняются при обновлениях.
Creator
Bash-it
Size
42.3 MB
Stars
15.3K
Age
16y
Commits · 90 Days