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 那样的框架,还是只是一个主题包?它是一个完整的 Shell 框架(明确参照 oh-my-zsh 设计),提供了启用和禁用各类组件(别名、插件、命令补全、主题)的结构,而不只是一组提示符主题。
我需要特定版本的 Bash 吗?大部分代码支持 Bash 3.2 及以上版本,但一些较复杂的插件需要 Bash 5 的功能。Bash-it 检测到旧版 Bash 时,会自动禁用这些模块,以避免出错。
如果遇到 bug 或者出了问题怎么办?Bash-it 内置了诊断命令 bash-it doctor,它会显示你的操作系统和 Bash 版本、Bash-it 版本、配置文件位置以及已启用的组件。提交问题时,需要附上该命令的输出。
可以通过 Docker 安装 Bash-it 吗?可以。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