Dotfiles config update (2022-02-27)
This commit is contained in:
parent
27de7b7e2b
commit
434bff9732
|
@ -1,64 +0,0 @@
|
|||
![logo](https://github.com/Bash-it/media/raw/master/media/Bash-it.png)
|
||||
|
||||
![Build Status](https://github.com/Bash-it/bash-it/workflows/CI/badge.svg?branch=master)
|
||||
![Docs Status](https://readthedocs.org/projects/bash-it/badge/)
|
||||
![License](https://img.shields.io/github/license/Bash-it/bash-it)
|
||||
![shell](https://img.shields.io/badge/Shell-Bash-blue)
|
||||
[![Join the chat at https://web.libera.chat/?channel=#bash-it](https://img.shields.io/badge/chat-on%20Libera.Chat-brightgreen.svg)](https://web.libera.chat/?channel=#bash-it)
|
||||
|
||||
**Bash-it** is a collection of community Bash commands and scripts for Bash 3.2+.
|
||||
(And a shameless ripoff of [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) :smiley:)
|
||||
|
||||
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.
|
||||
|
||||
- [Main Page](https://bash-it.readthedocs.io/en/latest)
|
||||
- [Contributing](#contributing)
|
||||
- [Installation](#installation)
|
||||
- [Install Options](https://bash-it.readthedocs.io/en/latest/installation/#install-options)
|
||||
- [via Docker](https://bash-it.readthedocs.io/en/latest/installation/#install-using-docker)
|
||||
- [Updating](https://bash-it.readthedocs.io/en/latest/installation/#updating)
|
||||
- [Help](https://bash-it.readthedocs.io/en/latest/misc/#help-screens)
|
||||
- [Search](https://bash-it.readthedocs.io/en/latest/commands/search)
|
||||
- [Syntax](https://bash-it.readthedocs.io/en/latest/commands/search/#syntax)
|
||||
- [Searching with Negations](
|
||||
https://bash-it.readthedocs.io/en/latest/commands/search/#searching-with-negations)
|
||||
- [Using Search to Enable or Disable Components](https://bash-it.readthedocs.io/en/latest/commands/search/#using-search-to-enable-or-disable-components)
|
||||
- [Disabling ASCII Color](https://bash-it.readthedocs.io/en/latest/commands/search/#disabling-ascii-color)
|
||||
- [Custom scripts, aliases, themes, and functions](
|
||||
https://bash-it.readthedocs.io/en/latest/custom)
|
||||
- [Themes](https://bash-it.readthedocs.io/en/latest/themes)
|
||||
- [Uninstalling](https://bash-it.readthedocs.io/en/latest/uninstalling)
|
||||
- [Misc](https://bash-it.readthedocs.io/en/latest/misc)
|
||||
- [Help Out](https://bash-it.readthedocs.io/en/latest/#help-out)
|
||||
- [Contributors](#contributors)
|
||||
|
||||
## 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! :smiley:
|
||||
|
||||
You can check out more components of Bash-it, and customize it to your desire.
|
||||
For more information, see detailed instructions [here](https://bash-it.readthedocs.io/en/latest/installation/).
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
Please take a look at the [Contribution Guidelines](https://bash-it.readthedocs.io/en/latest/contributing) before reporting a bug or providing a new feature.
|
||||
|
||||
The [Development Guidelines](https://bash-it.readthedocs.io/en/latest/development) 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](https://github.com/Bash-it/bash-it/contributors)
|
||||
|
||||
## License
|
||||
|
||||
Bash-it is licensed under the [MIT License](https://github.com/Bash-it/bash-it/blob/master/LICENSE).
|
|
@ -1,58 +0,0 @@
|
|||
.. _installation:
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
|
||||
#. 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``
|
||||
#. Run ``~/.bash_it/install.sh`` (it automatically backs up your ``~/.bash_profile`` or ``~/.bashrc``\ , depending on your OS)
|
||||
#. Edit your modified config (\ ``~/.bash_profile`` or ``~/.bashrc``\ ) file in order to customize Bash-it.
|
||||
#. Check out available aliases, completions, and plugins and enable the ones you want to use (see the next section for more details).
|
||||
|
||||
Install Options
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
The install script can take the following options:
|
||||
|
||||
|
||||
* ``--interactive``\ : Asks the user which aliases, completions and plugins to enable.
|
||||
* ``--silent``\ : Ask nothing and install using default settings.
|
||||
* ``--no-modify-config``\ : Do not modify the existing config file (\ ``~/.bash_profile`` or ``~/.bashrc``\ ).
|
||||
* ``--append-to-config``\ : Back up existing config file and append bash-it templates at the end.
|
||||
|
||||
When run without the ``--interactive`` switch, Bash-it only enables a sane default set of functionality to keep your shell clean and to avoid issues with missing dependencies.
|
||||
Feel free to enable the tools you want to use after the installation.
|
||||
|
||||
When you run without the ``--no-modify-config`` switch, the Bash-it installer automatically modifies/replaces your existing config file.
|
||||
Use the ``--no-modify-config`` switch to avoid unwanted modifications, e.g. if your Bash config file already contains the code that loads Bash-it.
|
||||
|
||||
**NOTE**\ : Keep in mind how Bash loads its configuration files,
|
||||
``.bash_profile`` for login shells (and in macOS in terminal emulators like `Terminal.app <http://www.apple.com/osx/apps/>`_ or
|
||||
`iTerm2 <https://www.iterm2.com/>`_\ ) and ``.bashrc`` for interactive shells (default mode in most of the GNU/Linux terminal emulators),
|
||||
to ensure that Bash-it is loaded correctly.
|
||||
A good "practice" is sourcing ``.bashrc`` into ``.bash_profile`` to keep things working in all the scenarios.
|
||||
To achieve this, you can add this snippet in your ``.bash_profile``\ :
|
||||
|
||||
.. code-block::
|
||||
|
||||
if [ -f ~/.bashrc ]; then
|
||||
. ~/.bashrc
|
||||
fi
|
||||
|
||||
Refer to the official `Bash documentation <https://www.gnu.org/software/bash/manual/bashref.html#Bash-Startup-Files>`_ to get more info.
|
||||
|
||||
Install using Docker
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can try Bash-it in an isolated environment without changing any local files via a `Docker <https://www.docker.com/>`_ Container.
|
||||
(Bash Shell v4.4 with Bash-it, `bats <https://github.com/sstephenson/bats>`_\ ,and bash-completion based on `Alpine Linux <https://alpinelinux.org/>`_\ ).
|
||||
|
||||
``docker pull ellerbrock/bash-it``
|
||||
|
||||
Have a look at our `bash-it-docker repository <https://github.com/Bash-it/bash-it-docker>`_ for further information.
|
||||
|
||||
Updating
|
||||
^^^^^^^^
|
||||
|
||||
See :ref:`update command <update>`.
|
0
scripts/bash-logo
Normal file → Executable file
0
scripts/bash-logo
Normal file → Executable file
0
scripts/bash-logo-colors
Normal file → Executable file
0
scripts/bash-logo-colors
Normal file → Executable file
Loading…
Reference in New Issue
Block a user