bash-it/docs
John D Pell a8c073fa3b
Merge affbce6de1 into e38696a0ac
2023-03-10 11:58:35 -05:00
..
_static docs: Add empty _static and _templates directories 2020-10-31 23:07:02 +02:00
_templates docs: Add empty _static and _templates directories 2020-10-31 23:07:02 +02:00
commands docs: Add profile command docs 2021-09-29 00:30:24 +03:00
themes-list Merge affbce6de1 into e38696a0ac 2023-03-10 11:58:35 -05:00
Makefile docs: Add basic sphinx docs 2020-10-31 23:07:02 +02:00
README.md Remove libra chat reference 2022-12-06 00:22:27 +02:00
conf.py improve (docs): exclude venv pattern in build 2022-05-07 00:31:21 +05:30
contributing.rst docs: contributing: Remove bullets already covered by our templates 2020-12-29 22:06:22 +02:00
custom.rst Move most of the documentation to .rst format 2020-10-31 23:07:02 +02:00
development.rst finalize: first attempt at documentation? 2022-01-09 00:46:51 -08:00
help_screens.rst docs: misc: Move help_screens and proxy_support into seperate pages 2020-12-14 00:14:23 +02:00
index.rst docs: Add newline in readme and index.rst 2021-02-06 23:17:18 +02:00
installation.rst docs: fix references to `~/.bashrc` 2022-03-04 13:04:48 -08:00
make.bat Adds better support for .bat files; Fixes docs/make.bat 2020-11-03 09:16:14 -08:00
misc.rst docs: misc: Move help_screens and proxy_support into seperate pages 2020-12-14 00:14:23 +02:00
proxy_support.rst docs: misc: Move help_screens and proxy_support into seperate pages 2020-12-14 00:14:23 +02:00
requirements.txt fix (docs): ugraded sphinx version 2022-05-07 00:32:15 +05:30
test.rst Move most of the documentation to .rst format 2020-10-31 23:07:02 +02:00
themes.rst lib/helpers: add `preview` to `bash-it` spaghetti 2022-02-07 15:27:03 -08:00
troubleshooting.rst Fixed broken code blocks in troubleshooting.rst 2022-09-22 16:49:26 -06:00
uninstalling.rst Move most of the documentation to .rst format 2020-10-31 23:07:02 +02:00
vcs_user.rst docs: fix references to `~/.bashrc` 2022-03-04 13:04:48 -08:00

README.md

logo

Build Status Docs Status License shell

Bash-it is a collection of community Bash commands and scripts for Bash 3.2+. (And a shameless ripoff of oh-my-zsh 😃)

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. Check out a clone of 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.

Contributing

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

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.