A community Bash framework.
Go to file
sebokopter 1039a80ecd Easily 'enter' the installation process
* install.sh
- Added a Choice to add existing .bash_profile to bash-it version.
- Also it is possible to only 'enter' the installaion process.
- Improved yes/no query for funtion load_some()
2021-11-19 03:13:22 +02:00
.github ci: Bump go to 1.17 from 1.14 2021-10-10 23:50:39 +03:00
aliases/available Merge pull request #1981 from william-richard/make-default-branch-match-exactly-main 2021-11-16 20:09:22 +02:00
completion/available Merge pull request #1965 from gaelicWizard/completion-git 2021-10-07 00:10:47 +03:00
custom Fix bogus bash binary location 2012-04-17 00:24:58 -04:00
docs docs: Pin docutils to 0.17.1 2021-11-12 19:14:22 +02:00
hooks Delete `.shellcheckrc` (#1947) 2021-09-18 12:50:59 +03:00
lib Use `_bash-it-egrep()` 2021-10-18 22:08:56 -04:00
plugins/available plugin/xterm: don't rely on `$1` 2021-10-20 15:50:15 -04:00
scripts Delete `.shellcheckrc` (#1947) 2021-09-18 12:50:59 +03:00
template add command time duration plugin (#1683) 2020-12-27 18:48:17 +02:00
test skip go tests when go is not available 2021-09-29 18:16:52 -05:00
test_lib Updated to bats-core v1.2.0 2020-04-29 16:03:30 +02:00
themes Merge pull request #1975 from krapshsa/krapshsa-patch-1 2021-10-18 22:22:21 +03:00
vendor preexec: set options before load 2021-10-20 15:28:59 -04:00
.ackrc Ignore the enabled directories when running ack 2016-03-25 15:29:10 -05:00
.editorconfig EditorConfig: set `indent_size = tab` 2021-09-17 10:44:53 -07:00
.gitattributes Allow trailing spaces in md/rst files 2020-12-17 01:42:25 +02:00
.gitignore Completely ignore enabled-dir in root to support symlinking. 2019-07-22 16:42:29 +02:00
.gitmodules Updated to bats-core v1.2.0 2020-04-29 16:03:30 +02:00
.pre-commit-config.yaml Merge pull request #1899 from georgettica/georgettica/bump-pre-commit-hooks 2021-06-23 13:21:06 +03:00
.readthedocs.yml Add readthedocs configuration 2020-10-31 23:07:02 +02:00
LICENSE Add 2021 to license 2021-04-06 20:59:08 +03:00
README.md Updated documentation 2021-11-19 03:10:06 +02:00
bash_it.sh preexec: set options before load 2021-10-20 15:28:59 -04:00
clean_files.txt Merge pull request #1965 from gaelicWizard/completion-git 2021-10-07 00:10:47 +03:00
install.sh Easily 'enter' the installation process 2021-11-19 03:13:22 +02:00
lint_clean_files.sh Explain Bash-it variable clearing in lint script 2020-11-05 08:30:33 -08:00
uninstall.sh Fixed some shellcheck warnings 2018-05-31 18:05:25 +02:00

README.md

Bash it

Bash it is a mash up of my own bash commands and scripts, other bash stuff I have found.

(And a shameless ripoff of oh-my-zsh. :)

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

Install

There are currently two recommended ways you can employ to install Bash it

Direct install

Using bash and curl automagically install Bash it directly from the master repository on github.

Copy and paste the following command (without the $) anywhere into a shell. Curl will retrieve the install script which then gets parsed and executed by bash. On detection of the direct installation process install.sh will first clone the repository into ~/.bash_it before continuing with the installation.

  1. Execute the install script directly from github:
$ bash -c "$(curl -s https://raw.github.com/revans/bash-it/master/install.sh)"
  1. Edit your ~/.bash_profile file in order to customize Bash it.

Manual install

Using the same install.sh script by which the direct install is accomplished after manually cloning the repository first. You would probably want to check bash-it out into the folder ~/.bash_it but anywhere else you choose also dosen't matter. The install.sh script will detect the location it is executed from, if this is not ~/.bash_it a copy of the checked out folder will automatically be copied to ~/.bash_it on your behalf.

  1. Check out a clone of the bash-it repository:
$ git clone http://github.com/revans/bash-it.git ~/.bash_it
  1. Run the install.sh script (it automatically backs up your ~/.bash_profile):
$ `~/.bash_it/install.sh
  1. Edit your ~/.bash_profile file in order to customize Bash it.

NOTE: The install script will also prompt you asking if you use Jekyll. This is to set up the .jekyllconfig file, which stores info necessary to use the Jekyll plugin.

Help Screens

bash-it show aliases        # shows installed and available aliases
bash-it show completions    # shows installed and available completions
bash-it show plugins        # shows installed and available plugins
bash-it help aliases        # shows help for installed aliases
bash-it help completions    # shows help for installed completions
bash-it help plugins        # shows help for installed plugins

Your Custom scripts, aliases, and functions

For custom scripts, and aliases, just create the following files (they'll be ignored by the git repo):

  • aliases/custom.aliases.bash
  • lib/custom.bash
  • plugins/custom.plugins.bash

Anything in the custom directory will be ignored, with the exception of custom/example.bash.

Themes

There are a few bash it themes. If you've created your own custom prompts, I'd love it if you shared with everyone else! Just submit a Pull Request to me (revans).

Help out

I think everyone has their own custom scripts accumulated over time. And so, following in the footsteps of oh-my-zsh, bash it is a framework for easily customizing your bash shell. Everyone's got a custom toolbox, so let's start making them even better, as a community!

Send me a pull request and I'll merge it as long as it looks good. If you change an existing command, please give an explanation why. That will help a lot when I merge your changes in.

Thanks, and happing bashing!

Contributors