Merge branch 'master' into theme_barbuk/add_commmand_time_duration
BarbUk
commit
a2787b8730
|
|
@ -5,6 +5,7 @@ indent_style = space
|
|||
indent_size = 2
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
|
|
@ -13,3 +14,17 @@ trim_trailing_whitespace = false
|
|||
|
||||
[.git*]
|
||||
indent_style = tab
|
||||
|
||||
[*.*sh]
|
||||
indent_style = tab
|
||||
indent_size = 4
|
||||
|
||||
shell_variant = bash
|
||||
binary_next_line = true # like -bn
|
||||
switch_case_indent = true # like -ci
|
||||
space_redirects = true # like -sr
|
||||
keep_padding = true # like -kp
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
|
|
|||
|
|
@ -1,2 +1,5 @@
|
|||
*.sh text eol=lf
|
||||
*.bash text eol=lf
|
||||
|
||||
# Windows files
|
||||
*.bat text eol=crlf
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
# Configuration for probot-no-response - https://github.com/probot/no-response
|
||||
|
||||
# Number of days of inactivity before an Issue is closed for lack of response
|
||||
daysUntilClose: 14
|
||||
# Label requiring a response
|
||||
responseRequiredLabel: waiting-for-response
|
||||
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
|
||||
closeComment: >
|
||||
This issue has been automatically closed because there has been no response
|
||||
to our request for more information from the original author.
|
||||
You can always reopen the issue if needed.
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
name: CI
|
||||
|
||||
# Triggers the workflow on push or pull request events
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
branches: [ master ]
|
||||
|
||||
jobs:
|
||||
bats-test:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-20.04, ubuntu-18.04, ubuntu-16.04, macos-10.15, macos-11.0]
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Install greadlink
|
||||
if: startsWith(runner.os, 'macOS')
|
||||
run: brew install coreutils
|
||||
- name: Test code
|
||||
run: test/run
|
||||
|
||||
build-docs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.8
|
||||
- name: Install docs dependencies
|
||||
run: python3 -m pip install -r docs/requirements.txt
|
||||
- name: Build the docs
|
||||
run: sphinx-build -W -b html docs docs/_build/html
|
||||
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: 1.14
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.8
|
||||
- name: Install shfmt
|
||||
run: GO111MODULE=on go get mvdan.cc/sh/v3/cmd/shfmt
|
||||
- name: Install shellcheck
|
||||
run: brew install shellcheck
|
||||
- name: Install pre-commit
|
||||
run: python3 -m pip install -r test/lint-requirements.txt
|
||||
- name: Run lint
|
||||
run: ./lint_clean_files.sh
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# See https://pre-commit.com for more information
|
||||
# See https://pre-commit.com/hooks.html for more hooks
|
||||
---
|
||||
# fail_fast: true
|
||||
minimum_pre_commit_version: 1.18.1
|
||||
exclude: "docs/_build/"
|
||||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v2.3.0
|
||||
hooks:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- id: check-merge-conflict
|
||||
- id: mixed-line-ending
|
||||
- id: check-added-large-files
|
||||
- repo: https://github.com/jumanjihouse/pre-commit-hooks
|
||||
rev: 2.1.4
|
||||
hooks:
|
||||
- id: git-check # Configure in .gitattributes
|
||||
- id: shellcheck
|
||||
exclude: ".bats$"
|
||||
- id: shfmt
|
||||
exclude: ".bats$"
|
||||
- repo: https://github.com/Lucas-C/pre-commit-hooks
|
||||
rev: v1.1.7
|
||||
hooks:
|
||||
# - id: forbid-crlf
|
||||
- id: remove-crlf
|
||||
exclude: ".bat$"
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
version: 2
|
||||
|
||||
sphinx:
|
||||
builder: htmldir
|
||||
configuration: docs/conf.py
|
||||
|
||||
python:
|
||||
version: 3.7
|
||||
install:
|
||||
- requirements: docs/requirements.txt
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# We use colors and not assigned
|
||||
disable=SC2154
|
||||
# Hard to fix
|
||||
disable=SC2155
|
||||
# shellcheck is wrong on some
|
||||
disable=SC2034
|
||||
31
.travis.yml
31
.travis.yml
|
|
@ -1,31 +0,0 @@
|
|||
# YAML anchors need to appear first.
|
||||
# Keys starting with an underscore are the custom ones, refer to
|
||||
# https://docs.travis-ci.com/user/build-config-yaml#private-keys-as-yaml-anchors-and-aliases-and-external-tooling
|
||||
|
||||
_native_job: &native_job
|
||||
script: |
|
||||
test/run
|
||||
|
||||
language: shell
|
||||
|
||||
os: linux
|
||||
|
||||
dist: xenial
|
||||
|
||||
jobs:
|
||||
- <<: *native_job
|
||||
name: Ubuntu 16.04
|
||||
|
||||
- <<: *native_job
|
||||
name: Ubuntu 18.04
|
||||
dist: bionic
|
||||
|
||||
- <<: *native_job
|
||||
name: MacOS xcode9.4
|
||||
os: osx
|
||||
osx_image: xcode9.4 # Default xcode on Travis.
|
||||
|
||||
- <<: *native_job
|
||||
name: MacOS xcode11.5
|
||||
os: osx
|
||||
osx_image: xcode11.5 # Latest xcode on Travis.
|
||||
|
|
@ -1,91 +0,0 @@
|
|||
# Contribution Guidelines
|
||||
|
||||
When contributing a new feature, a bug fix, a new theme, or any other change to Bash-it, please consider the following guidelines.
|
||||
Most of this is common sense, but please try to stick to the conventions listed here.
|
||||
|
||||
## Issues
|
||||
|
||||
* When opening a new issue in the issue tracker, please include information about which _Operating System_ you're using, and which version of _Bash_.
|
||||
* In many cases, it also makes sense to show which Bash-it plugins you are using.
|
||||
This information can be obtained using `bash-it show plugins`.
|
||||
* If the issue happens while loading Bash-it, please also include your `~/.bash_profile` or `~/.bashrc` file,
|
||||
as well as the install location of Bash-it (default should be `~/.bash_it`).
|
||||
* When reporting a bug or requesting a new feature, consider providing a Pull Request that fixes the issue or can be used as a starting point for the new feature.
|
||||
Don't be afraid, most things aren't that complex...
|
||||
|
||||
## Pull Requests
|
||||
|
||||
* Fork the Bash-it repo, create a new feature branch from _master_ and apply your changes there.
|
||||
Create a _Pull Request_ from your feature branch against Bash-it's _master_ branch.
|
||||
* Limit each Pull Request to one feature.
|
||||
Don't bundle multiple features/changes (e.g. a new _Theme_ and a fix to an existing plugin) into a single Pull Request - create one PR for the theme, and a separate PR for the fix.
|
||||
* For complex changes, try to _squash_ your changes into a single commit before
|
||||
pushing code. Once you've pushed your code and opened a PR, please refrain
|
||||
from force-pushing changes to the PR branch – remember, Bash-it is a
|
||||
distributed project and your branch may be in use already.
|
||||
* When in doubt, open a PR with too many commits. Bash-it is a learning project
|
||||
for everyone involved. Showing your work provides a great history for folks
|
||||
to learn what works and what didn't.
|
||||
|
||||
## Code Style
|
||||
|
||||
* Try to stick to the existing code style. Please don't reformat or change the syntax of existing code simply because you don't like that style.
|
||||
* Indentation is using spaces, not tabs. Most of the code is indented with 2 spaces, some with 4 spaces. Please try to stick to 2 spaces.
|
||||
If you're using an editor that supports [EditorConfig](http://EditorConfig.org), the editor should automatically use the settings defined in Bash-it's [.editorconfig file](.editorconfig).
|
||||
* When creating new functions, please use a dash ("-") to separate the words of the function's name, e.g. `my-new-function`.
|
||||
Don't use underscores, e.g. `my_new_function`.
|
||||
* Internal functions that aren't to be used by the end user should start with an underscore, e.g. `_my-new-internal-function`.
|
||||
* Use the provided meta functions to document your code, e.g. `about-plugin`, `about`, `group`, `param`, `example`.
|
||||
This will make it easier for other people to use your new functionality.
|
||||
Take a look at the existing code for an example (e.g. [the base plugin](plugins/available/base.plugin.bash)).
|
||||
* When adding files, please use the existing file naming conventions, e.g. plugin files need to end in `.plugin.bash`.
|
||||
This is important for the installation functionality.
|
||||
* When using the `$BASH_IT` variable, please always enclose it in double quotes to ensure that the code also works when Bash-it is installed in a directory that contains spaces in its name: `for f in "${BASH_IT}/plugins/available"/*.bash ; do echo "$f" ; done`
|
||||
* Bash-it supports Bash 3.2 and higher. Please don't use features only available in Bash 4, such as associative arrays.
|
||||
|
||||
## Unit Tests
|
||||
|
||||
When adding features or making changes/fixes, please run our growing unit test suite to ensure that you did not break existing functionality.
|
||||
The test suite does not cover all aspects of Bash-it, but please run it anyway to verify that you did not introduce any regression issues.
|
||||
|
||||
Any code pushed to GitHub as part of a Pull Request will automatically trigger a continuous integration build on [Travis CI](https://travis-ci.org/Bash-it/bash-it), where the test suite is run on both Linux and macOS.
|
||||
The Pull Request will then show the result of the Travis build, indicating whether all tests ran fine, or whether there were issues.
|
||||
Please pay attention to this, Pull Requests with build issues will not be merged.
|
||||
|
||||
Adding new functionality or changing existing functionality is a good opportunity to increase Bash-it's test coverage.
|
||||
When you're changing the Bash-it codebase, please consider adding some unit tests that cover the new or changed functionality.
|
||||
Ideally, when fixing a bug, a matching unit test that verifies that the bug is no longer present, is added at the same time.
|
||||
|
||||
To run the test suite, simply execute the following in the directory where you cloned Bash-it:
|
||||
|
||||
```bash
|
||||
test/run
|
||||
```
|
||||
|
||||
This command will ensure that the [Bats Test Framework](https://github.com/bats-core/bats-core) is available in the local `test_lib` directory (Bats is included as a Git submodule) and then run the test suite found in the [test](test) folder.
|
||||
The test script will execute each test in turn, and will print a status for each test case.
|
||||
|
||||
When adding new test cases, please take a look at the existing test cases for examples.
|
||||
|
||||
The following libraries are used to help with the tests:
|
||||
|
||||
* Test Framework: https://github.com/bats-core/bats-core
|
||||
* Support library for Bats-Assert: https://github.com/ztombol/bats-support
|
||||
* General `assert` functions: https://github.com/ztombol/bats-assert
|
||||
* File `assert` functions: https://github.com/ztombol/bats-file
|
||||
|
||||
When verifying test results, please try to use the `assert` functions found in these libraries.
|
||||
|
||||
## Features
|
||||
|
||||
* When adding new completions or plugins, please don't simply copy existing tools into the Bash-it codebase, try to load/integrate the tools instead.
|
||||
An example is using `nvm`: Instead of copying the existing `nvm` script into Bash-it, the `nvm.plugin.bash` file tries to load an existing installation of `nvm`.
|
||||
This means an additional step for the user (installing `nvm` from its own repo, or through a package manager),
|
||||
but it will also ensure that `nvm` can be upgraded in an easy way.
|
||||
|
||||
## Themes
|
||||
|
||||
* When adding a new theme, please include a screenshot and a short description about what makes this theme unique in the Pull Request's description field.
|
||||
Please do not add theme screenshots to the repo itself, as they will add unnecessary bloat to the repo.
|
||||
The project's Wiki has a _Themes_ page where you can add a screenshot if you want.
|
||||
* Ideally, each theme's folder should contain a `README.md` file describing the theme and its configuration options.
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
# Bash-it Development
|
||||
|
||||
This page summarizes a couple of rules to keep in mind when developing features or making changes in Bash-it.
|
||||
|
||||
## Debugging and Logging
|
||||
|
||||
### General Logging
|
||||
|
||||
While developing feature or making changes in general, you can log error/warning/debug
|
||||
using `_log_error` `_log_warning` and `_log_debug`. This will help you solve problems quicker
|
||||
and also propagate important notes to other users of Bash-it.
|
||||
You can see the logs by using `bash-it doctor` command to reload and see the logs.
|
||||
Alternatively, you can set `BASH_IT_LOG_LEVEL` to `BASH_IT_LOG_LEVEL_ERROR`, `BASH_IT_LOG_LEVEL_WARNING` or `BASH_IT_LOG_LEVEL_ALL`.
|
||||
|
||||
### Log Prefix/Context
|
||||
|
||||
You can define `BASH_IT_LOG_PREFIX` in your files in order to a have a constant prefix before your logs.
|
||||
Note that we prefer to uses "tags" based logging, i.e `plugins: git: DEBUG: Loading git plugin`.
|
||||
|
||||
|
||||
## Load Order
|
||||
|
||||
### General Load Order
|
||||
|
||||
The main `bash_it.sh` script loads the frameworks individual components in the following order:
|
||||
|
||||
* `lib/composure.bash`
|
||||
* Files in `lib` with the exception of `appearance.bash` - this means that `composure.bash` is loaded again here (possible improvement?)
|
||||
* Enabled `aliases`
|
||||
* Enabled `plugins`
|
||||
* Enabled `completions`
|
||||
* `themes/colors.theme.bash`
|
||||
* `themes/base.theme.bash`
|
||||
* `lib/appearance.bash`, which loads the selected theme
|
||||
* Custom `aliases`
|
||||
* Custom `plugins`
|
||||
* Custom `completions`
|
||||
* Additional custom files from either `$BASH_IT/custom` or `$BASH_IT_CUSTOM`
|
||||
|
||||
This order is subject to change.
|
||||
|
||||
### Individual Component Load Order
|
||||
|
||||
For `aliases`, `plugins` and `completions`, the following rules are applied that influence the load order:
|
||||
|
||||
* There is a global `enabled` directory, which the enabled components are linked into. Enabled plugins are symlinked from `$BASH_IT/plugins/available` to `$BASH_IT/enabled` for example. All component types are linked into the same common `$BASH_IT/enabled` directory.
|
||||
* Within the common `enabled` directories, the files are loaded in alphabetical order, which is based on the item's load priority (see next item).
|
||||
* When enabling a component, a _load priority_ is assigned to the file. The following default priorities are used:
|
||||
* Aliases: 150
|
||||
* Plugins: 250
|
||||
* Completions: 350
|
||||
* When symlinking a component into the `enabled` directory, the load priority is used as a prefix for the linked name, separated with three dashes from the name of the component. The `node.plugin.bash` would be symlinked to `250---node.plugin.bash` for example.
|
||||
* Each file can override the default load priority by specifying a new value. To do this, the file needs to include a comment in the following form. This example would cause the `node.plugin.bash` (if included in that file) to be linked to `225---node.plugin.bash`:
|
||||
|
||||
```bash
|
||||
# BASH_IT_LOAD_PRIORITY: 225
|
||||
```
|
||||
|
||||
Having the order based on a numeric priority in a common directory allows for more flexibility. While in general, aliases are loaded first (since their default priority is 150), it's possible to load some aliases after the plugins, or some plugins after completions by setting the items' load priority. This is more flexible than a fixed type-based order or a strict alphabetical order based on name.
|
||||
|
||||
These items are subject to change. When making changes to the internal functionality, this page needs to be updated as well.
|
||||
|
||||
## Plugin Disable Callbacks
|
||||
|
||||
Plugins can define a function that will be called when the plugin is being disabled.
|
||||
The callback name should be `{PLUGIN_NAME}_on_disable`, you can see `gitstatus` for usage example.
|
||||
502
README.md
502
README.md
|
|
@ -1,502 +0,0 @@
|
|||
# Bash-it
|
||||
|
||||
[](https://travis-ci.com/Bash-it/bash-it)
|
||||
[](https://gitter.im/Bash-it/bash-it?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
**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.
|
||||
|
||||
- [Contributing](#contributing)
|
||||
- [Installation](#installation)
|
||||
- [Install Options](#install-options)
|
||||
- [via Docker](#install-using-docker)
|
||||
- [Updating](#updating)
|
||||
- [Help](#help-screens)
|
||||
- [Search](#search)
|
||||
- [Syntax](#syntax)
|
||||
- [Searching with Negations](#searching-with-negations)
|
||||
- [Using Search to Enable or Disable Components](#using-search-to-enable-or-disable-components)
|
||||
- [Disabling ASCII Color](#disabling-ascii-color)
|
||||
- [Custom scripts, aliases, themes, and functions](#custom-scripts-aliases-themes-and-functions)
|
||||
- [Themes](#themes)
|
||||
- [Uninstalling](#uninstalling)
|
||||
- [Misc](#misc)
|
||||
- [Help Out](#help-out)
|
||||
- [Contributors](#contributors)
|
||||
|
||||
## Contributing
|
||||
|
||||
Please take a look at the [Contribution Guidelines](CONTRIBUTING.md) before reporting a bug or providing a new feature.
|
||||
|
||||
The [Development Guidelines](DEVELOPMENT.md) 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.
|
||||
|
||||
## 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` (it automatically backs up your `~/.bash_profile` or `~/.bashrc`, depending on your OS)
|
||||
3. Edit your modified config (`~/.bash_profile` or `~/.bashrc`) file in order to customize Bash-it.
|
||||
4. 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`).
|
||||
|
||||
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`:
|
||||
|
||||
```
|
||||
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
|
||||
|
||||
To update Bash-it to the latest stable version, simply run:
|
||||
|
||||
```bash
|
||||
bash-it update stable
|
||||
```
|
||||
|
||||
If you want to update to the latest dev version (directly from master), run:
|
||||
|
||||
```bash
|
||||
bash-it update dev
|
||||
```
|
||||
|
||||
If you want to update automatically and unattended, you can add the optional
|
||||
`-s/--silent` flag, for example:
|
||||
|
||||
```bash
|
||||
bash-it update dev --silent
|
||||
```
|
||||
|
||||
If you are using an older version of Bash-it, it's possible that some functionality has changed, or that the internal structure of how Bash-it organizes its functionality has been updated.
|
||||
For these cases, we provide a `migrate` command:
|
||||
|
||||
```bash
|
||||
bash-it migrate
|
||||
```
|
||||
|
||||
This command will automatically migrate the Bash-it structure to the latest version.
|
||||
The `migrate` command is run automatically if you run the `update`, `enable` or `disable` commands.
|
||||
|
||||
## Help Screens
|
||||
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
## Search
|
||||
|
||||
If you need to quickly find out which of the plugins, aliases or completions are available for a specific framework, programming language, or an environment, you can _search_ for multiple terms related to the commands you use frequently.
|
||||
Search will find and print out modules with the name or description matching the terms provided.
|
||||
|
||||
### Syntax
|
||||
|
||||
```bash
|
||||
bash-it search term1 [[-]term2] [[-]term3]....
|
||||
```
|
||||
|
||||
As an example, a ruby developer might want to enable everything related to the commands such as `ruby`, `rake`, `gem`, `bundler`, and `rails`.
|
||||
Search command helps you find related modules so that you can decide which of them you'd like to use:
|
||||
|
||||
```bash
|
||||
❯ bash-it search ruby rake gem bundle irb rails
|
||||
aliases: bundler rails
|
||||
plugins: chruby chruby-auto ruby
|
||||
completions: bundler gem rake
|
||||
```
|
||||
|
||||
Currently enabled modules will be shown in green.
|
||||
|
||||
### Searching with Negations
|
||||
|
||||
You can prefix a search term with a "-" to exclude it from the results.
|
||||
In the above example, if we wanted to hide `chruby` and `chruby-auto`,
|
||||
we could change the command as follows:
|
||||
|
||||
```bash
|
||||
❯ bash-it search ruby rake gem bundle irb rails -chruby
|
||||
aliases: bundler rails
|
||||
plugins: ruby
|
||||
completions: bundler gem rake
|
||||
```
|
||||
|
||||
### Using Search to Enable or Disable Components
|
||||
|
||||
By adding a `--enable` or `--disable` to the search command, you can automatically enable all modules that come up as a result of a search query.
|
||||
This could be quite handy if you like to enable a bunch of components related to the same topic.
|
||||
|
||||
### Disabling ASCII Color
|
||||
|
||||
To remove non-printing non-ASCII characters responsible for the coloring of the search output, you can set environment variable `NO_COLOR`.
|
||||
Enabled components will then be shown with a checkmark:
|
||||
|
||||
```bash
|
||||
❯ NO_COLOR=1 bash-it search ruby rake gem bundle irb rails -chruby
|
||||
aliases => ✓bundler ✓rails
|
||||
plugins => ✓ruby
|
||||
completions => bundler gem rake
|
||||
```
|
||||
|
||||
## Custom scripts, aliases, themes, and functions
|
||||
|
||||
For custom scripts, and aliases, just create the following files (they'll be ignored by the git repo):
|
||||
|
||||
* `aliases/custom.aliases.bash`
|
||||
* `completion/custom.completion.bash`
|
||||
* `lib/custom.bash`
|
||||
* `plugins/custom.plugins.bash`
|
||||
* `custom/themes/<custom theme name>/<custom theme name>.theme.bash`
|
||||
|
||||
Anything in the custom directory will be ignored, with the exception of `custom/example.bash`.
|
||||
|
||||
Alternately, if you would like to keep your custom scripts under version control, you can set `BASH_IT_CUSTOM` in your `~/.bashrc` to another location outside of the `$BASH_IT` folder.
|
||||
In this case, any `*.bash` file under every directory below `BASH_IT_CUSTOM` folder will be used.
|
||||
|
||||
## Themes
|
||||
|
||||
There are over 50+ Bash-it themes to pick from in `$BASH_IT/themes`.
|
||||
The default theme is `bobby`.
|
||||
Set `BASH_IT_THEME` to the theme name you want, or if you've developed your own custom theme outside of `$BASH_IT/themes`,
|
||||
point the `BASH_IT_THEME` variable directly to the theme file.
|
||||
To disable theming completely, leave the variable empty.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
# Use the "powerline-multiline" theme
|
||||
export BASH_IT_THEME="powerline-multiline"
|
||||
|
||||
# Use a theme outside of the Bash-it folder
|
||||
export BASH_IT_THEME="/home/foo/my_theme/my_theme.theme.bash"
|
||||
|
||||
# Disable theming
|
||||
export BASH_IT_THEME=""
|
||||
```
|
||||
|
||||
You can easily preview the themes in your own shell using `BASH_PREVIEW=true bash-it reload`.
|
||||
|
||||
If you've created your own custom prompts, we'd love it if you shared them with everyone else! Just submit a Pull Request.
|
||||
You can see theme screenshots on [wiki/Themes](https://github.com/Bash-it/bash-it/wiki/Themes).
|
||||
|
||||
**NOTE**: Bash-it and some themes use UTF-8 characters, so to avoid strange behavior in your terminal, set your locale to `LC_ALL=en_US.UTF-8` or the equivalent to your language if it isn't American English.
|
||||
|
||||
## Uninstalling
|
||||
|
||||
To uninstall Bash-it, run the `uninstall.sh` script found in the `$BASH_IT` directory:
|
||||
|
||||
```
|
||||
cd $BASH_IT
|
||||
./uninstall.sh
|
||||
```
|
||||
|
||||
This will restore your previous Bash profile.
|
||||
After the uninstall script finishes, remove the Bash-it directory from your machine (`rm -rf $BASH_IT`) and start a new shell.
|
||||
|
||||
## Misc
|
||||
|
||||
### Bash Profile Aliases
|
||||
|
||||
Bash-it creates a `reload` alias that makes it convenient to reload
|
||||
your Bash profile when you make changes.
|
||||
|
||||
Additionally, if you export `BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE` as a non-null value,
|
||||
Bash-it will automatically reload itself after activating or deactivating plugins, aliases, or completions.
|
||||
|
||||
### Prompt Version Control Check
|
||||
|
||||
Bash-it provides prompt themes with the ability to check and display version control information for the current directory.
|
||||
The information is retrieved for each directory and can slow down the navigation of projects with a large number of files and folders.
|
||||
Turn version control checking off to prevent slow directory navigation within large projects.
|
||||
|
||||
Bash-it provides a flag (`SCM_CHECK`) within the `~/.bash_profile` file that turns off/on version control information checking and display within all themes.
|
||||
Version control checking is on by default unless explicitly turned off.
|
||||
|
||||
Set `SCM_CHECK` to 'false' to **turn off** version control checks for all themes:
|
||||
|
||||
* `export SCM_CHECK=false`
|
||||
|
||||
Set `SCM_CHECK` to 'true' (the default value) to **turn on** version control checks for all themes:
|
||||
|
||||
* `export SCM_CHECK=true`
|
||||
|
||||
**NOTE:**
|
||||
It is possible for themes to ignore the `SCM_CHECK` flag and query specific version control information directly.
|
||||
For example, themes that use functions like `git_prompt_vars` skip the `SCM_CHECK` flag to retrieve and display git prompt information.
|
||||
If you turned version control checking off and you still see version control information within your prompt, then functions like `git_prompt_vars` are most likely the reason why.
|
||||
|
||||
### Git prompt
|
||||
|
||||
Bash-it has some nice features related to Git, continue reading to know more about these features.
|
||||
|
||||
### Repository info in the prompt
|
||||
|
||||
Bash-it can show some information about Git repositories in the shell prompt: the current branch, tag or commit you are at, how many commits the local branch is ahead or behind from the remote branch, and if you have changes stashed.
|
||||
|
||||
Additionally, you can view the status of your working copy and get the count of *staged*, *unstaged* and *untracked* files.
|
||||
This feature is controlled through the flag `SCM_GIT_SHOW_DETAILS` as follows:
|
||||
|
||||
Set `SCM_GIT_SHOW_DETAILS` to 'true' (the default value) to **show** the working copy details in your prompt:
|
||||
|
||||
* `export SCM_GIT_SHOW_DETAILS=true`
|
||||
|
||||
Set `SCM_GIT_SHOW_DETAILS` to 'false' to **don't show** it:
|
||||
|
||||
* `export SCM_GIT_SHOW_DETAILS=false`
|
||||
|
||||
**NOTE:** If using `SCM_GIT_SHOW_MINIMAL_INFO=true`, then the value of `SCM_GIT_SHOW_DETAILS` is ignored.
|
||||
|
||||
### Remotes and remote branches
|
||||
|
||||
In some git workflows, you must work with various remotes, for this reason, Bash-it can provide some useful information about your remotes and your remote branches, for example, the remote on you are working, or if your local branch is tracking a remote branch.
|
||||
|
||||
You can control this feature with the flag `SCM_GIT_SHOW_REMOTE_INFO` as follows:
|
||||
|
||||
Set `SCM_GIT_SHOW_REMOTE_INFO` to 'auto' (the default value) to activate it only when more than one remote is configured in the current repo:
|
||||
|
||||
* `export SCM_GIT_SHOW_REMOTE_INFO=auto`
|
||||
|
||||
Set `SCM_GIT_SHOW_REMOTE_INFO` to 'true' to always activate the feature:
|
||||
|
||||
* `export SCM_GIT_SHOW_REMOTE_INFO=true`
|
||||
|
||||
Set `SCM_GIT_SHOW_REMOTE_INFO` to 'false' to **disable the feature**:
|
||||
|
||||
* `export SCM_GIT_SHOW_REMOTE_INFO=false`
|
||||
|
||||
**NOTE:** If using `SCM_GIT_SHOW_MINIMAL_INFO=true`, then the value of `SCM_GIT_SHOW_REMOTE_INFO` is ignored.
|
||||
|
||||
### Untracked files
|
||||
|
||||
By default, the `git status` command shows information about *untracked* files.
|
||||
This behavior can be controlled through command-line flags or git configuration files.
|
||||
For big repositories, ignoring *untracked* files can make git faster.
|
||||
Bash-it uses `git status` to gather the repo information it shows in the prompt, so in some circumstances, it can be useful to instruct Bash-it to ignore these files.
|
||||
You can control this behavior with the flag `SCM_GIT_IGNORE_UNTRACKED`:
|
||||
|
||||
Set `SCM_GIT_IGNORE_UNTRACKED` to 'false' (the default value) to get information about *untracked* files:
|
||||
|
||||
* `export SCM_GIT_IGNORE_UNTRACKED=false`
|
||||
|
||||
Set `SCM_GIT_IGNORE_UNTRACKED` to 'true' to **ignore** *untracked* files:
|
||||
|
||||
* `export SCM_GIT_IGNORE_UNTRACKED=true`
|
||||
|
||||
Also, with this flag to false, Bash-it will not show the repository as dirty when the repo has *untracked* files, and will not display the count of *untracked* files.
|
||||
|
||||
**NOTE:** If you set in git configuration file the option to ignore *untracked* files, this flag has no effect, and Bash-it will ignore *untracked* files always.
|
||||
|
||||
### Stash item count
|
||||
|
||||
When `SCM_GIT_SHOW_DETAILS` is enabled, you can get the count of *stashed* items. This feature can be useful when a user has a lot of stash items.
|
||||
This feature is controlled through the flag `SCM_GIT_SHOW_STASH_INFO` as follows:
|
||||
|
||||
Set `SCM_GIT_SHOW_STASH_INFO` to 'true' (the default value) to **show** the count of stashed items:
|
||||
|
||||
* `export SCM_GIT_SHOW_STASH_INFO=true`
|
||||
|
||||
Set `SCM_GIT_SHOW_STASH_INFO` to 'false' to **don't show** it:
|
||||
|
||||
* `export SCM_GIT_SHOW_STASH_INFO=false`
|
||||
|
||||
### Ahead/Behind Count
|
||||
|
||||
When displaying information regarding whether or not the local branch is ahead or behind its remote counterpart, you can opt to display the number of commits ahead/behind.
|
||||
This is useful if you only care whether or not you are ahead or behind and do not care how far ahead/behind you are.
|
||||
|
||||
Set `SCM_GIT_SHOW_COMMIT_COUNT` to 'true' (the default value) to **show** the count of commits ahead/behind:
|
||||
|
||||
* `export SCM_GIT_SHOW_COMMIT_COUNT=true`
|
||||
|
||||
Set `SCM_GIT_SHOW_COMMIT_COUNT` to 'false' to **don't show** it:
|
||||
|
||||
* `export SCM_GIT_SHOW_COMMIT_COUNT=false`
|
||||
|
||||
### Git user
|
||||
|
||||
In some environments, it is useful to know the value of the current git user, which is used to mark all new commits.
|
||||
For example, any organization that uses the practice of pair programming will typically author each commit with [combined names of the two authors](https://github.com/pivotal/git_scripts).
|
||||
When another pair uses the same pairing station, the authors are changed at the beginning of the session.
|
||||
|
||||
To get up and running with this technique, run `gem install pivotal_git_scripts`, and then edit your `~/.pairs` file, according to the specification on the [gem's homepage](https://github.com/pivotal/git_scripts).
|
||||
After that, you should be able to run `git pair kg as` to set the author to, eg. "Konstantin Gredeskoul and Alex Saxby", assuming they've been added to the `~/.pairs` file.
|
||||
Please see gem's documentation for more information.
|
||||
|
||||
To enable the display of the current pair in the prompt, you must set `SCM_GIT_SHOW_CURRENT_USER` to `true`.
|
||||
Once set, the `SCM_CURRENT_USER` variable will be automatically populated with the initials of the git author(s).
|
||||
It will also be included in the default git prompt.
|
||||
Even if you do not have `git pair` installed, as long as your `user.name` is set, your initials will be computed from your name and shown in the prompt.
|
||||
|
||||
You can control the prefix and the suffix of this component using the two variables:
|
||||
|
||||
* `export SCM_THEME_CURRENT_USER_PREFFIX=' ☺︎ '`
|
||||
|
||||
And
|
||||
|
||||
* `export SCM_THEME_CURRENT_USER_SUFFIX=' ☺︎ '`
|
||||
|
||||
**NOTE:** If using `SCM_GIT_SHOW_MINIMAL_INFO=true`, then the value of `SCM_GIT_SHOW_CURRENT_USER` is ignored.
|
||||
|
||||
### Git show minimal status info
|
||||
|
||||
To speed up the prompt while still getting minimal git status information displayed such as the value of `HEAD` and whether there are any dirty objects, you can set:
|
||||
|
||||
```
|
||||
export SCM_GIT_SHOW_MINIMAL_INFO=true
|
||||
```
|
||||
|
||||
### Ignore repo status
|
||||
|
||||
When working in repos with a large codebase, Bash-it can slow down your prompt when checking the repo status.
|
||||
To avoid it, there is an option you can set via Git config to disable checking repo status in Bash-it.
|
||||
|
||||
To disable checking the status in the current repo:
|
||||
|
||||
```
|
||||
$ git config --add bash-it.hide-status 1
|
||||
```
|
||||
|
||||
But if you would like to disable it globally, and stop checking the status for all of your repos:
|
||||
|
||||
```
|
||||
$ git config --global --add bash-it.hide-status 1
|
||||
```
|
||||
|
||||
Setting this flag globally has the same effect as `SCM_CHECK=true`, but only for Git repos.
|
||||
|
||||
### Speed up git status calculations
|
||||
|
||||
As an alternative to ignoring repo status entirely, you can try out the `gitstatus` plugin.
|
||||
This plugin speeds up all `git status` calculations by up to 10x times!
|
||||
|
||||
**NOTE**: You will need to clone `gitstatus` repo from [here](https://github.com/romkatv/gitstatus).
|
||||
|
||||
### Pass function renamed to passgen
|
||||
|
||||
The Bash-it `pass` function has been renamed to `passgen` in order to avoid a naming conflict with the [pass password manager](https://www.passwordstore.org/).
|
||||
In order to minimize the impact on users of the legacy Bash-it `pass` function, Bash-it will create the alias `pass` that calls the new `passgen` function if the `pass` password manager command is not found on the `PATH` (default behavior).
|
||||
|
||||
This behavior can be overridden with the `BASH_IT_LEGACY_PASS` flag as follows:
|
||||
|
||||
Set `BASH_IT_LEGACY_PASS` to 'true' to force Bash-it to always **create** the `pass` alias to `passgen`:
|
||||
|
||||
* `export BASH_IT_LEGACY_PASS=true`
|
||||
|
||||
Unset `BASH_IT_LEGACY_PASS` to have Bash-it **return to default behavior**:
|
||||
|
||||
* `unset BASH_IT_LEGACY_PASS`
|
||||
|
||||
### Debugging
|
||||
|
||||
If you encounter problems with any part of Bash-it, run the following command:
|
||||
```bash
|
||||
bash-it doctor
|
||||
```
|
||||
This will reload your bash profile and print out logs of various parts in Bash-it.
|
||||
Note that this command at default will print all logs, including debug logs.
|
||||
You can call it like this:
|
||||
```bash
|
||||
bash-it doctor [errors/warnings/all]
|
||||
```
|
||||
In order to get wanted verbosity.
|
||||
|
||||
### Proxy Support
|
||||
|
||||
If you are working in a corporate environment where you have to go through a proxy server for internet access,
|
||||
then you know how painful it is to configure the OS proxy variables in the shell,
|
||||
especially if you are switching between environments, e.g. office (with proxy) and home (without proxy).
|
||||
|
||||
The Bash shell (and many shell tools) use the following variables to define the proxy to use:
|
||||
|
||||
* `HTTP_PROXY` (and `http_proxy`): Defines the proxy server for HTTP requests
|
||||
* `HTTPS_PROXY` (and `https_proxy`): Defines the proxy server for HTTPS requests
|
||||
* `ALL_PROXY` (and `all_proxy`): Used by some tools for the same purpose as above
|
||||
* `NO_PROXY` (and `no_proxy`): Comma-separated list of hostnames that don't have to go through the proxy
|
||||
|
||||
Bash-it's `proxy` plugin allows to enable and disable these variables with a simple command.
|
||||
To start using the `proxy` plugin, run the following:
|
||||
|
||||
```bash
|
||||
bash-it enable plugin proxy
|
||||
```
|
||||
|
||||
Bash-it also provides support for enabling/disabling proxy settings for various shell tools.
|
||||
The following backends are currently supported (in addition to the shell's environment variables): Git, SVN, npm, ssh.
|
||||
The `proxy` plugin changes the configuration files of these tools to enable or disable the proxy settings.
|
||||
|
||||
Bash-it uses the following variables to set the shell's proxy settings when you call `enable-proxy`.
|
||||
These variables are best defined in a custom script in Bash-it's custom script folder (`$BASH_IT/custom`), e.g. `$BASH_IT/custom/proxy.env.bash`
|
||||
* `BASH_IT_HTTP_PROXY` and `BASH_IT_HTTPS_PROXY`: Define the proxy URL to be used, e.g. 'http://localhost:1234'
|
||||
* `BASH_IT_NO_PROXY`: A comma-separated list of proxy exclusions, e.g. `127.0.0.1,localhost`
|
||||
|
||||
Once you have defined these variables (and have run `reload` to load the changes), you can use the following commands to enable or disable the proxy settings in your current shell:
|
||||
|
||||
* `enable-proxy`: This sets the shell's proxy environment variables and configures proxy support in your SVN, npm, and SSH configuration files.
|
||||
* `disable-proxy`: This unsets the shell's proxy environment variables and disables proxy support in your SVN, npm, and SSH configuration files.
|
||||
|
||||
There are many more proxy commands, e.g. for changing the local Git project's proxy settings.
|
||||
Run `glossary proxy` to show the available proxy functions with a short description.
|
||||
|
||||
## Help out
|
||||
|
||||
We 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 us a pull request and we'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 we merge your changes in.
|
||||
|
||||
Please take a look at the [Contribution Guidelines](CONTRIBUTING.md) before reporting a bug or providing a new feature.
|
||||
|
||||
Thanks, and happing bashing!
|
||||
|
||||
|
||||
## Contributors
|
||||
|
||||
* [List of contributors][contribute]
|
||||
|
||||
[contribute]: https://github.com/Bash-it/bash-it/contributors
|
||||
[pass password manager]: http://www.passwordstore.org/
|
||||
|
|
@ -7,7 +7,7 @@ case $OSTYPE in
|
|||
[[ $XCLIP ]] && \
|
||||
alias pbcopy="$XCLIP -selection clipboard" && \
|
||||
alias pbpaste="$XCLIP -selection clipboard -o"
|
||||
;;
|
||||
;;
|
||||
esac
|
||||
|
||||
# to use it just install xclip on your distribution and it would work like:
|
||||
|
|
|
|||
|
|
@ -8,4 +8,3 @@ fi
|
|||
alias please=fuck
|
||||
alias plz=please
|
||||
alias fucking=sudo
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,7 @@ alias gpr='git pull --rebase'
|
|||
alias gpp='git pull && git push'
|
||||
alias gup='git fetch && git rebase'
|
||||
alias gp='git push'
|
||||
alias gpd='git push --delete'
|
||||
alias gpo='git push origin HEAD'
|
||||
alias gpu='git push --set-upstream'
|
||||
alias gpuo='git push --set-upstream origin'
|
||||
|
|
@ -64,6 +65,7 @@ alias gco='git checkout'
|
|||
alias gcom='git checkout master'
|
||||
alias gcb='git checkout -b'
|
||||
alias gcob='git checkout -b'
|
||||
alias gcobu='git checkout -b ${USER}/'
|
||||
alias gct='git checkout --track'
|
||||
alias gcpd='git checkout master; git pull; git branch -D'
|
||||
alias gexport='git archive --format zip --output'
|
||||
|
|
@ -121,6 +123,10 @@ fi
|
|||
# Show untracked files
|
||||
alias gu='git ls-files . --exclude-standard --others'
|
||||
|
||||
# Git SVN
|
||||
alias gsr='git svn rebase'
|
||||
alias gsd='git svn dcommit'
|
||||
|
||||
case $OSTYPE in
|
||||
darwin*)
|
||||
alias gtls="git tag -l | gsort -V"
|
||||
|
|
|
|||
|
|
@ -6,4 +6,3 @@ alias node-dev='export NODE_ENV=development'
|
|||
|
||||
# alias to setup nodejs production environment
|
||||
alias node-prod='export NODE_ENV=production'
|
||||
|
||||
|
|
|
|||
|
|
@ -7,4 +7,3 @@ alias puplint="puppet-lint *.pp"
|
|||
alias pupagt="puppet agent -t"
|
||||
alias pupagtd="puppet agent -t --debug"
|
||||
alias pupapp="puppet apply"
|
||||
|
||||
|
|
|
|||
|
|
@ -8,4 +8,3 @@ alias tfv='terraform validate'
|
|||
alias tfp='terraform plan'
|
||||
alias tfa='terraform apply'
|
||||
alias tfd='terraform destory'
|
||||
|
||||
|
|
|
|||
|
|
@ -13,4 +13,3 @@ alias tgva='terragrunt validate-all'
|
|||
alias tgpa='terragrunt plan-all'
|
||||
alias tgaa='terragrunt apply-all'
|
||||
alias tgda='terragrunt destroy-all'
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,36 @@
|
|||
#######################################################################
|
||||
# Allow-list of files to be lint-checked by CI
|
||||
#
|
||||
# Directory Suport
|
||||
# Directory references are allowed within the file, ie:
|
||||
#
|
||||
# themes/powerline
|
||||
#
|
||||
# All files under the referenced directory will be checked
|
||||
#
|
||||
# Checking Files Locally
|
||||
# You can manually invoke the check via:
|
||||
#
|
||||
# lint_clean_files.sh
|
||||
#
|
||||
|
||||
# root directories
|
||||
#
|
||||
docs
|
||||
|
||||
# root files
|
||||
#
|
||||
.gitattributes
|
||||
lint_clean_files.sh
|
||||
|
||||
# themes
|
||||
#
|
||||
themes/90210
|
||||
themes/powerline
|
||||
|
||||
# completions
|
||||
#
|
||||
completion/available/cargo.completion.bash
|
||||
completion/available/knife.completion.bash
|
||||
completion/available/pipx.completion.bash
|
||||
completion/available/rustup.completion.bash
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# cargo (Rust package manager) completion
|
||||
|
||||
if _binary_exists rustup && _binary_exists cargo; then
|
||||
eval "$(rustup completions bash cargo)"
|
||||
fi
|
||||
|
|
@ -7,4 +7,4 @@ then
|
|||
complete -C "$CONSUL_BIN" consul
|
||||
fi
|
||||
|
||||
unset CONSUL_BIN
|
||||
unset CONSUL_BIN
|
||||
|
|
|
|||
|
|
@ -69,4 +69,3 @@ else
|
|||
fi
|
||||
|
||||
complete -F _python_django_completion -o default $pythons
|
||||
|
||||
|
|
|
|||
|
|
@ -670,4 +670,4 @@ _docker_compose() {
|
|||
eval "$__docker_compose_previous_extglob_setting"
|
||||
unset __docker_compose_previous_extglob_setting
|
||||
|
||||
complete -F _docker_compose docker-compose docker-compose.exe
|
||||
complete -F _docker_compose docker-compose docker-compose.exe
|
||||
|
|
|
|||
|
|
@ -413,4 +413,4 @@ _docker_machine() {
|
|||
return 0
|
||||
}
|
||||
|
||||
complete -F _docker_machine docker-machine docker-machine.exe
|
||||
complete -F _docker_machine docker-machine docker-machine.exe
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ _installcomp() {
|
|||
then
|
||||
REMOTE_GEMS=( $(gem list --remote --no-versions | tr '\n' ' ') )
|
||||
fi
|
||||
|
||||
|
||||
local cur=${COMP_WORDS[COMP_CWORD]}
|
||||
COMPREPLY=( $(compgen -W "${REMOTE_GEMS[*]}" -- $cur) )
|
||||
}
|
||||
|
|
@ -16,7 +16,7 @@ _uninstallcomp() {
|
|||
then
|
||||
LOCAL_GEMS=( $(gem list --no-versions | sed 's/\*\*\* LOCAL GEMS \*\*\*//' | tr '\n' ' ') )
|
||||
fi
|
||||
|
||||
|
||||
local cur=${COMP_WORDS[COMP_CWORD]}
|
||||
COMPREPLY=( $(compgen -W "${LOCAL_GEMS[*]}" -- $cur) )
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,47 +2,47 @@
|
|||
#
|
||||
# git-flow-completion
|
||||
# ===================
|
||||
#
|
||||
#
|
||||
# Bash completion support for [git-flow](http://github.com/nvie/gitflow)
|
||||
#
|
||||
#
|
||||
# The contained completion routines provide support for completing:
|
||||
#
|
||||
#
|
||||
# * git-flow init and version
|
||||
# * feature, hotfix and release branches
|
||||
# * remote feature branch names (for `git-flow feature track`)
|
||||
#
|
||||
#
|
||||
#
|
||||
#
|
||||
# Installation
|
||||
# ------------
|
||||
#
|
||||
#
|
||||
# To achieve git-flow completion nirvana:
|
||||
#
|
||||
#
|
||||
# 0. Install git-completion.
|
||||
#
|
||||
#
|
||||
# 1. Install this file. Either:
|
||||
#
|
||||
#
|
||||
# a. Place it in a `bash-completion.d` folder:
|
||||
#
|
||||
#
|
||||
# * /etc/bash-completion.d
|
||||
# * /usr/local/etc/bash-completion.d
|
||||
# * ~/bash-completion.d
|
||||
#
|
||||
#
|
||||
# b. Or, copy it somewhere (e.g. ~/.git-flow-completion.sh) and put the following line in
|
||||
# your .bashrc:
|
||||
#
|
||||
#
|
||||
# source ~/.git-flow-completion.sh
|
||||
#
|
||||
#
|
||||
# 2. If you are using Git < 1.7.1: Edit git-completion.sh and add the following line to the giant
|
||||
# $command case in _git:
|
||||
#
|
||||
#
|
||||
# flow) _git_flow ;;
|
||||
#
|
||||
#
|
||||
#
|
||||
#
|
||||
# The Fine Print
|
||||
# --------------
|
||||
#
|
||||
#
|
||||
# Copyright (c) 2010 [Justin Hileman](http://justinhileman.com)
|
||||
#
|
||||
#
|
||||
# Distributed under the [MIT License](http://creativecommons.org/licenses/MIT/)
|
||||
|
||||
_git_flow ()
|
||||
|
|
@ -128,7 +128,7 @@ __git_flow_release ()
|
|||
__gitcomp "$subcommands"
|
||||
return
|
||||
fi
|
||||
|
||||
|
||||
case "$subcommand" in
|
||||
finish)
|
||||
__gitcomp "$(__git_flow_list_releases)"
|
||||
|
|
@ -174,4 +174,4 @@ __git_flow_list_hotfixes ()
|
|||
# temporarily wrap __git_find_on_cmdline() for backwards compatibility
|
||||
if [ -z "`type -t __git_find_subcommand`" ]; then
|
||||
alias __git_find_subcommand=__git_find_on_cmdline
|
||||
fi
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
cite "about-completion"
|
||||
about-completion "GitHub CLI completion"
|
||||
|
||||
if _command_exists gh; then
|
||||
if _binary_exists gh; then
|
||||
if _command_exists brew; then
|
||||
_log_warning "You don't need github-cli completion enabled if you have system completion enabled"
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -57,4 +57,3 @@ _homesick_complete()
|
|||
}
|
||||
|
||||
complete -o bashdefault -o default -F _homesick_complete homesick
|
||||
|
||||
|
|
|
|||
|
|
@ -28,4 +28,3 @@ _complete_invoke() {
|
|||
# * -o default: when function generates no results, use filenames.
|
||||
# * positional args: program names to complete for.
|
||||
complete -F _complete_invoke -o default invoke inv
|
||||
|
||||
|
|
|
|||
|
|
@ -14,17 +14,17 @@ _serverProfiles(){
|
|||
# assume is domain.sh
|
||||
serverdir="../domain/configuration/"
|
||||
fi
|
||||
|
||||
|
||||
for i in ${!COMP_WORDS[*]}
|
||||
do
|
||||
if [[ "${COMP_WORDS[i]}" == "-Djboss.server.base.dir" || "${COMP_WORDS[i]}" == "-Djboss.domain.base.dir" ]]; then
|
||||
serverdir="${COMP_WORDS[i+2]}/configuration"
|
||||
fi
|
||||
|
||||
fi
|
||||
|
||||
done
|
||||
if [ -d "${serverdir}" ]
|
||||
then
|
||||
|
||||
|
||||
IFS=$'\n' tmp="$(ls "${serverdir}" | grep xml)"
|
||||
local fls="${tmp[@]// /\ }"
|
||||
unset IFS
|
||||
|
|
@ -42,13 +42,13 @@ _bindingAddress(){
|
|||
}
|
||||
|
||||
_jboss(){
|
||||
|
||||
|
||||
local cur prev words cword
|
||||
COMPREPLY=()
|
||||
_get_comp_words_by_ref -n = cur prev words cword
|
||||
|
||||
|
||||
case $cur in
|
||||
|
||||
|
||||
-Djboss.socket.binding.port-offset=*)
|
||||
cur=${cur#*=}
|
||||
#static list of common bindings sets
|
||||
|
|
@ -70,13 +70,13 @@ _jboss(){
|
|||
COMPREPLY=( $(compgen -W "${booleans}" -- ${cur}) )
|
||||
return 0
|
||||
;;
|
||||
|
||||
|
||||
-Djboss.server.base.dir=*|-Djboss.home.dir=*|-Djboss.domain.base.dir=*)
|
||||
cur=${cur#*=}
|
||||
_filedir -d
|
||||
return 0
|
||||
;;
|
||||
|
||||
|
||||
-Djboss.domain.master.address=*|-Djboss.bind.address*=*)
|
||||
cur=${cur#*=}
|
||||
_bindingAddress
|
||||
|
|
@ -85,8 +85,8 @@ _jboss(){
|
|||
--server-config=*|-c=|--host-config=*)
|
||||
cur=${cur#*=}
|
||||
_serverProfiles
|
||||
return 0
|
||||
|
||||
return 0
|
||||
|
||||
|
||||
esac
|
||||
|
||||
|
|
@ -110,14 +110,14 @@ _jboss(){
|
|||
;;
|
||||
esac
|
||||
# *** from jboss5 ********************
|
||||
# *** -modulepath -c -m -g -l -d -p -n -B -L -C -Djboss.platform.mbeanserver -Djboss.server.base.directory
|
||||
# *** -modulepath -c -m -g -l -d -p -n -B -L -C -Djboss.platform.mbeanserver -Djboss.server.base.directory
|
||||
# *** -Djboss.Domain -Djboss.modcluster.proxyList -Djboss.jvmRoute -Djboss.default.jgroups.stack -Dorg.jboss.ejb3.remoting.IsLocalInterceptor.passByRef -Djboss.platform.mbeanserver -Dcom.sun.management.jmxremote.port -Dcom.sun.management.jmxremote.ssl
|
||||
# *************************************
|
||||
|
||||
|
||||
# standard commands for standalone and domain mode
|
||||
local commandsWithoutEqualSign='-b -bmanagement -bunsecure -bpublic --admin-only -h -help -u -version -V -v'
|
||||
local commandsWithEqualSign='-P -Djboss.node.name -Djboss.home.dir -Djboss.socket.binding.port-offset -Djboss.bind.address.management -Djboss.bind.address -Djboss.bind.address.unsecure'
|
||||
|
||||
|
||||
if [[ $COMP_WORDS == *standalone.sh* ]]
|
||||
then
|
||||
commandsWithoutEqualSign="${commandsWithoutEqualSign} -c"
|
||||
|
|
@ -127,15 +127,15 @@ _jboss(){
|
|||
commandsWithoutEqualSign="${commandsWithoutEqualSign} --backup --cached-dc"
|
||||
commandsWithEqualSign="${commandsWithEqualSign} -Djboss.domain.master.address --host-config -Djboss.domain.master.port -Djboss.domain.base.dir "
|
||||
fi
|
||||
|
||||
|
||||
|
||||
|
||||
COMPREPLY=( $( compgen -W "$commandsWithoutEqualSign" -- "$cur" )
|
||||
$( compgen -W "$commandsWithEqualSign" -S '=' -- "$cur" ) )
|
||||
|
||||
|
||||
|
||||
COMPREPLY=( $( compgen -W "$commandsWithoutEqualSign" -- "$cur" )
|
||||
$( compgen -W "$commandsWithEqualSign" -S '=' -- "$cur" ) )
|
||||
return 0
|
||||
|
||||
|
||||
|
||||
}
|
||||
complete -o nospace -F _jboss standalone.sh
|
||||
complete -o nospace -F _jboss domain.sh
|
||||
|
|
|
|||
|
|
@ -3,4 +3,3 @@
|
|||
if _command_exists kind; then
|
||||
eval "$(kind completion bash)"
|
||||
fi
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# Published originally as public domain code at https://github.com/wk8/knife-bash-autocomplete
|
||||
|
||||
##############
|
||||
### CONFIG ###
|
||||
##############
|
||||
|
|
@ -19,7 +21,7 @@ _KNIFE_AUTOCOMPLETE_MAX_CACHE_AGE=86400
|
|||
### init
|
||||
_KAC_CACHE_TMP_DIR="$_KNIFE_AUTOCOMPLETE_CACHE_DIR/tmp"
|
||||
# make sure the cache dir exists
|
||||
mkdir -p $_KAC_CACHE_TMP_DIR
|
||||
mkdir -p "$_KAC_CACHE_TMP_DIR"
|
||||
|
||||
##############################
|
||||
### Cache helper functions ###
|
||||
|
|
@ -31,177 +33,169 @@ stat -c %Y /dev/null > /dev/null 2>&1 && _KAC_STAT_COMMAND="stat -c %Y" || _KAC_
|
|||
# returns 0 iff the file whose path is given as 1st argument
|
||||
# exists and has last been modified in the last $2 seconds
|
||||
# returns 1 otherwise
|
||||
_KAC_is_file_newer_than()
|
||||
{
|
||||
[ -f "$1" ] || return 1
|
||||
[ $(( $(date +%s) - $($_KAC_STAT_COMMAND "$1") )) -gt $2 ] && return 1 || return 0
|
||||
_KAC_is_file_newer_than() {
|
||||
[ -f "$1" ] || return 1
|
||||
[ $(($(date +%s) - $($_KAC_STAT_COMMAND "$1"))) -gt "$2" ] && return 1 || return 0
|
||||
}
|
||||
|
||||
# helper function for _KAC_get_and_regen_cache, see doc below
|
||||
_KAC_regen_cache()
|
||||
{
|
||||
local CACHE_NAME=$1
|
||||
local CACHE_PATH="$_KNIFE_AUTOCOMPLETE_CACHE_DIR/$CACHE_NAME"
|
||||
local TMP_FILE=$(mktemp "$_KAC_CACHE_TMP_DIR/$CACHE_NAME.XXXX")
|
||||
shift 1
|
||||
"$@" > $TMP_FILE 2> /dev/null
|
||||
# discard the temp file if it's empty AND the previous command didn't exit successfully, but still mark the cache as updated
|
||||
[[ $? != 0 ]] && [[ $(cat $TMP_FILE | wc -l) == 0 ]] && rm -f $TMP_FILE && touch $CACHE_PATH && return 1 \
|
||||
|| mv -f $TMP_FILE $CACHE_PATH
|
||||
_KAC_regen_cache() {
|
||||
local CACHE_NAME=$1
|
||||
local CACHE_PATH="$_KNIFE_AUTOCOMPLETE_CACHE_DIR/$CACHE_NAME"
|
||||
local TMP_FILE=$(mktemp "$_KAC_CACHE_TMP_DIR/$CACHE_NAME.XXXX")
|
||||
shift 1
|
||||
# discard the temp file if it's empty AND the previous command didn't exit successfully, but still mark the cache as updated
|
||||
if ! "$@" > "$TMP_FILE" 2> /dev/null; then
|
||||
[[ $(wc -l "$TMP_FILE") == 0 ]] && rm -f "$TMP_FILE" && touch "$CACHE_PATH" && return 1
|
||||
else
|
||||
mv -f "$TMP_FILE" "$CACHE_PATH"
|
||||
fi
|
||||
}
|
||||
|
||||
# cached files can't have spaces in their names
|
||||
_KAC_get_cache_name_from_command()
|
||||
{
|
||||
echo "$@" | sed 's/ /_SPACE_/g'
|
||||
_KAC_get_cache_name_from_command() {
|
||||
echo "${@/ /_SPACE_}"
|
||||
}
|
||||
|
||||
# the reverse operation from the function above
|
||||
_KAC_get_command_from_cache_name()
|
||||
{
|
||||
echo "$@" | sed 's/_SPACE_/ /g'
|
||||
_KAC_get_command_from_cache_name() {
|
||||
echo "${@/_SPACE_/ }"
|
||||
}
|
||||
|
||||
# given a command as argument, it fetches the cache for that command if it can find it
|
||||
# otherwise it waits for the cache to be generated
|
||||
# in either case, it regenerates the cache, and sets the _KAC_CACHE_PATH env variable
|
||||
# for obvious reason, do NOT call that in a sub-shell (in particular, no piping)
|
||||
_KAC_get_and_regen_cache()
|
||||
{
|
||||
# the cache name can't have space in it
|
||||
local CACHE_NAME=$(_KAC_get_cache_name_from_command "$@")
|
||||
local REGEN_CMD="_KAC_regen_cache $CACHE_NAME $@"
|
||||
_KAC_CACHE_PATH="$_KNIFE_AUTOCOMPLETE_CACHE_DIR/$CACHE_NAME"
|
||||
# no need to wait for the regen if the file already exists
|
||||
[ -f $_KAC_CACHE_PATH ] && ($REGEN_CMD &) || $REGEN_CMD
|
||||
_KAC_get_and_regen_cache() {
|
||||
# the cache name can't have space in it
|
||||
local CACHE_NAME=$(_KAC_get_cache_name_from_command "$@")
|
||||
local REGEN_CMD="_KAC_regen_cache $CACHE_NAME $*"
|
||||
_KAC_CACHE_PATH="$_KNIFE_AUTOCOMPLETE_CACHE_DIR/$CACHE_NAME"
|
||||
# no need to wait for the regen if the file already exists
|
||||
if [[ -f "$_KAC_CACHE_PATH" ]]; then
|
||||
($REGEN_CMD &)
|
||||
else
|
||||
$REGEN_CMD
|
||||
fi
|
||||
}
|
||||
|
||||
# performs two things: first, deletes all obsolete temp files
|
||||
# then refreshes stale caches that haven't been called in a long time
|
||||
_KAC_clean_cache()
|
||||
{
|
||||
local FILE CMD
|
||||
# delete all obsolete temp files, could be lingering there for any kind of crash in the caching process
|
||||
for FILE in $(ls $_KAC_CACHE_TMP_DIR)
|
||||
do
|
||||
_KAC_is_file_newer_than $FILE $_KNIFE_AUTOCOMPLETE_MAX_CACHE_AGE || rm -f $FILE
|
||||
done
|
||||
# refresh really stale caches
|
||||
for FILE in $(find $_KNIFE_AUTOCOMPLETE_CACHE_DIR -maxdepth 1 -type f -not -name '.*')
|
||||
do
|
||||
_KAC_is_file_newer_than $FILE $_KNIFE_AUTOCOMPLETE_MAX_CACHE_AGE && continue
|
||||
# first let's get the original command
|
||||
CMD=$(_KAC_get_command_from_cache_name $(basename "$FILE"))
|
||||
# then regen the cache
|
||||
_KAC_get_and_regen_cache "$CMD" > /dev/null
|
||||
done
|
||||
_KAC_clean_cache() {
|
||||
local FILE CMD
|
||||
# delete all obsolete temp files, could be lingering there for any kind of crash in the caching process
|
||||
for FILE in "$_KAC_CACHE_TMP_DIR"/*; do
|
||||
_KAC_is_file_newer_than "$FILE" "$_KNIFE_AUTOCOMPLETE_MAX_CACHE_AGE" || rm -f "$FILE"
|
||||
done
|
||||
# refresh really stale caches
|
||||
find "$_KNIFE_AUTOCOMPLETE_CACHE_DIR" -maxdepth 1 -type f -not -name '.*' \
|
||||
| while read -r FILE; do
|
||||
_KAC_is_file_newer_than "$FILE" "$_KNIFE_AUTOCOMPLETE_MAX_CACHE_AGE" && continue
|
||||
# first let's get the original command
|
||||
CMD=$(_KAC_get_command_from_cache_name "$(basename "$FILE")")
|
||||
# then regen the cache
|
||||
_KAC_get_and_regen_cache "$CMD" > /dev/null
|
||||
done
|
||||
}
|
||||
|
||||
# perform a cache cleaning when loading this file
|
||||
_KAC_clean_cache
|
||||
# On big systems this could baloon up to a 30 second run or more, so not enabling by default.
|
||||
[[ "${KNIFE_CACHE_CLEAN}" ]] && _KAC_clean_cache
|
||||
|
||||
#####################################
|
||||
### End of cache helper functions ###
|
||||
#####################################
|
||||
|
||||
|
||||
# returns all the possible knife sub-commands
|
||||
_KAC_knife_commands()
|
||||
{
|
||||
knife --help | grep -E "^knife" | sed -E 's/ \(options\)//g'
|
||||
_KAC_knife_commands() {
|
||||
knife --help | grep -E "^knife" | sed -E 's/ \(options\)//g'
|
||||
}
|
||||
|
||||
# rebuilds the knife base command currently being completed, and assigns it to $_KAC_CURRENT_COMMAND
|
||||
# additionnally, returns 1 iff the current base command is not complete, 0 otherwise
|
||||
# also sets $_KAC_CURRENT_COMMAND_NB_WORDS if the base command is complete
|
||||
_KAC_get_current_base_command()
|
||||
{
|
||||
local PREVIOUS="knife"
|
||||
local I=1
|
||||
local CURRENT
|
||||
while [ $I -le $COMP_CWORD ]
|
||||
do
|
||||
# command words are all lower-case
|
||||
echo ${COMP_WORDS[$I]} | grep -E "^[a-z]+$" > /dev/null || break
|
||||
CURRENT="$PREVIOUS ${COMP_WORDS[$I]}"
|
||||
cat $_KAC_CACHE_PATH | grep -E "^$CURRENT" > /dev/null || break
|
||||
PREVIOUS=$CURRENT
|
||||
I=$(( $I + 1))
|
||||
done
|
||||
_KAC_CURRENT_COMMAND=$PREVIOUS
|
||||
[ $I -le $COMP_CWORD ] && _KAC_CURRENT_COMMAND_NB_WORDS=$I
|
||||
_KAC_get_current_base_command() {
|
||||
local PREVIOUS="knife"
|
||||
local I=1
|
||||
local CURRENT
|
||||
while [ $I -le "$COMP_CWORD" ]; do
|
||||
# command words are all lower-case
|
||||
echo "${COMP_WORDS[$I]}" | grep -E "^[a-z]+$" > /dev/null || break
|
||||
CURRENT="$PREVIOUS ${COMP_WORDS[$I]}"
|
||||
grep -E "^$CURRENT" "$_KAC_CACHE_PATH" > /dev/null || break
|
||||
PREVIOUS=$CURRENT
|
||||
I=$((I + 1))
|
||||
done
|
||||
_KAC_CURRENT_COMMAND=$PREVIOUS
|
||||
[ $I -le "$COMP_CWORD" ] && _KAC_CURRENT_COMMAND_NB_WORDS=$I
|
||||
}
|
||||
|
||||
# searches the position of the currently completed argument in the current base command
|
||||
# (i.e. handles "plural" arguments such as knife cookbook upload cookbook1 cookbook2 and so on...)
|
||||
# assumes the current base command is complete
|
||||
_KAC_get_current_arg_position()
|
||||
{
|
||||
local CURRENT_ARG_POS=$(( $_KAC_CURRENT_COMMAND_NB_WORDS + 1 ))
|
||||
local COMPLETE_COMMAND=$(cat $_KAC_CACHE_PATH | grep -E "^$_KAC_CURRENT_COMMAND")
|
||||
local CURRENT_ARG
|
||||
while [ $CURRENT_ARG_POS -le $COMP_CWORD ]
|
||||
do
|
||||
CURRENT_ARG=$(echo $COMPLETE_COMMAND | cut -d ' ' -f $CURRENT_ARG_POS)
|
||||
# we break if the current arg is a "plural" arg
|
||||
echo $CURRENT_ARG | grep -E "^\\[[^]]+(\\.\\.\\.\\]|$)" > /dev/null && break
|
||||
CURRENT_ARG_POS=$(( $CURRENT_ARG_POS + 1 ))
|
||||
done
|
||||
echo $CURRENT_ARG_POS
|
||||
_KAC_get_current_arg_position() {
|
||||
local CURRENT_ARG_POS=$((_KAC_CURRENT_COMMAND_NB_WORDS + 1))
|
||||
local COMPLETE_COMMAND=$(grep -E "^$_KAC_CURRENT_COMMAND" "$_KAC_CACHE_PATH")
|
||||
local CURRENT_ARG
|
||||
while [ "$CURRENT_ARG_POS" -le "$COMP_CWORD" ]; do
|
||||
CURRENT_ARG=$(echo "$COMPLETE_COMMAND" | cut -d ' ' -f "$CURRENT_ARG_POS")
|
||||
# we break if the current arg is a "plural" arg
|
||||
echo "$CURRENT_ARG" | grep -E "^\\[[^]]+(\\.\\.\\.\\]|$)" > /dev/null && break
|
||||
CURRENT_ARG_POS=$((CURRENT_ARG_POS + 1))
|
||||
done
|
||||
echo "$CURRENT_ARG_POS"
|
||||
}
|
||||
|
||||
# the actual auto-complete function
|
||||
_knife()
|
||||
{
|
||||
_KAC_get_and_regen_cache _KAC_knife_commands
|
||||
local RAW_LIST ITEM REGEN_CMD ARG_POSITION
|
||||
COMREPLY=()
|
||||
# get correct command & arg pos
|
||||
_KAC_get_current_base_command && ARG_POSITION=$(_KAC_get_current_arg_position) || ARG_POSITION=$(( $COMP_CWORD + 1 ))
|
||||
RAW_LIST=$(cat $_KAC_CACHE_PATH | grep -E "^$_KAC_CURRENT_COMMAND" | cut -d ' ' -f $ARG_POSITION | uniq)
|
||||
_knife() {
|
||||
_KAC_get_and_regen_cache _KAC_knife_commands
|
||||
local RAW_LIST ITEM REGEN_CMD ARG_POSITION
|
||||
COMREPLY=()
|
||||
# get correct command & arg pos
|
||||
_KAC_get_current_base_command && ARG_POSITION=$(_KAC_get_current_arg_position) || ARG_POSITION=$((COMP_CWORD + 1))
|
||||
RAW_LIST=$(grep -E "^$_KAC_CURRENT_COMMAND" "$_KAC_CACHE_PATH" | cut -d ' ' -f $ARG_POSITION | uniq)
|
||||
|
||||
# we need to process that raw list a bit, most notably for placeholders
|
||||
# NOTE: I chose to explicitely fetch & cache _certain_ informations for the server (cookbooks & node names, etc)
|
||||
# as opposed to a generic approach by trying to find a 'list' knife command corresponding to the
|
||||
# current base command - that might limit my script in some situation, but that way I'm sure it caches only
|
||||
# not-sensitive stuff (a generic approach could be pretty bad e.g. with the knife-rackspace plugin)
|
||||
LIST=""
|
||||
for ITEM in $RAW_LIST
|
||||
do
|
||||
# always relevant if only lower-case chars : continuation of the base command
|
||||
echo $ITEM | grep -E "^[a-z]+$" > /dev/null && LIST="$LIST $ITEM" && continue
|
||||
case $ITEM in
|
||||
*COOKBOOK*)
|
||||
# special case for cookbooks : from site or local
|
||||
[[ ${COMP_WORDS[2]} == 'site' ]] && REGEN_CMD="knife cookbook site list" || REGEN_CMD="knife cookbook list"
|
||||
_KAC_get_and_regen_cache $REGEN_CMD
|
||||
LIST="$LIST $(cat $_KAC_CACHE_PATH | cut -d ' ' -f 1)"
|
||||
continue
|
||||
;;
|
||||
*ITEM*)
|
||||
# data bag item : another special case
|
||||
local DATA_BAG_NAME=${COMP_WORDS[$(( COMP_CWORD-1 ))]}
|
||||
REGEN_CMD="knife data bag show $DATA_BAG_NAME"
|
||||
;;
|
||||
*INDEX*)
|
||||
# see doc @ http://docs.opscode.com/knife_search.html
|
||||
LIST="$LIST client environment node role"
|
||||
REGEN_CMD="knife data bag list"
|
||||
;;
|
||||
*BAG*) REGEN_CMD="knife data bag list";;
|
||||
*CLIENT*) REGEN_CMD="knife client list";;
|
||||
*NODE*) REGEN_CMD="knife node list";;
|
||||
*ENVIRONMENT*) REGEN_CMD="knife environment list";;
|
||||
*ROLE*) REGEN_CMD="knife role list";;
|
||||
*USER*) REGEN_CMD="knife user list";;
|
||||
# not a generic argument we support...
|
||||
*) continue;;
|
||||
esac
|
||||
_KAC_get_and_regen_cache $REGEN_CMD
|
||||
LIST="$LIST $(cat $_KAC_CACHE_PATH)"
|
||||
done
|
||||
COMPREPLY=( $(compgen -W "${LIST}" -- ${COMP_WORDS[COMP_CWORD]}))
|
||||
# we need to process that raw list a bit, most notably for placeholders
|
||||
# NOTE: I chose to explicitely fetch & cache _certain_ informations for the server (cookbooks & node names, etc)
|
||||
# as opposed to a generic approach by trying to find a 'list' knife command corresponding to the
|
||||
# current base command - that might limit my script in some situation, but that way I'm sure it caches only
|
||||
# not-sensitive stuff (a generic approach could be pretty bad e.g. with the knife-rackspace plugin)
|
||||
LIST=""
|
||||
for ITEM in $RAW_LIST; do
|
||||
# always relevant if only lower-case chars : continuation of the base command
|
||||
echo "$ITEM" | grep -E "^[a-z]+$" > /dev/null && LIST="$LIST $ITEM" && continue
|
||||
case "$ITEM" in
|
||||
*COOKBOOK*)
|
||||
# special case for cookbooks : from site or local
|
||||
[[ ${COMP_WORDS[2]} == 'site' ]] && REGEN_CMD="knife cookbook site list" || REGEN_CMD="knife cookbook list"
|
||||
_KAC_get_and_regen_cache "$REGEN_CMD"
|
||||
LIST="$LIST $(cut -d ' ' -f 1 < "$_KAC_CACHE_PATH")"
|
||||
continue
|
||||
;;
|
||||
*ITEM*)
|
||||
# data bag item : another special case
|
||||
local DATA_BAG_NAME=${COMP_WORDS[$((COMP_CWORD - 1))]}
|
||||
REGEN_CMD="knife data bag show $DATA_BAG_NAME"
|
||||
;;
|
||||
*INDEX*)
|
||||
# see doc @ http://docs.opscode.com/knife_search.html
|
||||
LIST="$LIST client environment node role"
|
||||
REGEN_CMD="knife data bag list"
|
||||
;;
|
||||
*BAG*) REGEN_CMD="knife data bag list" ;;
|
||||
*CLIENT*) REGEN_CMD="knife client list" ;;
|
||||
*NODE*) REGEN_CMD="knife node list" ;;
|
||||
*ENVIRONMENT*) REGEN_CMD="knife environment list" ;;
|
||||
*ROLE*) REGEN_CMD="knife role list" ;;
|
||||
*USER*) REGEN_CMD="knife user list" ;;
|
||||
# not a generic argument we support...
|
||||
*) continue ;;
|
||||
esac
|
||||
_KAC_get_and_regen_cache "$REGEN_CMD"
|
||||
LIST="$LIST $(cat "$_KAC_CACHE_PATH")"
|
||||
done
|
||||
# shellcheck disable=SC2207,SC2086
|
||||
COMPREPLY=($(compgen -W "${LIST}" -- ${COMP_WORDS[COMP_CWORD]}))
|
||||
}
|
||||
|
||||
#complete -f -F _knife knife
|
||||
complete -F _knife knife
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ if command -v laravel > /dev/null; then
|
|||
fi
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
complete -F __laravel_completion laravel
|
||||
fi
|
||||
|
||||
|
|
|
|||
|
|
@ -33,4 +33,4 @@ _mvn()
|
|||
|
||||
return 0
|
||||
} &&
|
||||
complete -F _mvn mvn
|
||||
complete -F _mvn mvn
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
if _command_exists ng; then
|
||||
# No longer supported, please see https://github.com/angular/angular-cli/issues/11043
|
||||
# Fix courtesy of https://stackoverflow.com/questions/50194674/ng-completion-no-longer-exists
|
||||
|
|
|
|||
|
|
@ -161,4 +161,3 @@ _packer_completion ()
|
|||
}
|
||||
|
||||
complete -o nospace -F _packer_completion packer
|
||||
|
||||
|
|
|
|||
|
|
@ -8,4 +8,3 @@
|
|||
if command -v pip3 >/dev/null; then
|
||||
eval "$(pip3 completion --bash)"
|
||||
fi
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,6 @@
|
|||
#!/usr/bin/env bash
|
||||
# pipx completion
|
||||
|
||||
if _command_exists register-python-argcomplete && _command_exists pipx; then
|
||||
eval "$(register-python-argcomplete pipx)"
|
||||
fi
|
||||
|
|
@ -44,4 +44,3 @@ _pj() {
|
|||
|
||||
complete -F _pj -o nospace pj
|
||||
complete -F _pj -o nospace pjo
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# rustup (Rust toolchain installer) completion
|
||||
|
||||
if _binary_exists rustup; then
|
||||
eval "$(rustup completions bash)"
|
||||
fi
|
||||
|
|
@ -13,7 +13,7 @@
|
|||
|
||||
|
||||
_salt_get_grains(){
|
||||
if [ "$1" = 'local' ] ; then
|
||||
if [ "$1" = 'local' ] ; then
|
||||
salt-call --out=txt -- grains.ls | sed 's/^.*\[//' | tr -d ",']" |sed 's:\([a-z0-9]\) :\1\: :g'
|
||||
else
|
||||
salt '*' --timeout 2 --out=txt -- grains.ls | sed 's/^.*\[//' | tr -d ",']" |sed 's:\([a-z0-9]\) :\1\: :g'
|
||||
|
|
@ -22,23 +22,23 @@ _salt_get_grains(){
|
|||
|
||||
_salt_get_grain_values(){
|
||||
if [ "$1" = 'local' ] ; then
|
||||
salt-call --out=txt -- grains.item $1 |sed 's/^\S*:\s//' |grep -v '^\s*$'
|
||||
salt-call --out=txt -- grains.item $1 |sed 's/^\S*:\s//' |grep -v '^\s*$'
|
||||
else
|
||||
salt '*' --timeout 2 --out=txt -- grains.item $1 |sed 's/^\S*:\s//' |grep -v '^\s*$'
|
||||
salt '*' --timeout 2 --out=txt -- grains.item $1 |sed 's/^\S*:\s//' |grep -v '^\s*$'
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
_salt(){
|
||||
local cur prev opts _salt_grains _salt_coms pprev ppprev
|
||||
local cur prev opts _salt_grains _salt_coms pprev ppprev
|
||||
COMPREPLY=()
|
||||
cur="${COMP_WORDS[COMP_CWORD]}"
|
||||
prev="${COMP_WORDS[COMP_CWORD-1]}"
|
||||
if [ ${COMP_CWORD} -gt 2 ]; then
|
||||
pprev="${COMP_WORDS[COMP_CWORD-2]}"
|
||||
pprev="${COMP_WORDS[COMP_CWORD-2]}"
|
||||
fi
|
||||
if [ ${COMP_CWORD} -gt 3 ]; then
|
||||
ppprev="${COMP_WORDS[COMP_CWORD-3]}"
|
||||
ppprev="${COMP_WORDS[COMP_CWORD-3]}"
|
||||
fi
|
||||
|
||||
opts="-h --help -d --doc --documentation --version --versions-report -c \
|
||||
|
|
@ -58,11 +58,11 @@ _salt(){
|
|||
case "${pprev}" in
|
||||
-G|--grain|--grain-pcre)
|
||||
if [ "${cur}" = ":" ]; then
|
||||
COMPREPLY=($(compgen -W "`_salt_get_grain_values ${prev}`" ))
|
||||
COMPREPLY=($(compgen -W "`_salt_get_grain_values ${prev}`" ))
|
||||
return 0
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
esac
|
||||
case "${ppprev}" in
|
||||
-G|--grain|--grain-pcre)
|
||||
if [ "${prev}" = ":" ]; then
|
||||
|
|
@ -70,17 +70,17 @@ _salt(){
|
|||
return 0
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
esac
|
||||
|
||||
if [ "${cur}" = "=" ] && [[ "${prev}" == --* ]]; then
|
||||
cur=""
|
||||
cur=""
|
||||
fi
|
||||
if [ "${prev}" = "=" ] && [[ "${pprev}" == --* ]]; then
|
||||
prev="${pprev}"
|
||||
fi
|
||||
|
||||
|
||||
case "${prev}" in
|
||||
|
||||
|
||||
-c|--config)
|
||||
COMPREPLY=($(compgen -f -- ${cur}))
|
||||
return 0
|
||||
|
|
@ -89,14 +89,14 @@ _salt(){
|
|||
COMPREPLY=($(compgen -W "\'*\' ${opts} `salt-key --no-color -l acc`" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-E|--pcre)
|
||||
-E|--pcre)
|
||||
COMPREPLY=($(compgen -W "`salt-key --no-color -l acc`" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-G|--grain|--grain-pcre)
|
||||
COMPREPLY=($(compgen -W "$(_salt_get_grains)" -- ${cur}))
|
||||
COMPREPLY=($(compgen -W "$(_salt_get_grains)" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
;;
|
||||
-C|--compound)
|
||||
COMPREPLY=() # TODO: finish this one? how?
|
||||
return 0
|
||||
|
|
@ -109,10 +109,10 @@ _salt(){
|
|||
COMPREPLY=($(compgen -W "1 2 3 4 5 6 7 8 9 10 15 20 30 40 50 60 70 80 90 100 120 150 200"))
|
||||
return 0
|
||||
;;
|
||||
-N|--nodegroup)
|
||||
MASTER_CONFIG='/etc/salt/master'
|
||||
COMPREPLY=($(compgen -W "`awk -F ':' 'BEGIN {print_line = 0}; /^nodegroups/ {print_line = 1;getline } print_line && /^ */ {print $1} /^[^ ]/ {print_line = 0}' <${MASTER_CONFIG}`" -- ${cur}))
|
||||
return 0
|
||||
-N|--nodegroup)
|
||||
MASTER_CONFIG='/etc/salt/master'
|
||||
COMPREPLY=($(compgen -W "`awk -F ':' 'BEGIN {print_line = 0}; /^nodegroups/ {print_line = 1;getline } print_line && /^ */ {print $1} /^[^ ]/ {print_line = 0}' <${MASTER_CONFIG}`" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
|
||||
|
|
@ -133,8 +133,8 @@ _saltkey(){
|
|||
prev="${COMP_WORDS[COMP_CWORD-1]}"
|
||||
opts="-c --config-dir= -h --help --version --versions-report -q --quiet \
|
||||
-y --yes --gen-keys= --gen-keys-dir= --keysize= --key-logfile= \
|
||||
-l --list= -L --list-all -a --accept= -A --accept-all \
|
||||
-r --reject= -R --reject-all -p --print= -P --print-all \
|
||||
-l --list= -L --list-all -a --accept= -A --accept-all \
|
||||
-r --reject= -R --reject-all -p --print= -P --print-all \
|
||||
-d --delete= -D --delete-all -f --finger= -F --finger-all \
|
||||
--out=pprint --out=yaml --out=overstatestage --out=json --out=raw \
|
||||
--out=highstate --out=key --out=txt --no-color --out-indent= "
|
||||
|
|
@ -150,13 +150,13 @@ _saltkey(){
|
|||
fi
|
||||
|
||||
if [ "${cur}" = "=" ] && [[ "${prev}" == --* ]]; then
|
||||
cur=""
|
||||
cur=""
|
||||
fi
|
||||
if [ "${prev}" = "=" ] && [[ "${pprev}" == --* ]]; then
|
||||
prev="${pprev}"
|
||||
fi
|
||||
|
||||
case "${prev}" in
|
||||
case "${prev}" in
|
||||
-a|--accept)
|
||||
COMPREPLY=($(compgen -W "$(salt-key -l un --no-color; salt-key -l rej --no-color)" -- ${cur}))
|
||||
return 0
|
||||
|
|
@ -177,7 +177,7 @@ _saltkey(){
|
|||
COMPREPLY=($(compgen -W "2048 3072 4096 5120 6144" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
--gen-keys)
|
||||
--gen-keys)
|
||||
return 0
|
||||
;;
|
||||
--gen-keys-dir)
|
||||
|
|
@ -193,7 +193,7 @@ _saltkey(){
|
|||
return 0
|
||||
;;
|
||||
--accept-all)
|
||||
return 0
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
COMPREPLY=($(compgen -W "${opts} " -- ${cur}))
|
||||
|
|
@ -221,30 +221,30 @@ _saltcall(){
|
|||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
fi
|
||||
|
||||
|
||||
if [ "${cur}" = "=" ] && [[ ${prev} == --* ]]; then
|
||||
cur=""
|
||||
fi
|
||||
if [ "${prev}" = "=" ] && [[ ${pprev} == --* ]]; then
|
||||
prev="${pprev}"
|
||||
fi
|
||||
|
||||
|
||||
case ${prev} in
|
||||
-m|--module-dirs)
|
||||
COMPREPLY=( $(compgen -d ${cur} ))
|
||||
return 0
|
||||
;;
|
||||
-l|--log-level)
|
||||
COMPREPLY=( $(compgen -W "info none garbage trace warning error debug" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-g|grains)
|
||||
return 0
|
||||
;;
|
||||
salt-call)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-m|--module-dirs)
|
||||
COMPREPLY=( $(compgen -d ${cur} ))
|
||||
return 0
|
||||
;;
|
||||
-l|--log-level)
|
||||
COMPREPLY=( $(compgen -W "info none garbage trace warning error debug" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-g|grains)
|
||||
return 0
|
||||
;;
|
||||
salt-call)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
|
||||
_salt_coms="$(salt-call --out=txt -- sys.list_functions|sed 's/^.*\[//' | tr -d ",']" )"
|
||||
|
|
@ -262,7 +262,7 @@ _saltcp(){
|
|||
prev="${COMP_WORDS[COMP_CWORD-1]}"
|
||||
opts="-t --timeout= -s --static -b --batch= --batch-size= \
|
||||
-h --help --version --versions-report -c --config-dir= \
|
||||
-E --pcre -L --list -G --grain --grain-pcre -N --nodegroup \
|
||||
-E --pcre -L --list -G --grain --grain-pcre -N --nodegroup \
|
||||
-R --range -C --compound -I --pillar \
|
||||
--out=pprint --out=yaml --out=overstatestage --out=json --out=raw \
|
||||
--out=highstate --out=key --out=txt --no-color --out-indent= "
|
||||
|
|
@ -270,60 +270,59 @@ _saltcp(){
|
|||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
fi
|
||||
|
||||
|
||||
if [ "${cur}" = "=" ] && [[ "${prev}" == --* ]]; then
|
||||
cur=""
|
||||
cur=""
|
||||
fi
|
||||
if [ "${prev}" = "=" ] && [[ "${pprev}" == --* ]]; then
|
||||
prev=${pprev}
|
||||
fi
|
||||
|
||||
case ${prev} in
|
||||
salt-cp)
|
||||
COMPREPLY=($(compgen -W "${opts} `salt-key -l acc --no-color`" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-t|--timeout)
|
||||
# those numbers are just a hint
|
||||
COMPREPLY=($(compgen -W "2 3 4 8 10 15 20 25 30 40 60 90 120 180 240 300" -- ${cur} ))
|
||||
return 0
|
||||
;;
|
||||
-E|--pcre)
|
||||
COMPREPLY=($(compgen -W "`salt-key -l acc --no-color`" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-L|--list)
|
||||
# IMPROVEMENTS ARE WELCOME
|
||||
prefpart="${cur%,*},"
|
||||
postpart=${cur##*,}
|
||||
filt="^\($(echo ${cur}| sed 's:,:\\|:g')\)$"
|
||||
helper=($(salt-key -l acc --no-color | grep -v "${filt}" | sed "s/^/${prefpart}/"))
|
||||
COMPREPLY=($(compgen -W "${helper[*]}" -- ${cur}))
|
||||
|
||||
return 0
|
||||
;;
|
||||
-G|--grain|--grain-pcre)
|
||||
COMPREPLY=($(compgen -W "$(_salt_get_grains)" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
# FIXME
|
||||
-R|--range)
|
||||
# FIXME ??
|
||||
return 0
|
||||
;;
|
||||
-C|--compound)
|
||||
# FIXME ??
|
||||
return 0
|
||||
;;
|
||||
-c|--config)
|
||||
COMPREPLY=($(compgen -f -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
case ${prev} in
|
||||
salt-cp)
|
||||
COMPREPLY=($(compgen -W "${opts} `salt-key -l acc --no-color`" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-t|--timeout)
|
||||
# those numbers are just a hint
|
||||
COMPREPLY=($(compgen -W "2 3 4 8 10 15 20 25 30 40 60 90 120 180 240 300" -- ${cur} ))
|
||||
return 0
|
||||
;;
|
||||
-E|--pcre)
|
||||
COMPREPLY=($(compgen -W "`salt-key -l acc --no-color`" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-L|--list)
|
||||
# IMPROVEMENTS ARE WELCOME
|
||||
prefpart="${cur%,*},"
|
||||
postpart=${cur##*,}
|
||||
filt="^\($(echo ${cur}| sed 's:,:\\|:g')\)$"
|
||||
helper=($(salt-key -l acc --no-color | grep -v "${filt}" | sed "s/^/${prefpart}/"))
|
||||
COMPREPLY=($(compgen -W "${helper[*]}" -- ${cur}))
|
||||
|
||||
return 0
|
||||
;;
|
||||
-G|--grain|--grain-pcre)
|
||||
COMPREPLY=($(compgen -W "$(_salt_get_grains)" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
# FIXME
|
||||
-R|--range)
|
||||
# FIXME ??
|
||||
return 0
|
||||
;;
|
||||
-C|--compound)
|
||||
# FIXME ??
|
||||
return 0
|
||||
;;
|
||||
-c|--config)
|
||||
COMPREPLY=($(compgen -f -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
|
||||
|
||||
# default is using opts:
|
||||
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
|
||||
}
|
||||
|
||||
complete -F _saltcp salt-cp
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
# |
|
||||
# Thanks to Alexander Korznikov |
|
||||
# http://www.korznikov.com/2014/12/bash-tab-completion-for-awesome-tool.html |
|
||||
# |
|
||||
# |
|
||||
# ---------------------------------------------------------------------------+
|
||||
|
||||
if command -v sqlmap > /dev/null; then
|
||||
|
|
@ -18,7 +18,7 @@ if command -v sqlmap > /dev/null; then
|
|||
prev=$(_get_pword)
|
||||
|
||||
case $prev in
|
||||
|
||||
|
||||
# List directory content
|
||||
--tamper)
|
||||
COMPREPLY=( $( compgen -W "$tamper" -- "$cur" ) )
|
||||
|
|
@ -108,7 +108,7 @@ if command -v sqlmap > /dev/null; then
|
|||
-z --alert --answers --beep --check-waf --cleanup \
|
||||
--dependencies --disable-coloring --gpage --identify-waf \
|
||||
--mobile --page-rank --purge-output --smart \
|
||||
--sqlmap-shell --wizard' -- "$cur" ) )
|
||||
--sqlmap-shell --wizard' -- "$cur" ) )
|
||||
# this removes any options from the list of completions that have
|
||||
# already been specified somewhere on the command line, as long as
|
||||
# these options can only be used once (in a word, "options", in
|
||||
|
|
@ -155,7 +155,7 @@ if command -v sqlmap > /dev/null; then
|
|||
done
|
||||
printf '%s ' "${COMPREPLY[@]}") <<<"${COMP_WORDS[@]}"
|
||||
) )
|
||||
|
||||
|
||||
# else
|
||||
# _filedir bat
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ _sshcomplete() {
|
|||
|
||||
# parse all defined hosts from .ssh/config and files included there
|
||||
for fl in "$HOME/.ssh/config" \
|
||||
$(grep "^\s*Include" "$HOME/.ssh/config" |
|
||||
awk '{for (i=2; i<=NF; i++) print $i}' |
|
||||
$(grep "^\s*Include" "$HOME/.ssh/config" |
|
||||
awk '{for (i=2; i<=NF; i++) print $i}' |
|
||||
sed -Ee "s|^([^/~])|$HOME/.ssh/\1|" -e "s|^~/|$HOME/|")
|
||||
do
|
||||
if [ -r "$fl" ]; then
|
||||
|
|
|
|||
|
|
@ -28,4 +28,3 @@ __kitchen_options () {
|
|||
esac
|
||||
}
|
||||
complete -F __kitchen_options kitchen
|
||||
|
||||
|
|
|
|||
|
|
@ -185,4 +185,3 @@ _tmux() {
|
|||
complete -F _tmux tmux
|
||||
|
||||
# END tmux completion
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ _contain_cmd()
|
|||
{
|
||||
local e f
|
||||
local array1=($1) array2=($2)
|
||||
|
||||
|
||||
for e in "${array1[@]}"
|
||||
do
|
||||
for f in "${array2[@]}"
|
||||
|
|
@ -80,7 +80,7 @@ _virsh_list_nwfilters()
|
|||
virsh -q nwfilter-list | cut -d\ -f4 | awk '{print $1}'
|
||||
}
|
||||
|
||||
_virsh()
|
||||
_virsh()
|
||||
{
|
||||
local cur prev cmds doms options nets pools cmds_help
|
||||
local flag_all=1 array ret a b ifaces nwfilters files
|
||||
|
|
|
|||
|
|
@ -10,30 +10,30 @@ __vboxmanage_startvm() {
|
|||
|
||||
AVAILABLE=""
|
||||
for VM in $TOTAL; do
|
||||
MATCH=0;
|
||||
for RUN in $RUNNING "x"; do
|
||||
if [ "$VM" == "$RUN" ]; then
|
||||
MATCH=1
|
||||
fi
|
||||
done
|
||||
(( $MATCH == 0 )) && AVAILABLE="$AVAILABLE $VM "
|
||||
MATCH=0;
|
||||
for RUN in $RUNNING "x"; do
|
||||
if [ "$VM" == "$RUN" ]; then
|
||||
MATCH=1
|
||||
fi
|
||||
done
|
||||
(( $MATCH == 0 )) && AVAILABLE="$AVAILABLE $VM "
|
||||
done
|
||||
echo $AVAILABLE
|
||||
}
|
||||
|
||||
__vboxmanage_list() {
|
||||
INPUT=$(vboxmanage list | tr -s '[\[\]\|\n]' ' ' | cut -d' ' -f4-)
|
||||
|
||||
|
||||
PRUNED=""
|
||||
if [ "$1" == "long" ]; then
|
||||
for WORD in $INPUT; do
|
||||
[ "$WORD" == "-l" ] && continue;
|
||||
[ "$WORD" == "--long" ] && continue;
|
||||
|
||||
PRUNED="$PRUNED $WORD"
|
||||
done
|
||||
else
|
||||
PRUNED=$INPUT
|
||||
for WORD in $INPUT; do
|
||||
[ "$WORD" == "-l" ] && continue;
|
||||
[ "$WORD" == "--long" ] && continue;
|
||||
|
||||
PRUNED="$PRUNED $WORD"
|
||||
done
|
||||
else
|
||||
PRUNED=$INPUT
|
||||
fi
|
||||
|
||||
echo $PRUNED
|
||||
|
|
@ -43,14 +43,14 @@ __vboxmanage_list() {
|
|||
__vboxmanage_list_vms() {
|
||||
VMS=""
|
||||
if [ "x$1" == "x" ]; then
|
||||
SEPARATOR=" "
|
||||
SEPARATOR=" "
|
||||
else
|
||||
SEPARATOR=$1
|
||||
SEPARATOR=$1
|
||||
fi
|
||||
|
||||
|
||||
for VM in $(vboxmanage list vms | cut -d' ' -f1 | tr -d '"'); do
|
||||
[ "$VMS" != "" ] && VMS="${VMS}${SEPARATOR}"
|
||||
VMS="${VMS}${VM}"
|
||||
[ "$VMS" != "" ] && VMS="${VMS}${SEPARATOR}"
|
||||
VMS="${VMS}${VM}"
|
||||
done
|
||||
|
||||
echo $VMS
|
||||
|
|
@ -59,14 +59,14 @@ __vboxmanage_list_vms() {
|
|||
__vboxmanage_list_runningvms() {
|
||||
VMS=""
|
||||
if [ "$1" == "" ]; then
|
||||
SEPARATOR=" "
|
||||
SEPARATOR=" "
|
||||
else
|
||||
SEPARATOR=$1
|
||||
SEPARATOR=$1
|
||||
fi
|
||||
|
||||
|
||||
for VM in $(vboxmanage list runningvms | cut -d' ' -f1 | tr -d '"'); do
|
||||
[ "$VMS" != "" ] && VMS="${VMS}${SEPARATOR}"
|
||||
VMS="${VMS}${VM}"
|
||||
[ "$VMS" != "" ] && VMS="${VMS}${SEPARATOR}"
|
||||
VMS="${VMS}${VM}"
|
||||
done
|
||||
|
||||
echo $VMS
|
||||
|
|
@ -81,7 +81,7 @@ __vboxmanage_controlvm() {
|
|||
echo "screenshotpng setcredentials teleport plugcpu unplugcpu"
|
||||
echo "cpuexecutioncap"
|
||||
|
||||
# setlinkstate<1-N>
|
||||
# setlinkstate<1-N>
|
||||
# nic<1-N> null|nat|bridged|intnet|hostonly|generic
|
||||
# [<devicename>] |
|
||||
# nictrace<1-N> on|off
|
||||
|
|
@ -102,43 +102,43 @@ __vboxmanage_default() {
|
|||
# echo "DEBUG: cur: $cur, prev: $prev"
|
||||
# echo "DEBUG: default: |$p1|$p2|$p3|$p4|"
|
||||
case ${cur} in
|
||||
-*)
|
||||
echo $opts
|
||||
# COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-*)
|
||||
echo $opts
|
||||
# COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
esac;
|
||||
|
||||
for WORD in $opts; do
|
||||
MATCH=0
|
||||
for OPT in "${COMP_WORDS[@]}"; do
|
||||
# opts=$(echo ${opts} | grep -v $OPT);
|
||||
if [ "$OPT" == "$WORD" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "-v" ] && [ "$WORD" == "--version" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "--version" ] && [ "$WORD" == "-v" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "-q" ] && [ "$WORD" == "--nologo" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "--nologo" ] && [ "$WORD" == "-q" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
done
|
||||
(( $MATCH == 1 )) && continue;
|
||||
pruned="$pruned $WORD"
|
||||
|
||||
MATCH=0
|
||||
for OPT in "${COMP_WORDS[@]}"; do
|
||||
# opts=$(echo ${opts} | grep -v $OPT);
|
||||
if [ "$OPT" == "$WORD" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "-v" ] && [ "$WORD" == "--version" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "--version" ] && [ "$WORD" == "-v" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "-q" ] && [ "$WORD" == "--nologo" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
if [ "$OPT" == "--nologo" ] && [ "$WORD" == "-q" ]; then
|
||||
MATCH=1
|
||||
break;
|
||||
fi
|
||||
done
|
||||
|
||||
(( $MATCH == 1 )) && continue;
|
||||
pruned="$pruned $WORD"
|
||||
|
||||
done
|
||||
|
||||
# COMPREPLY=($(compgen -W "${pruned}" -- ${cur}))
|
||||
echo $pruned
|
||||
return 0
|
||||
|
|
@ -156,65 +156,65 @@ _vboxmanage() {
|
|||
|
||||
# In case current is complete command
|
||||
case $cur in
|
||||
startvm|list|controlvm)
|
||||
COMPREPLY=($(compgen -W "$cur "))
|
||||
return 0
|
||||
;;
|
||||
startvm|list|controlvm)
|
||||
COMPREPLY=($(compgen -W "$cur "))
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
|
||||
case $prev in
|
||||
-v|--version)
|
||||
return 0
|
||||
;;
|
||||
case $prev in
|
||||
-v|--version)
|
||||
return 0
|
||||
;;
|
||||
|
||||
-l|--long)
|
||||
opts=$(__vboxmanage_list "long")
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
startvm|list)
|
||||
opts=$(__vboxmanage_$prev)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
--type)
|
||||
COMPREPLY=($(compgen -W "gui headless" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
gui|headless)
|
||||
# Done. no more completion possible
|
||||
return 0
|
||||
;;
|
||||
vboxmanage|-q|--nologo)
|
||||
# echo "Got vboxmanage"
|
||||
opts=$(__vboxmanage_default)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
controlvm)
|
||||
opts=$(__vboxmanage_list_vms)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
-l|--long)
|
||||
opts=$(__vboxmanage_list "long")
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
startvm|list)
|
||||
opts=$(__vboxmanage_$prev)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
--type)
|
||||
COMPREPLY=($(compgen -W "gui headless" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
gui|headless)
|
||||
# Done. no more completion possible
|
||||
return 0
|
||||
;;
|
||||
vboxmanage|-q|--nologo)
|
||||
# echo "Got vboxmanage"
|
||||
opts=$(__vboxmanage_default)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
controlvm)
|
||||
opts=$(__vboxmanage_list_vms)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
|
||||
for VM in $(__vboxmanage_list_vms); do
|
||||
if [ "$VM" == "$prev" ]; then
|
||||
pprev=${COMP_WORDS[COMP_CWORD-2]}
|
||||
# echo "previous: $pprev"
|
||||
case $pprev in
|
||||
startvm)
|
||||
opts="--type"
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
controlvm)
|
||||
opts=$(__vboxmanage_controlvm)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0;
|
||||
;;
|
||||
esac
|
||||
fi
|
||||
if [ "$VM" == "$prev" ]; then
|
||||
pprev=${COMP_WORDS[COMP_CWORD-2]}
|
||||
# echo "previous: $pprev"
|
||||
case $pprev in
|
||||
startvm)
|
||||
opts="--type"
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0
|
||||
;;
|
||||
controlvm)
|
||||
opts=$(__vboxmanage_controlvm)
|
||||
COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
|
||||
return 0;
|
||||
;;
|
||||
esac
|
||||
fi
|
||||
done
|
||||
|
||||
# echo "Got to end withoug completion"
|
||||
|
|
|
|||
|
|
@ -10,6 +10,6 @@ if command -v vue > /dev/null; then
|
|||
fi
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
complete -F __vuejs_completion vue
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ if command -v wpscan > /dev/null; then
|
|||
fi
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
complete -F __wpscan_completion wpscan
|
||||
fi
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
# Bash-it
|
||||
|
||||
|
||||
[](https://webchat.freenode.net/?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](https://bash-it.readthedocs.io/en/latest/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)
|
||||
|
||||
## 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][contribute]
|
||||
|
||||
[contribute]: https://github.com/Bash-it/bash-it/contributors
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
.. _doctor:
|
||||
|
||||
Bash-it doctor
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
If you encounter problems with any part of Bash-it, run the following command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it doctor
|
||||
|
||||
This will reload your bash profile and print out logs of various parts in Bash-it.
|
||||
Note that this command at default will print all logs, including debug logs.
|
||||
You can call it like this:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it doctor [errors/warnings/all]
|
||||
|
||||
In order to get wanted verbosity.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
.. _commands:
|
||||
|
||||
Bash-it Commands
|
||||
================
|
||||
|
||||
**Bash-it** boasts a wide range of available commands.
|
||||
You should be familiar with them in order to fully utilize Bash-it.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
update
|
||||
search
|
||||
reload
|
||||
doctor
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
.. _reload:
|
||||
|
||||
Bash-it reload
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Bash-it creates a ``reload`` alias that makes it convenient to reload
|
||||
your Bash profile when you make changes.
|
||||
|
||||
Additionally, if you export ``BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE`` as a non-null value,
|
||||
Bash-it will automatically reload itself after activating or deactivating plugins, aliases, or completions.
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
.. _searching:
|
||||
|
||||
Bash-it search
|
||||
--------------
|
||||
|
||||
If you need to quickly find out which of the plugins, aliases or completions are available for a specific framework, programming language, or an environment, you can *search* for multiple terms related to the commands you use frequently.
|
||||
Search will find and print out modules with the name or description matching the terms provided.
|
||||
|
||||
Syntax
|
||||
^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it search term1 [[-]term2] [[-]term3]....
|
||||
|
||||
As an example, a ruby developer might want to enable everything related to the commands such as ``ruby``\ , ``rake``\ , ``gem``\ , ``bundler``\ , and ``rails``.
|
||||
Search command helps you find related modules so that you can decide which of them you'd like to use:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
❯ bash-it search ruby rake gem bundle irb rails
|
||||
aliases: bundler rails
|
||||
plugins: chruby chruby-auto ruby
|
||||
completions: bundler gem rake
|
||||
|
||||
Currently enabled modules will be shown in green.
|
||||
|
||||
Searching with Negations
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can prefix a search term with a "-" to exclude it from the results.
|
||||
In the above example, if we wanted to hide ``chruby`` and ``chruby-auto``\ ,
|
||||
we could change the command as follows:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
❯ bash-it search ruby rake gem bundle irb rails -chruby
|
||||
aliases: bundler rails
|
||||
plugins: ruby
|
||||
completions: bundler gem rake
|
||||
|
||||
Using Search to Enable or Disable Components
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
By adding a ``--enable`` or ``--disable`` to the search command, you can automatically enable all modules that come up as a result of a search query.
|
||||
This could be quite handy if you like to enable a bunch of components related to the same topic.
|
||||
|
||||
Disabling ASCII Color
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To remove non-printing non-ASCII characters responsible for the coloring of the search output, you can set environment variable ``NO_COLOR``.
|
||||
Enabled components will then be shown with a checkmark:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
❯ NO_COLOR=1 bash-it search ruby rake gem bundle irb rails -chruby
|
||||
aliases => ✓bundler ✓rails
|
||||
plugins => ✓ruby
|
||||
completions => bundler gem rake
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
.. _update:
|
||||
|
||||
Bash-it update
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
To update Bash-it to the latest stable version, simply run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it update stable
|
||||
|
||||
If you want to update to the latest dev version (directly from master), run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it update dev
|
||||
|
||||
If you want to update automatically and unattended, you can add the optional
|
||||
``-s/--silent`` flag, for example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it update dev --silent
|
||||
|
||||
.. _migrate:
|
||||
|
||||
Bash-it migrate
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
If you are using an older version of Bash-it, it's possible that some functionality has changed, or that the internal structure of how Bash-it organizes its functionality has been updated.
|
||||
For these cases, we provide a ``migrate`` command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it migrate
|
||||
|
||||
This command will automatically migrate the Bash-it structure to the latest version.
|
||||
The ``migrate`` command is run automatically if you run the ``update``\ , ``enable`` or ``disable`` commands.
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Bash-it'
|
||||
copyright = '2020, Bash-it Team'
|
||||
author = 'Bash-it Team'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = ''
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx_rtd_theme'
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
.. _contributing:
|
||||
|
||||
Contribution Guidelines
|
||||
=======================
|
||||
|
||||
When contributing a new feature, a bug fix, a new theme, or any other change to Bash-it, please consider the following guidelines.
|
||||
Most of this is common sense, but please try to stick to the conventions listed here.
|
||||
|
||||
Issues
|
||||
------
|
||||
|
||||
|
||||
* When opening a new issue in the issue tracker, please include information about which *Operating System* you're using, and which version of *Bash*.
|
||||
* In many cases, it also makes sense to show which Bash-it plugins you are using.
|
||||
This information can be obtained using ``bash-it show plugins``.
|
||||
* If the issue happens while loading Bash-it, please also include your ``~/.bash_profile`` or ``~/.bashrc`` file,
|
||||
as well as the install location of Bash-it (default should be ``~/.bash_it``\ ).
|
||||
* When reporting a bug or requesting a new feature, consider providing a Pull Request that fixes the issue or can be used as a starting point for the new feature.
|
||||
Don't be afraid, most things aren't that complex...
|
||||
|
||||
Pull Requests
|
||||
-------------
|
||||
|
||||
|
||||
* Fork the Bash-it repo, create a new feature branch from *master* and apply your changes there.
|
||||
Create a *Pull Request* from your feature branch against Bash-it's *master* branch.
|
||||
* Limit each Pull Request to one feature.
|
||||
Don't bundle multiple features/changes (e.g. a new *Theme* and a fix to an existing plugin) into a single Pull Request - create one PR for the theme, and a separate PR for the fix.
|
||||
* For complex changes, try to *squash* your changes into a single commit before
|
||||
pushing code. Once you've pushed your code and opened a PR, please refrain
|
||||
from force-pushing changes to the PR branch – remember, Bash-it is a
|
||||
distributed project and your branch may be in use already.
|
||||
* When in doubt, open a PR with too many commits. Bash-it is a learning project
|
||||
for everyone involved. Showing your work provides a great history for folks
|
||||
to learn what works and what didn't.
|
||||
|
||||
Code Style
|
||||
----------
|
||||
|
||||
|
||||
* When adding new files, be sure to add them into `clean_files.txt`, which is a growing list of linted files in the project.
|
||||
* When changing existing files, consider also adding them into `clean_files.txt` and fixing the linting errors that arise.
|
||||
* Indentation is using tabs, not spaces. Most of the code is indented with 2 spaces, some with 4 spaced tabs. Please try to stick to tabs.
|
||||
If you're using an editor that supports `EditorConfig <http://EditorConfig.org>`_\ , the editor should automatically use the settings defined in Bash-it's `.editorconfig file <.editorconfig>`_.
|
||||
* When creating new functions, please use a dash ("-") to separate the words of the function's name, e.g. ``my-new-function``.
|
||||
Don't use underscores, e.g. ``my_new_function``.
|
||||
* Internal functions that aren't to be used by the end user should start with an underscore, e.g. ``_my-new-internal-function``.
|
||||
* Use the provided meta functions to document your code, e.g. ``about-plugin``\ , ``about``\ , ``group``\ , ``param``\ , ``example``.
|
||||
This will make it easier for other people to use your new functionality.
|
||||
Take a look at the existing code for an example (e.g. `the base plugin <plugins/available/base.plugin.bash>`_\ ).
|
||||
* When adding files, please use the existing file naming conventions, e.g. plugin files need to end in ``.plugin.bash``.
|
||||
This is important for the installation functionality.
|
||||
* When using the ``$BASH_IT`` variable, please always enclose it in double quotes to ensure that the code also works when Bash-it is installed in a directory that contains spaces in its name: ``for f in "${BASH_IT}/plugins/available"/*.bash ; do echo "$f" ; done``
|
||||
* Bash-it supports Bash 3.2 and higher. Please don't use features only available in Bash 4, such as associative arrays.
|
||||
|
||||
Unit Tests
|
||||
----------
|
||||
|
||||
When adding features or making changes/fixes, please run our growing unit test suite to ensure that you did not break existing functionality.
|
||||
The test suite does not cover all aspects of Bash-it, but please run it anyway to verify that you did not introduce any regression issues.
|
||||
|
||||
Any code pushed to GitHub as part of a Pull Request will automatically trigger a continuous integration build on `Travis CI <https://travis-ci.org/Bash-it/bash-it>`_\ , where the test suite is run on both Linux and macOS.
|
||||
The Pull Request will then show the result of the Travis build, indicating whether all tests ran fine, or whether there were issues.
|
||||
Please pay attention to this, Pull Requests with build issues will not be merged.
|
||||
|
||||
Adding new functionality or changing existing functionality is a good opportunity to increase Bash-it's test coverage.
|
||||
When you're changing the Bash-it codebase, please consider adding some unit tests that cover the new or changed functionality.
|
||||
Ideally, when fixing a bug, a matching unit test that verifies that the bug is no longer present, is added at the same time.
|
||||
|
||||
To run the test suite, simply execute the following in the directory where you cloned Bash-it:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
test/run
|
||||
|
||||
This command will ensure that the `Bats Test Framework <https://github.com/bats-core/bats-core>`_ is available in the local ``test_lib`` directory (Bats is included as a Git submodule) and then run the test suite found in the `test <test>`_ folder.
|
||||
The test script will execute each test in turn, and will print a status for each test case.
|
||||
|
||||
When adding new test cases, please take a look at the existing test cases for examples.
|
||||
|
||||
The following libraries are used to help with the tests:
|
||||
|
||||
|
||||
* Test Framework: https://github.com/bats-core/bats-core
|
||||
* Support library for Bats-Assert: https://github.com/ztombol/bats-support
|
||||
* General ``assert`` functions: https://github.com/ztombol/bats-assert
|
||||
* File ``assert`` functions: https://github.com/ztombol/bats-file
|
||||
|
||||
When verifying test results, please try to use the ``assert`` functions found in these libraries.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
|
||||
* When adding new completions or plugins, please don't simply copy existing tools into the Bash-it codebase, try to load/integrate the tools instead.
|
||||
An example is using ``nvm``\ : Instead of copying the existing ``nvm`` script into Bash-it, the ``nvm.plugin.bash`` file tries to load an existing installation of ``nvm``.
|
||||
This means an additional step for the user (installing ``nvm`` from its own repo, or through a package manager),
|
||||
but it will also ensure that ``nvm`` can be upgraded in an easy way.
|
||||
|
||||
.. _contributing_theme:
|
||||
|
||||
Themes
|
||||
------
|
||||
|
||||
|
||||
* When adding a new theme, please include a screenshot and a short description about what makes this theme unique in the Pull Request's description field.
|
||||
Please do not add theme screenshots to the repo itself, as they will add unnecessary bloat to the repo.
|
||||
The project's docs has a `Themes page <https://github.com/Bash-it/bash-it/blob/master/docs/themes-list/index.rst>`_ where you should add a screenshot, see how :ref:`here<add_screenshot>`.
|
||||
* Ideally, you should add a ``<theme_name>.rst`` file describing the theme and its configuration options to ``docs/themes-list`` folder.
|
||||
|
||||
.. _add_screenshot:
|
||||
|
||||
Adding a Screenshot
|
||||
-------------------
|
||||
|
||||
In order to add a new screenshot, use the ``gh-pages`` branch.
|
||||
Add your new screenshot to the ``docs/images`` folder, and open a PR.
|
||||
In the `Themes page <https://github.com/Bash-it/bash-it/blob/master/docs/themes-list/index.rst>`_, see the other screenshots to know what kind of link you should use.
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
.. _custom:
|
||||
|
||||
Custom Content
|
||||
--------------
|
||||
|
||||
For custom scripts, and aliases, just create the following files (they'll be ignored by the git repo):
|
||||
|
||||
|
||||
* ``aliases/custom.aliases.bash``
|
||||
* ``completion/custom.completion.bash``
|
||||
* ``lib/custom.bash``
|
||||
* ``plugins/custom.plugins.bash``
|
||||
* ``custom/themes/<custom theme name>/<custom theme name>.theme.bash``
|
||||
|
||||
Anything in the custom directory will be ignored, with the exception of ``custom/example.bash``.
|
||||
|
||||
Alternately, if you would like to keep your custom scripts under version control, you can set ``BASH_IT_CUSTOM`` in your ``~/.bashrc`` to another location outside of the ``$BASH_IT`` folder.
|
||||
In this case, any ``*.bash`` file under every directory below ``BASH_IT_CUSTOM`` folder will be used.
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
.. _development:
|
||||
|
||||
Bash-it Development
|
||||
===================
|
||||
|
||||
This page summarizes a couple of rules to keep in mind when developing features or making changes in Bash-it.
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
Make sure to read the :ref:`testing docs<test>`.
|
||||
|
||||
Debugging and Logging
|
||||
---------------------
|
||||
|
||||
General Logging
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
While developing feature or making changes in general, you can log error/warning/debug
|
||||
using ``_log_error`` ``_log_warning`` and ``_log_debug``. This will help you solve problems quicker
|
||||
and also propagate important notes to other users of Bash-it.
|
||||
You can see the logs by using ``bash-it doctor`` command to reload and see the logs.
|
||||
Alternatively, you can set ``BASH_IT_LOG_LEVEL`` to ``BASH_IT_LOG_LEVEL_ERROR``\ , ``BASH_IT_LOG_LEVEL_WARNING`` or ``BASH_IT_LOG_LEVEL_ALL``.
|
||||
|
||||
Log Prefix/Context
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can define ``BASH_IT_LOG_PREFIX`` in your files in order to a have a constant prefix before your logs.
|
||||
Note that we prefer to uses "tags" based logging, i.e ``plugins: git: DEBUG: Loading git plugin``.
|
||||
|
||||
Load Order
|
||||
----------
|
||||
|
||||
General Load Order
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The main ``bash_it.sh`` script loads the frameworks individual components in the following order:
|
||||
|
||||
|
||||
* ``lib/composure.bash``
|
||||
* Files in ``lib`` with the exception of ``appearance.bash`` - this means that ``composure.bash`` is loaded again here (possible improvement?)
|
||||
* Enabled ``aliases``
|
||||
* Enabled ``plugins``
|
||||
* Enabled ``completions``
|
||||
* ``themes/colors.theme.bash``
|
||||
* ``themes/base.theme.bash``
|
||||
* ``lib/appearance.bash``\ , which loads the selected theme
|
||||
* Custom ``aliases``
|
||||
* Custom ``plugins``
|
||||
* Custom ``completions``
|
||||
* Additional custom files from either ``$BASH_IT/custom`` or ``$BASH_IT_CUSTOM``
|
||||
|
||||
This order is subject to change.
|
||||
|
||||
Individual Component Load Order
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For ``aliases``\ , ``plugins`` and ``completions``\ , the following rules are applied that influence the load order:
|
||||
|
||||
|
||||
* There is a global ``enabled`` directory, which the enabled components are linked into. Enabled plugins are symlinked from ``$BASH_IT/plugins/available`` to ``$BASH_IT/enabled`` for example. All component types are linked into the same common ``$BASH_IT/enabled`` directory.
|
||||
* Within the common ``enabled`` directories, the files are loaded in alphabetical order, which is based on the item's load priority (see next item).
|
||||
* When enabling a component, a *load priority* is assigned to the file. The following default priorities are used:
|
||||
|
||||
* Aliases: 150
|
||||
* Plugins: 250
|
||||
* Completions: 350
|
||||
|
||||
* When symlinking a component into the ``enabled`` directory, the load priority is used as a prefix for the linked name, separated with three dashes from the name of the component. The ``node.plugin.bash`` would be symlinked to ``250---node.plugin.bash`` for example.
|
||||
*
|
||||
Each file can override the default load priority by specifying a new value. To do this, the file needs to include a comment in the following form. This example would cause the ``node.plugin.bash`` (if included in that file) to be linked to ``225---node.plugin.bash``\ :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# BASH_IT_LOAD_PRIORITY: 225
|
||||
|
||||
Having the order based on a numeric priority in a common directory allows for more flexibility. While in general, aliases are loaded first (since their default priority is 150), it's possible to load some aliases after the plugins, or some plugins after completions by setting the items' load priority. This is more flexible than a fixed type-based order or a strict alphabetical order based on name.
|
||||
|
||||
These items are subject to change. When making changes to the internal functionality, this page needs to be updated as well.
|
||||
|
||||
Plugin Disable Callbacks
|
||||
------------------------
|
||||
|
||||
Plugins can define a function that will be called when the plugin is being disabled.
|
||||
The callback name should be ``{PLUGIN_NAME}_on_disable``\ , you can see ``gitstatus`` for usage example.
|
||||
|
||||
Using the pre-commit hook
|
||||
-------------------------
|
||||
|
||||
Note the file .pre-commit-config.yaml at the top of the repo.
|
||||
This file configures the behavior of the a pre-commit hook based on `the Pre-Commit framework <https://pre-commit.com/>`_. Please see the site about
|
||||
installing it (with pip, brew or other tools) then run ``pre-commit install`` in the repo's root to activate the hook.
|
||||
For the full use of the tool, you may need to install also other third-party tools, such as
|
||||
`shellcheck <https://github.com/koalaman/shellcheck/>`_ and `shfmt <https://github.com/mvdan/sh>`_.
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
|
||||
Welcome to Bash-it's documentation!
|
||||
===================================
|
||||
|
||||
**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>`_)
|
||||
|
||||
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.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
contributing
|
||||
development
|
||||
test
|
||||
installation
|
||||
commands/index
|
||||
custom
|
||||
themes
|
||||
themes-list/index
|
||||
vcs_user
|
||||
misc
|
||||
troubleshooting
|
||||
uninstalling
|
||||
|
||||
|
||||
Help out
|
||||
--------
|
||||
|
||||
We 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 us a pull request and we'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 we merge your changes in.
|
||||
|
||||
Please take a look at the :ref:`Contribution Guidelines <contributing>` before reporting a bug or providing a new feature.
|
||||
|
||||
Thanks, and happing bashing!
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
.. _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,0 +1,35 @@
|
|||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
.. _misc:
|
||||
|
||||
Misc
|
||||
----
|
||||
|
||||
Help Screens
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
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
|
||||
|
||||
Pass function renamed to passgen
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The Bash-it ``pass`` function has been renamed to ``passgen`` in order to avoid a naming conflict with the `pass password manager <https://www.passwordstore.org/>`_.
|
||||
In order to minimize the impact on users of the legacy Bash-it ``pass`` function, Bash-it will create the alias ``pass`` that calls the new ``passgen`` function if the ``pass`` password manager command is not found on the ``PATH`` (default behavior).
|
||||
|
||||
This behavior can be overridden with the ``BASH_IT_LEGACY_PASS`` flag as follows:
|
||||
|
||||
Set ``BASH_IT_LEGACY_PASS`` to 'true' to force Bash-it to always **create** the ``pass`` alias to ``passgen``\ :
|
||||
|
||||
|
||||
* ``export BASH_IT_LEGACY_PASS=true``
|
||||
|
||||
Unset ``BASH_IT_LEGACY_PASS`` to have Bash-it **return to default behavior**\ :
|
||||
|
||||
|
||||
* ``unset BASH_IT_LEGACY_PASS``
|
||||
|
||||
Proxy Support
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
If you are working in a corporate environment where you have to go through a proxy server for internet access,
|
||||
then you know how painful it is to configure the OS proxy variables in the shell,
|
||||
especially if you are switching between environments, e.g. office (with proxy) and home (without proxy).
|
||||
|
||||
The Bash shell (and many shell tools) use the following variables to define the proxy to use:
|
||||
|
||||
|
||||
* ``HTTP_PROXY`` (and ``http_proxy``\ ): Defines the proxy server for HTTP requests
|
||||
* ``HTTPS_PROXY`` (and ``https_proxy``\ ): Defines the proxy server for HTTPS requests
|
||||
* ``ALL_PROXY`` (and ``all_proxy``\ ): Used by some tools for the same purpose as above
|
||||
* ``NO_PROXY`` (and ``no_proxy``\ ): Comma-separated list of hostnames that don't have to go through the proxy
|
||||
|
||||
Bash-it's ``proxy`` plugin allows to enable and disable these variables with a simple command.
|
||||
To start using the ``proxy`` plugin, run the following:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bash-it enable plugin proxy
|
||||
|
||||
Bash-it also provides support for enabling/disabling proxy settings for various shell tools.
|
||||
The following backends are currently supported (in addition to the shell's environment variables): Git, SVN, npm, ssh.
|
||||
The ``proxy`` plugin changes the configuration files of these tools to enable or disable the proxy settings.
|
||||
|
||||
Bash-it uses the following variables to set the shell's proxy settings when you call ``enable-proxy``.
|
||||
These variables are best defined in a custom script in Bash-it's custom script folder (\ ``$BASH_IT/custom``\ ), e.g. ``$BASH_IT/custom/proxy.env.bash``
|
||||
|
||||
|
||||
* ``BASH_IT_HTTP_PROXY`` and `BASH_IT_HTTPS_PROXY`: Define the proxy URL to be used, e.g. 'http://localhost:1234'
|
||||
* ``BASH_IT_NO_PROXY``\ : A comma-separated list of proxy exclusions, e.g. ``127.0.0.1,localhost``
|
||||
|
||||
Once you have defined these variables (and have run ``reload`` to load the changes), you can use the following commands to enable or disable the proxy settings in your current shell:
|
||||
|
||||
|
||||
* ``enable-proxy``\ : This sets the shell's proxy environment variables and configures proxy support in your SVN, npm, and SSH configuration files.
|
||||
* ``disable-proxy``\ : This unsets the shell's proxy environment variables and disables proxy support in your SVN, npm, and SSH configuration files.
|
||||
|
||||
There are many more proxy commands, e.g. for changing the local Git project's proxy settings.
|
||||
Run ``glossary proxy`` to show the available proxy functions with a short description.
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
sphinx == 3.2.1
|
||||
sphinx-rtd-theme==0.5.0
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
.. _test:
|
||||
|
||||
Testing Bash-it
|
||||
===============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
The Bash-it unit tests leverage the `Bats unit test framework for Bash <https://github.com/bats-core/bats-core>`_.
|
||||
There is no need to install Bats explicitly, the test run script will automatically download and install Bats and its dependencies.
|
||||
|
||||
When making changes to Bash-it, the tests are automatically executed in a test build environment on `Travis CI <https://travis-ci.com>`_.
|
||||
|
||||
Test Execution
|
||||
--------------
|
||||
|
||||
To execute the unit tests, please run the ``run`` script:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# If you are in the `test` directory:
|
||||
./run
|
||||
|
||||
# If you are in the root `.bash_it` directory:
|
||||
test/run
|
||||
|
||||
The ``run`` script will automatically install if it is not already present, and will then run all tests found under the ``test`` directory, including subdirectories.
|
||||
|
||||
To run only a subset of the tests, you can provide the name of the test subdirectory that you want to run, e.g. like this for the tests in the ``test/themes`` directory:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# If you are in the root `.bash_it` directory:
|
||||
test/run test/themes
|
||||
|
||||
By default, the tests run in single-threaded mode.
|
||||
If you want to speed up the test execution, you can install the `GNU ``parallel`` tool <https://www.gnu.org/software/parallel/>`_\ , which is supported by Bats.
|
||||
When using ``parallel``\ , the ``test/run`` script will use a number of threads in parallel, depending on the available CPU cores of your system.
|
||||
This can speed up test execution significantly.
|
||||
|
||||
Writing Tests
|
||||
-------------
|
||||
|
||||
When adding or modifying tests, please stick to the format and conventions of the existing test cases.
|
||||
The ``test_helper.bash`` script provides a couple of reusable helper functions that you should use when writing a test case,
|
||||
for example for setting up an isolated test environment.
|
||||
|
|
@ -0,0 +1,200 @@
|
|||
.. _atomic:
|
||||
|
||||
Atomic theme
|
||||
============
|
||||
|
||||
The Best ColorFull terminal prompt theme inspired by a number of themes and based on the theme of @MunifTanjim :ref:`brainy <brainy>`.
|
||||
|
||||
Supported on all operating systems.
|
||||
|
||||
In constant maintenance and improvement
|
||||
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/lfelipe1501/lfelipe-projects/master/AtomicTheme.gif
|
||||
:target: https://raw.githubusercontent.com/lfelipe1501/lfelipe-projects/master/AtomicTheme.gif
|
||||
:alt: Atomic-Theme
|
||||
|
||||
|
||||
Install Theme
|
||||
-------------
|
||||
|
||||
Manually
|
||||
^^^^^^^^
|
||||
|
||||
You can install the theme manually by following these steps:
|
||||
Edit your modified config ``~/.bashrc`` file in order to customize Bash-it, set ``BASH_IT_THEME`` to the theme name ``atomic``.
|
||||
|
||||
Examples:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Use the "atomic" theme
|
||||
export BASH_IT_THEME="atomic"
|
||||
|
||||
Automatically via terminal
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
#. You can install the theme automatically using the ``sed`` command from your Linux or OSX Terminal.
|
||||
#. On macOS, the ~/.bash_profile is used, not the ~/.bashrc.
|
||||
#. For installation on windows you should use `\ ``Git-Bash`` <https://git-for-windows.github.io/>`_ or make sure the terminal emulator you use (ej: cygwin, mintty, etc) has the ``sed`` command installed.
|
||||
|
||||
Command to execute For Windows and Linux:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Set the "atomic" theme replacing the theme you are using of bash-it
|
||||
sed -i 's/'"$BASH_IT_THEME"'/atomic/g' ~/.bashrc
|
||||
|
||||
Command to execute for macOS:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Set the "atomic" theme replacing the theme you are using of bash-it
|
||||
sed -i '' 's/'"$BASH_IT_THEME"'/atomic/g' ~/.bash_profile
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
Prompt Segments
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
* Username & Hostname
|
||||
* Current Directory
|
||||
* SCM Information
|
||||
* Battery Charge
|
||||
* Clock
|
||||
* `Todo.txt <https://github.com/ginatrapani/todo.txt-cli>`_ status
|
||||
* Ruby Environment
|
||||
* Python Environment
|
||||
* Exit Code
|
||||
|
||||
Others
|
||||
^^^^^^
|
||||
|
||||
|
||||
* Indicator for cached ``sudo`` credential
|
||||
* Indicator for abort (ctrl + C) the current task and regain user control
|
||||
* ``atomic`` command for showing/hiding various prompt segments on-the-fly
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
Various prompt segments can be shown/hidden or modified according to your choice. There are two ways for doing that:
|
||||
|
||||
|
||||
#. On-the-fly using ``atomic`` command
|
||||
#. Theme Environment Variables
|
||||
|
||||
On-the-fly using ``atomic`` command
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This theme provides a command for showing/hiding prompt segments.
|
||||
|
||||
``atomic show <segment>``
|
||||
|
||||
``atomic hide <segment>``
|
||||
|
||||
Tab-completion for this command is enabled by default.
|
||||
|
||||
Configuration specified by this command will only be applied to current and subsequent child shells.
|
||||
|
||||
Theme Environment Variables
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This is used for permanent settings that apply to all terminal sessions. You have to define the value of specific theme variables in your ``bashrc`` (or equivalent) file.
|
||||
|
||||
The name of the variables are listed below along with their default values.
|
||||
|
||||
User Information
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Indicator for cached ``sudo`` credential (see ``sudo`` manpage for more information):
|
||||
|
||||
``THEME_SHOW_SUDO=true``
|
||||
|
||||
SCM Information
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Information about SCM repository status:
|
||||
|
||||
``THEME_SHOW_SCM=true``
|
||||
|
||||
Ruby Environment
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Ruby environment version information:
|
||||
|
||||
``THEME_SHOW_RUBY=false``
|
||||
|
||||
Python Environment
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Python environment version information:
|
||||
|
||||
``THEME_SHOW_PYTHON=false``
|
||||
|
||||
ToDo.txt status
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
`Todo.txt <https://github.com/ginatrapani/todo.txt-cli>`_ status:
|
||||
|
||||
``THEME_SHOW_TODO=false``
|
||||
|
||||
Clock
|
||||
~~~~~
|
||||
|
||||
``THEME_SHOW_CLOCK=true``
|
||||
|
||||
``THEME_CLOCK_COLOR=$bold_cyan``
|
||||
|
||||
Format of the clock (see ``date`` manpage for more information):
|
||||
|
||||
``THEME_CLOCK_FORMAT="%H:%M:%S"``
|
||||
|
||||
Battery Charge
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
Battery charge percentage:
|
||||
|
||||
``THEME_SHOW_BATTERY=false``
|
||||
|
||||
Exit Code
|
||||
~~~~~~~~~
|
||||
|
||||
Exit code of the last command:
|
||||
|
||||
``THEME_SHOW_EXITCODE=true``
|
||||
|
||||
Prompt Segments Order
|
||||
---------------------
|
||||
|
||||
Currently available prompt segments are:
|
||||
|
||||
|
||||
* battery
|
||||
* char
|
||||
* clock
|
||||
* dir
|
||||
* exitcode
|
||||
* python
|
||||
* ruby
|
||||
* scm
|
||||
* todo
|
||||
* user_info
|
||||
|
||||
Three environment variables can be defined to rearrange the segments order. The default values are:
|
||||
|
||||
``___ATOMIC_TOP_LEFT="user_info dir scm"``
|
||||
|
||||
``___ATOMIC_TOP_RIGHT="exitcode python ruby todo clock battery"``
|
||||
|
||||
``___ATOMIC_BOTTOM="char"``
|
||||
|
||||
Development by
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Developer / Author: `Luis Felipe Sánchez <https://github.com/lfelipe1501>`_
|
||||
|
||||
This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
|
||||
|
|
@ -0,0 +1,124 @@
|
|||
.. _barbuk:
|
||||
|
||||
BarbUk theme
|
||||
============
|
||||
|
||||
A minimal theme with a clean git prompt
|
||||
|
||||
Provided Information
|
||||
--------------------
|
||||
|
||||
|
||||
* Current git remote tool logo (support: github, gitlab, bitbucket)
|
||||
* Current path (red when user is root)
|
||||
* Current git info
|
||||
* Last command exit code (only shown when the exit code is greater than 0)
|
||||
* user@hostname for ssh connection
|
||||
|
||||
Fonts and glyphs
|
||||
----------------
|
||||
|
||||
A font with SCM glyphs is required to display the default tool/host logos.
|
||||
You can use a font from https://www.nerdfonts.com/ or patch your own font with the tool
|
||||
provided by https://github.com/ryanoasis/nerd-fonts.
|
||||
|
||||
You can also override the default variables if you want to use different glyphs or standard ASCII characters.
|
||||
|
||||
Default theme glyphs
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
BARBUK_GITLAB_CHAR=' '
|
||||
BARBUK_BITBUCKET_CHAR=' '
|
||||
BARBUK_GITHUB_CHAR=' '
|
||||
BARBUK_GIT_DEFAULT_CHAR=' '
|
||||
BARBUK_GIT_BRANCH_ICON=''
|
||||
BARBUK_HG_CHAR='☿ '
|
||||
BARBUK_SVN_CHAR='⑆ '
|
||||
BARBUK_EXIT_CODE_ICON=' '
|
||||
BARBUK_PYTHON_VENV_CHAR=' '
|
||||
|
||||
Customize glyphs
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
Define your custom glyphs before sourcing bash-it:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
export BARBUK_GITHUB_CHAR='•'
|
||||
source "$BASH_IT"/bash_it.sh
|
||||
|
||||
SSH prompt
|
||||
----------
|
||||
|
||||
Usage
|
||||
^^^^^
|
||||
|
||||
When using a ssh session, the theme will display ``user@hostname``.
|
||||
You can disable this information with ``BARBUK_SSH_INFO``.
|
||||
|
||||
The hostname is displayed in the FQDN format by default. You
|
||||
can use the short hostname format with ``BARBUK_HOST_INFO``.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# short or long
|
||||
export BARBUK_HOST_INFO=short
|
||||
# true or false
|
||||
export BARBUK_SSH_INFO=false
|
||||
source "$BASH_IT"/bash_it.sh
|
||||
|
||||
Keep theme with sudoer
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you want the theme to persist using ``sudo -s`` in a ssh session, you need to configure sudo to keep the ``HOME`` and ``SSH_CONNECTION`` environment variables.
|
||||
|
||||
``HOME`` contains the path to the home directory of the current user. Keeping it will allow to use your user dotfiles when elevating privileges.
|
||||
|
||||
Keeping ``SSH_CONNECTION`` env is necessary for ssh detection in the theme.
|
||||
|
||||
Please refer to the following documentation for more information:
|
||||
|
||||
|
||||
* `sudo manual <https://www.sudo.ws/man/1.8.13/sudoers.man.html>`_ for ``env_keep`` configuration
|
||||
* `openssh manual <https://linux.die.net/man/1/ssh>`_ for information about ``SSH_CONNECTION`` environment
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cat << EOF > /etc/sudoers.d/keepenv
|
||||
Defaults env_keep += HOME
|
||||
Defaults env_keep += SSH_CONNECTION
|
||||
EOF
|
||||
chmod 400 /etc/sudoers.d/keepenv
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Clean
|
||||
^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
~ ❯
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
~/.dotfiles on master ⤏ origin ↑2 •7 ✗ ❯
|
||||
|
||||
Ssh
|
||||
^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
user@hostname in ~/bash-it on master ✓ ❯
|
||||
|
||||
Python venv
|
||||
^^^^^^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
flask ~/test on master ✓ ❯
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
.. _bira:
|
||||
|
||||
Bira Theme
|
||||
==========
|
||||
|
||||
This is a port of Oh My Zsh's `'Bira' <https://github.com/ohmyzsh/ohmyzsh/blob/master/themes/bira.zsh-theme>`_ theme. It looks the same as the original, except for the following changes:
|
||||
|
||||
|
||||
* Exit code of last command is not shown
|
||||
* More informative git prompt (if you want to keep it minimal, please read: :ref:`git_prompt`)
|
||||
* Position and colour of virtualenv prompt
|
||||
* No ruby version prompt
|
||||
|
|
@ -0,0 +1,145 @@
|
|||
.. _brainy:
|
||||
|
||||
Brainy theme
|
||||
============
|
||||
|
||||
Simple colorful terminal prompt theme (inspired by a number of themes).
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
Prompt Segments
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
* Username & Hostname
|
||||
* Current Directory
|
||||
* SCM Information
|
||||
* Battery Charge
|
||||
* Clock
|
||||
* `Todo.txt <https://github.com/ginatrapani/todo.txt-cli>`_ status
|
||||
* Ruby Environment
|
||||
* Python Environment
|
||||
* Exit Code
|
||||
|
||||
Others
|
||||
^^^^^^
|
||||
|
||||
|
||||
* Indicator for cached ``sudo`` credential
|
||||
* Indicator for ssh login
|
||||
* ``brainy`` command for showing/hiding various prompt segments on-the-fly
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
Various prompt segments can be shown/hidden or modified according to your choice. There are two ways for doing that:
|
||||
|
||||
|
||||
#. On-the-fly using ``brainy`` command
|
||||
#. Theme Environment Variables
|
||||
|
||||
On-the-fly using ``brainy`` command
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This theme provides a command for showing/hiding prompt segments.
|
||||
|
||||
``brainy show <segment>``
|
||||
|
||||
``brainy hide <segment>``
|
||||
|
||||
Tab-completion for this command is enabled by default.
|
||||
|
||||
Configuration specified by this command will only be applied to current and subsequent child shells.
|
||||
|
||||
Theme Environment Variables
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This is used for permanent settings that apply to all terminal sessions. You have to define the value of specific theme variables in your ``bashrc`` (or equivalent) file.
|
||||
|
||||
The name of the variables are listed below along with their default values.
|
||||
|
||||
User Information
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Indicator for cached ``sudo`` credential (see ``sudo`` manpage for more information):
|
||||
|
||||
``THEME_SHOW_SUDO=true``
|
||||
|
||||
SCM Information
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Information about SCM repository status:
|
||||
|
||||
``THEME_SHOW_SCM=true``
|
||||
|
||||
Ruby Environment
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Ruby environment version information:
|
||||
|
||||
``THEME_SHOW_RUBY=false``
|
||||
|
||||
Python Environment
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Python environment version information:
|
||||
|
||||
``THEME_SHOW_PYTHON=false``
|
||||
|
||||
ToDo.txt status
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
`Todo.txt <https://github.com/ginatrapani/todo.txt-cli>`_ status:
|
||||
|
||||
``THEME_SHOW_TODO=false``
|
||||
|
||||
Clock
|
||||
~~~~~
|
||||
|
||||
``THEME_SHOW_CLOCK=true``
|
||||
|
||||
``THEME_CLOCK_COLOR=$bold_cyan``
|
||||
|
||||
Format of the clock (see ``date`` manpage for more information):
|
||||
|
||||
``THEME_CLOCK_FORMAT="%H:%M:%S"``
|
||||
|
||||
Battery Charge
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
Battery charge percentage:
|
||||
|
||||
``THEME_SHOW_BATTERY=false``
|
||||
|
||||
Exit Code
|
||||
~~~~~~~~~
|
||||
|
||||
Exit code of the last command:
|
||||
|
||||
``THEME_SHOW_EXITCODE=true``
|
||||
|
||||
Prompt Segments Order
|
||||
---------------------
|
||||
|
||||
Currently available prompt segments are:
|
||||
|
||||
|
||||
* battery
|
||||
* char
|
||||
* clock
|
||||
* dir
|
||||
* exitcode
|
||||
* python
|
||||
* ruby
|
||||
* scm
|
||||
* todo
|
||||
* user_info
|
||||
|
||||
Three environment variables can be defined to rearrange the segments order. The default values are:
|
||||
|
||||
``___BRAINY_TOP_LEFT="user_info dir scm"``
|
||||
|
||||
``___BRAINY_TOP_RIGHT="python ruby todo clock battery"``
|
||||
|
||||
``___BRAINY_BOTTOM="exitcode char"``
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
.. _codeword:
|
||||
|
||||
Codeword Theme
|
||||
==============
|
||||
|
||||
Single line PS1 theme w/realtime history among windows.
|
||||
Minimal theme overrides from bash_it base theming
|
||||
|
||||
``user@host:path[virt-env][scm] $``
|
||||
---------------------------------------
|
||||
|
||||
Breakdown of the segments:
|
||||
|
||||
|
||||
* **user@host:path** - *convienient for LAN based ``ssh`` and ``scp`` tasks*
|
||||
* [\ **virtualenv**\ ] - *only appears when activated*
|
||||
* [\ **scm**\ ] - *only appears when activated*
|
||||
* **marker** - *$ or # depending on current user*
|
||||
|
||||
Examples
|
||||
^^^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
user@example.lan:~ $ cd /tmp/foo/bar/baz
|
||||
user@example.lan:/tmp/foo/bar/baz $ cd $HOME/workspace
|
||||
user@example.lan:~/workspace $ cd sampleRepo/
|
||||
user@example.lan:~/workspace/sampleRepo [± |master ↑1 ↓3 {1} S:2 ?:1 ✗|] $
|
||||
|
|
@ -0,0 +1,570 @@
|
|||
.. _list_of_themes:
|
||||
|
||||
List of Themes
|
||||
==============
|
||||
|
||||
Below is a list of most of the themes (with screenshots) and their documentation that `bash-it <https://github.com/Bash-it/bash-it/>`_ ships with.
|
||||
|
||||
.. note::
|
||||
Not all themes have documentation!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Documentation of Themes
|
||||
:glob:
|
||||
|
||||
*
|
||||
|
||||
Alphabetical Screenshots List
|
||||
-----------------------------
|
||||
|
||||
Bakke
|
||||
^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/bakke-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/bakke-black.jpg
|
||||
:alt: Bakke
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/bakke-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/bakke-white.jpg
|
||||
:alt: Bakke
|
||||
|
||||
|
||||
----
|
||||
|
||||
BarbUk
|
||||
^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/BarbUk-black.png
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/BarbUk-black.png
|
||||
:alt: BarbUk
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/BarbUk-white.png
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/BarbUk-white.png
|
||||
:alt: BarbUk
|
||||
|
||||
|
||||
----
|
||||
|
||||
Bobby
|
||||
^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/bobby-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/bobby-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/bobby-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/bobby-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Brunton
|
||||
^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/brunton-black.png
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/brunton-black.png
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Candy
|
||||
^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/candy-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/candy-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/candy-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/candy-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Clean
|
||||
^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/clean-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/clean-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/clean-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/clean-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Demula
|
||||
^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/demula-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/demula-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/demula-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/demula-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
DOS
|
||||
^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/dos-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/dos-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/dos-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/dos-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
DoubleTime
|
||||
^^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/doubletime-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/doubletime-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/doubletime-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/doubletime-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
DoubleTime Multiline
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Doubletime Multiline Python Only
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline_pyonly-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline_pyonly-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline_pyonly-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/doubletime_multiline_pyonly-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Envy
|
||||
^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/envy-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/envy-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/envy-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/envy-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Iterate
|
||||
^^^^^^^
|
||||
|
||||
Responsively wraps prompt based on terminal width.
|
||||
|
||||
|
||||
.. image:: https://cloud.githubusercontent.com/assets/1319655/2923152/3a763194-d70e-11e3-9e52-3740de9bbb9b.png
|
||||
:target: https://cloud.githubusercontent.com/assets/1319655/2923152/3a763194-d70e-11e3-9e52-3740de9bbb9b.png
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://cloud.githubusercontent.com/assets/1319655/2923143/14b8e0d2-d70e-11e3-9706-f5341fff8e5c.png
|
||||
:target: https://cloud.githubusercontent.com/assets/1319655/2923143/14b8e0d2-d70e-11e3-9706-f5341fff8e5c.png
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Mr Briggs
|
||||
^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/mbriggs-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/mbriggs-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/mbriggs-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/mbriggs-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Minimal
|
||||
^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/minimal-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/minimal-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/minimal-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/minimal-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Modern
|
||||
^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/modern-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/modern-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/modern-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/modern-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Modern T
|
||||
^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/modern-t-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/modern-t-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/modern-t-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/modern-t-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Metal
|
||||
^^^^^
|
||||
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/jrab66/bash-it/7cc82b518d6286fc68c8477d809ce9f417501976/themes/metal/metalthemeblack.png
|
||||
:target: https://raw.githubusercontent.com/jrab66/bash-it/7cc82b518d6286fc68c8477d809ce9f417501976/themes/metal/metalthemeblack.png
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
n0Qorg
|
||||
^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/n0qorg-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/n0qorg-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/n0qorg-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/n0qorg-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
.. _nwinkler_image:
|
||||
|
||||
NWinkler
|
||||
^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/nwinkler-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/nwinkler-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/nwinkler-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/nwinkler-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Pete
|
||||
^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/pete-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/pete-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/pete-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/pete-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Powerline
|
||||
^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/powerline-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/powerline-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/powerline-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/powerline-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Powerline Naked
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/powerline-naked-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/powerline-naked-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/powerline-naked-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/powerline-naked-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Powerline Plain
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/powerline-plain-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/powerline-plain-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/powerline-plain-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/powerline-plain-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Pure
|
||||
^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/pure-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/pure-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/pure-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/pure-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
RainbowBrite
|
||||
^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/rainbowbrite-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/rainbowbrite-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/rainbowbrite-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/rainbowbrite-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
R Jorgenson
|
||||
^^^^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/rjorgenson-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/rjorgenson-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/rjorgenson-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/rjorgenson-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Sexy
|
||||
^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/sexy-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/sexy-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/sexy-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/sexy-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Simple
|
||||
^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/simple-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/simple-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/simple-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/simple-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
SirUp
|
||||
^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/sirup-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/sirup-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/sirup-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/sirup-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Standard
|
||||
^^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/standard-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/standard-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/standard-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/standard-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Tonka
|
||||
^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/tonka-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/tonka-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/tonka-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/tonka-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Tylenol
|
||||
^^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/tylenol-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/tylenol-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/tylenol-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/tylenol-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Zitron
|
||||
^^^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/zitron-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/zitron-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/zitron-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/zitron-white.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
----
|
||||
|
||||
Zork
|
||||
^^^^
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/zork-black.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/zork-black.jpg
|
||||
:alt:
|
||||
|
||||
|
||||
.. image:: https://bash-it.github.io/bash-it/docs/images/zork-white.jpg
|
||||
:target: https://bash-it.github.io/bash-it/docs/images/zork-white.jpg
|
||||
:alt:
|
||||
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
|
@ -0,0 +1,39 @@
|
|||
.. _nwinkler_random_color:
|
||||
|
||||
Nwinkler Random Color Theme
|
||||
===========================
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
The *Nwinkler Random Color* Theme is based on the :ref:`Nwinkler Theme <nwinkler_image>` , but it randomizes the colors for:
|
||||
|
||||
|
||||
* time
|
||||
* username
|
||||
* hostname
|
||||
* path
|
||||
|
||||
The random colors are chosen the first time this theme is used and saved to the ``~/.nwinkler_random_colors`` file. So, the next time you connect to the same machine, you will get the same colors.
|
||||
|
||||
To force new random colors to be selected, run the command:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
randomize_nwinkler
|
||||
|
||||
Screenshot
|
||||
----------
|
||||
|
||||
Here it is in action:
|
||||
|
||||
|
||||
.. image:: nwinkler_random_colors.png
|
||||
:target: nwinkler_random_colors.png
|
||||
:alt: alt text
|
||||
|
||||
|
||||
Usage Scenario
|
||||
--------------
|
||||
|
||||
This theme is especially useful when connecting to many different machines and switching between them often. Yes, the hostname *is* present in the prompt. But I argue that it's a lot faster to get a "feel" of what machine you are currently on because of the custom colors on that machine's prompt than by reading the hostname.
|
||||
|
|
@ -0,0 +1,127 @@
|
|||
.. _powerline_base:
|
||||
|
||||
Base Powerline Theme Information
|
||||
================================
|
||||
|
||||
This page explains base powerline theme information, shared between
|
||||
all powerline themes.
|
||||
|
||||
**IMPORTANT:** This theme requires that `a font with the Powerline symbols <https://github.com/powerline/fonts>`_ needs to be used in your terminal emulator, otherwise the prompt won't be displayed correctly, i.e. some of the additional icons and characters will be missing. Please follow your operating system's instructions to install one of the fonts from the above link and select it in your terminal emulator.
|
||||
|
||||
**NOTICE:** The default behavior of this theme assumes that you have sudo privileges on your workstation. If that is not the case (e.g. if you are running on a corporate network where ``sudo`` usage is tracked), you can set the flag 'export THEME_CHECK_SUDO=false' in your ``~/.bashrc`` or ``~/.bash_profile`` to disable the Powerline theme's ``sudo`` check. This will apply to all ``powerline*`` themes.
|
||||
|
||||
Provided Information
|
||||
--------------------
|
||||
|
||||
|
||||
* Current path
|
||||
* Current username and hostname
|
||||
* Current time
|
||||
* Current shell level
|
||||
* Current dirstack level (\ ``pushd`` / ``popd``\ )
|
||||
* Current history number
|
||||
* Current command number
|
||||
* An indicator when connected by SSH
|
||||
* An indicator when ``sudo`` has the credentials cached (see the ``sudo`` manpage for more info about this)
|
||||
* An indicator when the current shell is inside the Vim editor
|
||||
* Battery charging status (depends on the battery plugin)
|
||||
* SCM Repository status (e.g. Git, SVN)
|
||||
* The current Kubernetes environment
|
||||
* The current Python environment (Virtualenv, venv, and Conda are supported) in use
|
||||
* The current Ruby environment (rvm and rbenv are supported) in use
|
||||
* Last command exit code (only shown when the exit code is greater than 0)
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
This theme is pretty configurable, all the configuration is done by setting environment variables.
|
||||
|
||||
User Information
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
By default, the username and hostname are shown, but you can change this behavior by setting the value of the following variable:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
export POWERLINE_PROMPT_USER_INFO_MODE="sudo"
|
||||
|
||||
|
||||
For now, the only supported value is ``sudo``\ , which hides the username and hostname, and shows an indicator when ``sudo`` has the credentials cached. Other values have no effect at this time.
|
||||
|
||||
Clock Format
|
||||
^^^^^^^^^^^^
|
||||
|
||||
You can change the format using the following variable:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
export THEME_CLOCK_FORMAT="%H:%M:%S"
|
||||
|
||||
|
||||
The time/date is printed by the ``date`` command, so refer to its man page to change the format.
|
||||
|
||||
Segment Order
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
The contents of the prompt can be "reordered", all the "segments" (every piece of information) can take any place. The currently available segments are:
|
||||
|
||||
|
||||
* ``aws_profile`` - Show the current value of the ``AWS_PROFILE`` environment variable
|
||||
* ``battery`` - Battery information (you'll need to enable the ``battery`` plugin)
|
||||
* ``clock`` - Current time in ``HH:MM:SS`` format
|
||||
* ``cwd`` - Current working directory including full folder hierarchy (c.f. ``wd``\ )
|
||||
* ``hostname`` - Host name of machine
|
||||
* ``in_toolbox`` - Show identifier if running inside a `toolbox <https://github.com/containers/toolbox>`_
|
||||
* ``in_vim`` - Show identifier if running in ``:terminal`` from vim
|
||||
* ``k8s_context`` - Show current kubernetes context
|
||||
* ``last_status`` - Exit status of last run command
|
||||
* ``python_venv`` - Python virtual environment information (\ ``virtualenv``\ , ``venv``
|
||||
and ``conda`` supported)
|
||||
* ``ruby`` - Current ruby version if using ``rvm``
|
||||
* ``node`` - Current node version (only ``nvm`` is supported)
|
||||
* ``scm`` - Version control information, ``git``
|
||||
* ``terraform`` - Current terraform workspace
|
||||
* ``user_info`` - Current user
|
||||
* ``wd`` - Working directory, like ``cwd`` but doesn't show the full folder
|
||||
hierarchy, only the directory you're currently in.
|
||||
* ``shlvl`` - Show the current shell level (based on ``SHLVL`` environment variable), but only if you are not in root shell
|
||||
* ``dirstack`` - Show the current dirstack level (based on ``DIRSTACK`` environment variable), but only if the stack is not empty
|
||||
* ``history_number`` - Show current history number
|
||||
* ``command_number`` - Show current command number
|
||||
|
||||
A variable can be defined to set the order of the prompt segments:
|
||||
|
||||
.. code-block::
|
||||
|
||||
POWERLINE_PROMPT="user_info scm python_venv ruby cwd"
|
||||
|
||||
|
||||
The example values above are the current default values, but if you want to remove anything from the prompt, simply remove the "string" that represents the segment from the variable.
|
||||
|
||||
.. _powerline_compact_settings:
|
||||
|
||||
Compact Settings
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
You can configure various aspects of the prompt to use less whitespace. Supported variables are:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Variable
|
||||
- Description
|
||||
* - POWERLINE_COMPACT_BEFORE_SEPARATOR
|
||||
- Removes the leading space before each separator
|
||||
* - POWERLINE_COMPACT_AFTER_SEPARATOR
|
||||
- Removes the trailing space after each separator
|
||||
* - POWERLINE_COMPACT_BEFOR_FIRST_SEGMENT
|
||||
- Removes the leading space on the first segment
|
||||
* - POWERLINE_COMPACT_AFTER_LAST_SEGMENT
|
||||
- Removes the trailing space on the last segment
|
||||
* - POWERLINE_COMPACT_PROMPT
|
||||
- Removes the space after the prompt character
|
||||
* - POWERLINE_COMPACT
|
||||
- Enable all Compact settings (you can still override individual settings)
|
||||
|
||||
|
||||
The default value for all settings is ``0`` (disabled). Use ``1`` to enable.
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
.. _powerline_multiline:
|
||||
|
||||
Powerline Multiline Theme
|
||||
=========================
|
||||
|
||||
A colorful multiline theme, where the first line shows information about your shell session (divided into two parts, left and right), and the second one is where the shell commands are introduced.
|
||||
|
||||
See :ref:`powerline_base` for general information about the powerline theme.
|
||||
|
||||
Soft Separators
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Adjacent segments having the same background color will use a less-pronouced (i.e. soft) separator between them.
|
||||
|
||||
Padding
|
||||
^^^^^^^
|
||||
|
||||
To get the length of the left and right segments right, a *padding* value is used.
|
||||
In most cases, the default value (\ *2*\ ) works fine, but on some operating systems, this needs to be adjusted.
|
||||
One example is *macOS High Sierra*\ , where the default padding causes the right segment to extend to the next line.
|
||||
On macOS High Sierra, the padding value needs to be changed to *3* to make the theme look right.
|
||||
This can be done by setting the ``POWERLINE_PADDING`` variable before Bash-it is loaded, e.g. in your ``~/.bash_profile`` or ``~/.bashrc`` file:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
export POWERLINE_PADDING=3
|
||||
|
||||
|
||||
Multiline Mode Right Prompt
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For the purposes of the :ref:`Compact <powerline_compact_settings>` settings, the segments within the **Right Prompt** are considered to run "right-to-left", i.e.:
|
||||
|
||||
|
||||
* The **right-most** segment is considered to be the ``"first"`` segment, while the **left-most** segment is considered to be the ``"last"``
|
||||
* The space to the **right** of the separator character is considered to be ``"before"``\ , while the space to the **left** is considered to be ``"after"``
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
.. _powerline_naked:
|
||||
|
||||
Powerline Naked Theme
|
||||
=====================
|
||||
|
||||
A colorful theme, where shows a lot information about your shell session.
|
||||
The naked powerline theme provides a cleaner shell with less background colors.
|
||||
|
||||
See :ref:`powerline_base` for general information about the powerline theme.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
.. _powerline_plain:
|
||||
|
||||
Powerline Plain Theme
|
||||
=====================
|
||||
|
||||
A colorful theme, where shows a lot information about your shell session.
|
||||
The plain powerline theme provides a simpler shell with less information.
|
||||
|
||||
See :ref:`powerline_base` for general information about the powerline theme.
|
||||
|
||||
Soft Separators
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Adjacent segments having the same background color will use a less-pronouced (i.e. soft) separator between them.
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
.. _powerline:
|
||||
|
||||
Powerline Theme
|
||||
===============
|
||||
|
||||
A colorful theme, where shows a lot information about your shell session.
|
||||
|
||||
See :ref:`powerline_base` for general information about the powerline theme.
|
||||
|
||||
Soft Separators
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Adjacent segments having the same background color will use a less-pronouced (i.e. soft) separator between them.
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
.. _radek:
|
||||
|
||||
Radek Theme
|
||||
===========
|
||||
|
||||
A colorful theme for Python developers.
|
||||
It does not have any requirements.
|
||||
|
||||
Provided Information
|
||||
--------------------
|
||||
|
||||
|
||||
* Current username and hostname
|
||||
* Current path
|
||||
* Git repository status
|
||||
* Current Python environment (venv, Conda )
|
||||
* Current Python version
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
[radek@photon][~/src/nokia2/cbis] ±[master → origin ↑1 {1}✓][venv-cbis][py-3.7.5]
|
||||
→
|
||||
|
Before Width: | Height: | Size: 962 KiB After Width: | Height: | Size: 962 KiB |
|
|
@ -0,0 +1,56 @@
|
|||
.. _redline:
|
||||
|
||||
Redline Theme
|
||||
=============
|
||||
|
||||
changed up the powerline base a little.
|
||||
|
||||
It plays nicest with this font: `DroidSansMonoForPowerline <https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/DroidSansMono>`_
|
||||
|
||||
Read the :ref:`powerline theme documentation <powerline>`
|
||||
|
||||
added
|
||||
-----
|
||||
|
||||
|
||||
* hostname
|
||||
* distro logo
|
||||
|
||||
changed
|
||||
-------
|
||||
|
||||
|
||||
* sudo credential check
|
||||
* required font
|
||||
* some icons
|
||||
|
||||
Works real good like with:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
## set the theme
|
||||
export BASH_IT_THEME='redline'
|
||||
|
||||
# Set this to false to turn off version control status checking within the prompt for all themes
|
||||
export SCM_CHECK=true
|
||||
|
||||
## Set Xterm/screen/Tmux title with only a short hostname.
|
||||
export SHORT_HOSTNAME=$(hostname -s)
|
||||
|
||||
## enable sudo prompt
|
||||
export POWERLINE_PROMPT_USER_INFO_MODE="sudo"
|
||||
|
||||
## prompt part string
|
||||
export POWERLINE_PROMPT="python_venv user_info hostname cwd scm"
|
||||
|
||||
enable your distro logo with
|
||||
----------------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
export POWERLINE_PROMPT_DISTRO_LOGO="yes"
|
||||
|
||||
|
||||
.. image:: redline.png
|
||||
:target: redline.png?raw=true
|
||||
:alt: screenshot
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
.. _themes:
|
||||
|
||||
Themes
|
||||
------
|
||||
|
||||
There are over 50+ Bash-it themes to pick from in ``$BASH_IT/themes``.
|
||||
The default theme is ``bobby``.
|
||||
Set ``BASH_IT_THEME`` to the theme name you want, or if you've developed your own custom theme outside of ``$BASH_IT/themes``\ ,
|
||||
point the ``BASH_IT_THEME`` variable directly to the theme file.
|
||||
To disable theming completely, leave the variable empty.
|
||||
|
||||
Examples:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Use the "powerline-multiline" theme
|
||||
export BASH_IT_THEME="powerline-multiline"
|
||||
|
||||
# Use a theme outside of the Bash-it folder
|
||||
export BASH_IT_THEME="/home/foo/my_theme/my_theme.theme.bash"
|
||||
|
||||
# Disable theming
|
||||
export BASH_IT_THEME=""
|
||||
|
||||
You can easily preview the themes in your own shell using ``BASH_PREVIEW=true bash-it reload``.
|
||||
|
||||
If you've created your own custom prompts, we'd love it if you shared them with everyone else! Just submit a Pull Request.
|
||||
You can see theme screenshots on `wiki/Themes <https://github.com/Bash-it/bash-it/wiki/Themes>`_.
|
||||
|
||||
**NOTE**\ : Bash-it and some themes use UTF-8 characters, so to avoid strange behavior in your terminal, set your locale to ``LC_ALL=en_US.UTF-8`` or the equivalent to your language if it isn't American English.
|
||||
|
||||
List of Themes
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
See :ref:`here <list_of_themes>`.
|
||||
|
||||
Theme Switches & Variables
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Clock Related
|
||||
=============
|
||||
|
||||
function: ``clock_char``
|
||||
########################
|
||||
|
||||
Prints a character indicating clock.
|
||||
|
||||
|
||||
* ``THEME_SHOW_CLOCK_CHAR`` : **true**\ /false
|
||||
|
||||
* ``THEME_CLOCK_CHAR`` : "\ **⌚**\ "
|
||||
|
||||
* ``THEME_CLOCK_CHAR_COLOR`` : "\ **$normal**\ "
|
||||
|
||||
function: ``clock_prompt``
|
||||
##########################
|
||||
|
||||
Prints the clock prompt (date, time).
|
||||
|
||||
|
||||
* ``THEME_SHOW_CLOCK`` : **true**\ /false
|
||||
|
||||
* ``THEME_CLOCK_COLOR`` : "\ **$normal**\ "
|
||||
|
||||
* ``THEME_CLOCK_FORMAT`` : "\ **%H:%M:%S**\ "
|
||||
|
||||
Contributing a new theme
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
See the :ref:`instructions <contributing_theme>`.
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
.. _troubleshooting:
|
||||
|
||||
Troubleshooting Guide
|
||||
=====================
|
||||
|
||||
Table of Contents
|
||||
-----------------
|
||||
|
||||
* `I'm stuck in the LightDM login screen after setting up bash-it. <im-stuck-in-the-lightdm-login-screen-after-setting-up-bash-it>`_
|
||||
|
||||
I'm stuck in the LightDM login screen after setting up bash-it
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**Possible issue**\ : `#672 <https://github.com/Bash-it/bash-it/issues/672>`_
|
||||
|
||||
**Solution**\ : Check `this comment <https://github.com/Bash-it/bash-it/issues/672#issuecomment-257870653>`_ for detailed information about the cause and solution for this issue.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
.. _uninstalling:
|
||||
|
||||
Uninstalling
|
||||
------------
|
||||
|
||||
To uninstall Bash-it, run the ``uninstall.sh`` script found in the ``$BASH_IT`` directory:
|
||||
|
||||
.. code-block::
|
||||
|
||||
cd $BASH_IT
|
||||
./uninstall.sh
|
||||
|
||||
This will restore your previous Bash profile.
|
||||
After the uninstall script finishes, remove the Bash-it directory from your machine (\ ``rm -rf $BASH_IT``\ ) and start a new shell.
|
||||
|
|
@ -0,0 +1,200 @@
|
|||
.. _vcs_user:
|
||||
|
||||
Prompt Version Control Information
|
||||
==================================
|
||||
|
||||
Bash-it provides prompt :ref:`themes` with the ability to check and display version control information for the current directory.
|
||||
The information is retrieved for each directory and can slow down the navigation of projects with a large number of files and folders.
|
||||
Turn version control checking off to prevent slow directory navigation within large projects.
|
||||
|
||||
Controlling Flags
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
Bash-it provides a flag (\ ``SCM_CHECK``\ ) within the ``~/.bash_profile`` file that turns off/on version control information checking and display within all themes.
|
||||
Version control checking is on by default unless explicitly turned off.
|
||||
|
||||
Set ``SCM_CHECK`` to 'false' to **turn off** version control checks for all themes:
|
||||
|
||||
|
||||
* ``export SCM_CHECK=false``
|
||||
|
||||
Set ``SCM_CHECK`` to 'true' (the default value) to **turn on** version control checks for all themes:
|
||||
|
||||
|
||||
* ``export SCM_CHECK=true``
|
||||
|
||||
**NOTE:**
|
||||
It is possible for themes to ignore the ``SCM_CHECK`` flag and query specific version control information directly.
|
||||
For example, themes that use functions like ``git_prompt_vars`` skip the ``SCM_CHECK`` flag to retrieve and display git prompt information.
|
||||
If you turned version control checking off and you still see version control information within your prompt, then functions like ``git_prompt_vars`` are most likely the reason why.
|
||||
|
||||
.. _git_prompt:
|
||||
|
||||
Git prompt
|
||||
^^^^^^^^^^
|
||||
|
||||
Bash-it has some nice features related to Git, continue reading to know more about these features.
|
||||
|
||||
Repository info in the prompt
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Bash-it can show some information about Git repositories in the shell prompt: the current branch, tag or commit you are at, how many commits the local branch is ahead or behind from the remote branch, and if you have changes stashed.
|
||||
|
||||
Additionally, you can view the status of your working copy and get the count of *staged*\ , *unstaged* and *untracked* files.
|
||||
This feature is controlled through the flag ``SCM_GIT_SHOW_DETAILS`` as follows:
|
||||
|
||||
Set ``SCM_GIT_SHOW_DETAILS`` to 'true' (the default value) to **show** the working copy details in your prompt:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_DETAILS=true``
|
||||
|
||||
Set ``SCM_GIT_SHOW_DETAILS`` to 'false' to **don't show** it:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_DETAILS=false``
|
||||
|
||||
**NOTE:** If using ``SCM_GIT_SHOW_MINIMAL_INFO=true``\ , then the value of ``SCM_GIT_SHOW_DETAILS`` is ignored.
|
||||
|
||||
Remotes and remote branches
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
In some git workflows, you must work with various remotes, for this reason, Bash-it can provide some useful information about your remotes and your remote branches, for example, the remote on you are working, or if your local branch is tracking a remote branch.
|
||||
|
||||
You can control this feature with the flag ``SCM_GIT_SHOW_REMOTE_INFO`` as follows:
|
||||
|
||||
Set ``SCM_GIT_SHOW_REMOTE_INFO`` to 'auto' (the default value) to activate it only when more than one remote is configured in the current repo:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_REMOTE_INFO=auto``
|
||||
|
||||
Set ``SCM_GIT_SHOW_REMOTE_INFO`` to 'true' to always activate the feature:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_REMOTE_INFO=true``
|
||||
|
||||
Set ``SCM_GIT_SHOW_REMOTE_INFO`` to 'false' to **disable the feature**\ :
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_REMOTE_INFO=false``
|
||||
|
||||
**NOTE:** If using ``SCM_GIT_SHOW_MINIMAL_INFO=true``\ , then the value of ``SCM_GIT_SHOW_REMOTE_INFO`` is ignored.
|
||||
|
||||
Untracked files
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
By default, the ``git status`` command shows information about *untracked* files.
|
||||
This behavior can be controlled through command-line flags or git configuration files.
|
||||
For big repositories, ignoring *untracked* files can make git faster.
|
||||
Bash-it uses ``git status`` to gather the repo information it shows in the prompt, so in some circumstances, it can be useful to instruct Bash-it to ignore these files.
|
||||
You can control this behavior with the flag ``SCM_GIT_IGNORE_UNTRACKED``\ :
|
||||
|
||||
Set ``SCM_GIT_IGNORE_UNTRACKED`` to 'false' (the default value) to get information about *untracked* files:
|
||||
|
||||
|
||||
* ``export SCM_GIT_IGNORE_UNTRACKED=false``
|
||||
|
||||
Set ``SCM_GIT_IGNORE_UNTRACKED`` to 'true' to **ignore** *untracked* files:
|
||||
|
||||
|
||||
* ``export SCM_GIT_IGNORE_UNTRACKED=true``
|
||||
|
||||
Also, with this flag to false, Bash-it will not show the repository as dirty when the repo has *untracked* files, and will not display the count of *untracked* files.
|
||||
|
||||
**NOTE:** If you set in git configuration file the option to ignore *untracked* files, this flag has no effect, and Bash-it will ignore *untracked* files always.
|
||||
|
||||
Stash item count
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
When ``SCM_GIT_SHOW_DETAILS`` is enabled, you can get the count of *stashed* items. This feature can be useful when a user has a lot of stash items.
|
||||
This feature is controlled through the flag ``SCM_GIT_SHOW_STASH_INFO`` as follows:
|
||||
|
||||
Set ``SCM_GIT_SHOW_STASH_INFO`` to 'true' (the default value) to **show** the count of stashed items:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_STASH_INFO=true``
|
||||
|
||||
Set ``SCM_GIT_SHOW_STASH_INFO`` to 'false' to **don't show** it:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_STASH_INFO=false``
|
||||
|
||||
Ahead/Behind Count
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When displaying information regarding whether or not the local branch is ahead or behind its remote counterpart, you can opt to display the number of commits ahead/behind.
|
||||
This is useful if you only care whether or not you are ahead or behind and do not care how far ahead/behind you are.
|
||||
|
||||
Set ``SCM_GIT_SHOW_COMMIT_COUNT`` to 'true' (the default value) to **show** the count of commits ahead/behind:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_COMMIT_COUNT=true``
|
||||
|
||||
Set ``SCM_GIT_SHOW_COMMIT_COUNT`` to 'false' to **don't show** it:
|
||||
|
||||
|
||||
* ``export SCM_GIT_SHOW_COMMIT_COUNT=false``
|
||||
|
||||
Git user
|
||||
^^^^^^^^
|
||||
|
||||
In some environments, it is useful to know the value of the current git user, which is used to mark all new commits.
|
||||
For example, any organization that uses the practice of pair programming will typically author each commit with `combined names of the two authors <https://github.com/pivotal/git_scripts>`_.
|
||||
When another pair uses the same pairing station, the authors are changed at the beginning of the session.
|
||||
|
||||
To get up and running with this technique, run ``gem install pivotal_git_scripts``\ , and then edit your ``~/.pairs`` file, according to the specification on the `gem's homepage <https://github.com/pivotal/git_scripts>`_.
|
||||
After that, you should be able to run ``git pair kg as`` to set the author to, eg. "Konstantin Gredeskoul and Alex Saxby", assuming they've been added to the ``~/.pairs`` file.
|
||||
Please see gem's documentation for more information.
|
||||
|
||||
To enable the display of the current pair in the prompt, you must set ``SCM_GIT_SHOW_CURRENT_USER`` to ``true``.
|
||||
Once set, the ``SCM_CURRENT_USER`` variable will be automatically populated with the initials of the git author(s).
|
||||
It will also be included in the default git prompt.
|
||||
Even if you do not have ``git pair`` installed, as long as your ``user.name`` is set, your initials will be computed from your name and shown in the prompt.
|
||||
|
||||
You can control the prefix and the suffix of this component using the two variables:
|
||||
|
||||
|
||||
* ``export SCM_THEME_CURRENT_USER_PREFFIX=' ☺︎ '``
|
||||
|
||||
And
|
||||
|
||||
|
||||
* ``export SCM_THEME_CURRENT_USER_SUFFIX=' ☺︎ '``
|
||||
|
||||
**NOTE:** If using ``SCM_GIT_SHOW_MINIMAL_INFO=true``\ , then the value of ``SCM_GIT_SHOW_CURRENT_USER`` is ignored.
|
||||
|
||||
Git show minimal status info
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To speed up the prompt while still getting minimal git status information displayed such as the value of ``HEAD`` and whether there are any dirty objects, you can set:
|
||||
|
||||
.. code-block::
|
||||
|
||||
export SCM_GIT_SHOW_MINIMAL_INFO=true
|
||||
|
||||
Ignore repo status
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When working in repos with a large codebase, Bash-it can slow down your prompt when checking the repo status.
|
||||
To avoid it, there is an option you can set via Git config to disable checking repo status in Bash-it.
|
||||
|
||||
To disable checking the status in the current repo:
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ git config --add bash-it.hide-status 1
|
||||
|
||||
But if you would like to disable it globally, and stop checking the status for all of your repos:
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ git config --global --add bash-it.hide-status 1
|
||||
|
||||
Setting this flag globally has the same effect as ``SCM_CHECK=true``\ , but only for Git repos.
|
||||
|
||||
Speed up git status calculations
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
As an alternative to ignoring repo status entirely, you can try out the ``gitstatus`` plugin.
|
||||
This plugin speeds up all ``git status`` calculations by up to 10x times!
|
||||
|
||||
**NOTE**\ : You will need to clone ``gitstatus`` repo from `here <https://github.com/romkatv/gitstatus>`_.
|
||||
38
install.sh
38
install.sh
|
|
@ -10,6 +10,7 @@ function show_usage() {
|
|||
echo "--silent (-s): Install default settings without prompting for input";
|
||||
echo "--interactive (-i): Interactively choose plugins"
|
||||
echo "--no-modify-config (-n): Do not modify existing config file"
|
||||
echo "--append-to-config (-a): Keep existing config file and append bash-it templates at the end"
|
||||
exit 0;
|
||||
}
|
||||
|
||||
|
|
@ -56,15 +57,27 @@ function load_some() {
|
|||
done
|
||||
}
|
||||
|
||||
# Back up existing profile and create new one for bash-it
|
||||
function backup_new() {
|
||||
# Back up existing profile
|
||||
function backup() {
|
||||
test -w "$HOME/$CONFIG_FILE" &&
|
||||
cp -aL "$HOME/$CONFIG_FILE" "$HOME/$CONFIG_FILE.bak" &&
|
||||
echo -e "\033[0;32mYour original $CONFIG_FILE has been backed up to $CONFIG_FILE.bak\033[0m"
|
||||
}
|
||||
|
||||
# Back up existing profile and create new one for bash-it
|
||||
function backup_new() {
|
||||
backup
|
||||
sed "s|{{BASH_IT}}|$BASH_IT|" "$BASH_IT/template/bash_profile.template.bash" > "$HOME/$CONFIG_FILE"
|
||||
echo -e "\033[0;32mCopied the template $CONFIG_FILE into ~/$CONFIG_FILE, edit this file to customize bash-it\033[0m"
|
||||
}
|
||||
|
||||
# Back up existing profile and append bash-it templates at the end
|
||||
function backup_append() {
|
||||
backup
|
||||
(sed "s|{{BASH_IT}}|$BASH_IT|" "$BASH_IT/template/bash_profile.template.bash" | tail -n +2) >> "$HOME/$CONFIG_FILE"
|
||||
echo -e "\033[0;32mBash-it template has been added to your $CONFIG_FILE\033[0m"
|
||||
}
|
||||
|
||||
for param in "$@"; do
|
||||
shift
|
||||
case "$param" in
|
||||
|
|
@ -72,18 +85,20 @@ for param in "$@"; do
|
|||
"--silent") set -- "$@" "-s" ;;
|
||||
"--interactive") set -- "$@" "-i" ;;
|
||||
"--no-modify-config") set -- "$@" "-n" ;;
|
||||
"--append-to-config") set -- "$@" "-a" ;;
|
||||
*) set -- "$@" "$param"
|
||||
esac
|
||||
done
|
||||
|
||||
OPTIND=1
|
||||
while getopts "hsin" opt
|
||||
while getopts "hsina" opt
|
||||
do
|
||||
case "$opt" in
|
||||
"h") show_usage; exit 0 ;;
|
||||
"s") silent=true ;;
|
||||
"i") interactive=true ;;
|
||||
"n") no_modify_config=true ;;
|
||||
"a") append_to_config=true ;;
|
||||
"?") show_usage >&2; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
|
|
@ -94,6 +109,11 @@ if [[ $silent ]] && [[ $interactive ]]; then
|
|||
exit 1;
|
||||
fi
|
||||
|
||||
if [[ $no_modify_config ]] && [[ $append_to_config ]]; then
|
||||
echo -e "\033[91mOptions --no-modify-config and --append-to-config are mutually exclusive. Please choose one or the other.\033[m"
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
BASH_IT="$(cd "$(dirname "$0")" && pwd)"
|
||||
|
||||
case $OSTYPE in
|
||||
|
|
@ -127,16 +147,11 @@ if ! [[ $silent ]] && ! [[ $no_modify_config ]]; then
|
|||
done
|
||||
fi
|
||||
|
||||
while ! [ $silent ]; do
|
||||
while ! [ $append_to_config ]; do
|
||||
read -e -n 1 -r -p "Would you like to keep your $CONFIG_FILE and append bash-it templates at the end? [y/N] " choice
|
||||
case $choice in
|
||||
[yY])
|
||||
test -w "$HOME/$CONFIG_FILE" &&
|
||||
cp -aL "$HOME/$CONFIG_FILE" "$HOME/$CONFIG_FILE.bak" &&
|
||||
echo -e "\033[0;32mYour original $CONFIG_FILE has been backed up to $CONFIG_FILE.bak\033[0m"
|
||||
|
||||
(sed "s|{{BASH_IT}}|$BASH_IT|" "$BASH_IT/template/bash_profile.template.bash" | tail -n +2) >> "$HOME/$CONFIG_FILE"
|
||||
echo -e "\033[0;32mBash-it template has been added to your $CONFIG_FILE\033[0m"
|
||||
backup_append
|
||||
break
|
||||
;;
|
||||
[nN]|"")
|
||||
|
|
@ -148,6 +163,9 @@ if ! [[ $silent ]] && ! [[ $no_modify_config ]]; then
|
|||
;;
|
||||
esac
|
||||
done
|
||||
elif [[ $append_to_config ]]; then
|
||||
# backup/append
|
||||
backup_append
|
||||
elif [[ $silent ]] && ! [[ $no_modify_config ]]; then
|
||||
# backup/new by default
|
||||
backup_new
|
||||
|
|
|
|||
|
|
@ -26,6 +26,17 @@ function _command_exists ()
|
|||
type "$1" &> /dev/null || (_log_warning "$msg" && return 1) ;
|
||||
}
|
||||
|
||||
function _binary_exists ()
|
||||
{
|
||||
_about 'checks for existence of a binary'
|
||||
_param '1: binary to check'
|
||||
_param '2: (optional) log message to include when binary not found'
|
||||
_example '$ _binary_exists ls && echo exists'
|
||||
_group 'lib'
|
||||
local msg="${2:-Binary '$1' does not exist!}"
|
||||
type -P "$1" &> /dev/null || (_log_warning "$msg" && return 1) ;
|
||||
}
|
||||
|
||||
function _make_reload_alias() {
|
||||
echo "source \${BASH_IT}/scripts/reloader.bash ${1} ${2}"
|
||||
}
|
||||
|
|
@ -80,7 +91,7 @@ bash-it ()
|
|||
_bash-it-search $component "$@"
|
||||
return;;
|
||||
update)
|
||||
func=_bash-it_update-$component;;
|
||||
func=_bash-it-update-$component;;
|
||||
migrate)
|
||||
func=_bash-it-migrate;;
|
||||
version)
|
||||
|
|
@ -158,18 +169,18 @@ _bash-it-plugins ()
|
|||
_bash-it-describe "plugins" "a" "plugin" "Plugin"
|
||||
}
|
||||
|
||||
_bash-it_update-dev() {
|
||||
_bash-it-update-dev() {
|
||||
_about 'updates Bash-it to the latest master'
|
||||
_group 'lib'
|
||||
|
||||
_bash-it_update- dev "$@"
|
||||
_bash-it-update- dev "$@"
|
||||
}
|
||||
|
||||
_bash-it_update-stable() {
|
||||
_bash-it-update-stable() {
|
||||
_about 'updates Bash-it to the latest tag'
|
||||
_group 'lib'
|
||||
|
||||
_bash-it_update- stable "$@"
|
||||
_bash-it-update- stable "$@"
|
||||
}
|
||||
|
||||
_bash-it_pull_and_update_inner() {
|
||||
|
|
@ -187,7 +198,7 @@ _bash-it_pull_and_update_inner() {
|
|||
fi
|
||||
}
|
||||
|
||||
_bash-it_update-() {
|
||||
_bash-it-update-() {
|
||||
_about 'updates Bash-it'
|
||||
_param '1: What kind of update to do (stable|dev)'
|
||||
_group 'lib'
|
||||
|
|
@ -336,12 +347,22 @@ _bash-it-version() {
|
|||
BASH_IT_GIT_REMOTE=$(git remote get-url $BASH_IT_REMOTE)
|
||||
BASH_IT_GIT_URL=${BASH_IT_GIT_REMOTE%.git}
|
||||
|
||||
BASH_IT_GIT_VERSION_INFO="$(git log --pretty=format:'%h on %aI' -n 1)"
|
||||
BASH_IT_GIT_SHA=${BASH_IT_GIT_VERSION_INFO%% *}
|
||||
current_tag=$(git describe --exact-match --tags 2> /dev/null)
|
||||
|
||||
echo "Current git SHA: $BASH_IT_GIT_VERSION_INFO"
|
||||
echo "$BASH_IT_GIT_URL/commit/$BASH_IT_GIT_SHA"
|
||||
echo "Compare to latest: $BASH_IT_GIT_URL/compare/$BASH_IT_GIT_SHA...master"
|
||||
if [[ -z $current_tag ]]; then
|
||||
BASH_IT_GIT_VERSION_INFO="$(git log --pretty=format:'%h on %aI' -n 1)"
|
||||
TARGET=${BASH_IT_GIT_VERSION_INFO%% *}
|
||||
echo "Version type: dev"
|
||||
echo "Current git SHA: $BASH_IT_GIT_VERSION_INFO"
|
||||
echo "Commit info: $BASH_IT_GIT_URL/commit/$TARGET"
|
||||
else
|
||||
TARGET=$current_tag
|
||||
echo "Version type: stable"
|
||||
echo "Current tag: $current_tag"
|
||||
echo "Tag information: $BASH_IT_GIT_URL/releases/tag/$current_tag"
|
||||
fi
|
||||
|
||||
echo "Compare to latest: $BASH_IT_GIT_URL/compare/$TARGET...master"
|
||||
|
||||
cd - &> /dev/null || return
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,23 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# Pull list of checkable files from clean_files.txt
|
||||
# - Folder references are allowed
|
||||
# - Empty lines are ignored
|
||||
# - Comment lines (#) are ignored
|
||||
#
|
||||
# shellcheck disable=SC2002 # Prefer 'cat' for cleaner script
|
||||
mapfile -t FILES < <(
|
||||
cat clean_files.txt \
|
||||
| grep -v -E '^\s*$' \
|
||||
| grep -v -E '^\s*#' \
|
||||
| xargs -n1 -I{} find "{}" -type f
|
||||
)
|
||||
|
||||
# We clear the BASH_IT variable to help the shellcheck checker
|
||||
# identify source includes within our scripts that require a
|
||||
# 'source' directive. For more information, see:
|
||||
#
|
||||
# "Shellcheck SC1090 - Can't follow non-constant source"
|
||||
# https://www.shellcheck.net/wiki/SC1090
|
||||
#
|
||||
BASH_IT='' pre-commit run --files "${FILES[@]}"
|
||||
|
|
@ -8,5 +8,5 @@ if command -v brew &>/dev/null && [[ -s $(brew --prefix)/etc/profile.d/autojump.
|
|||
elif command -v dpkg &>/dev/null && dpkg -s autojump &>/dev/null ; then
|
||||
. "$(dpkg-query -S autojump.sh | cut -d' ' -f2)"
|
||||
elif command -v pacman &>/dev/null && pacman -Q autojump &>/dev/null ; then
|
||||
. "$(pacman -Ql autojump | grep autojump.sh | cut -d' ' -f2)"
|
||||
. "$(pacman -Ql autojump | grep autojump.sh | cut -d' ' -f2)"
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -21,4 +21,3 @@ explain () {
|
|||
echo "explain 'cmd -o | ...' one quoted command to explain it."
|
||||
fi
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -227,7 +227,7 @@ function gitignore-reload() {
|
|||
example '$ gitignore-reload'
|
||||
|
||||
# The .gitignore file should not be reloaded if there are uncommited changes.
|
||||
# Firstly, require a clean work tree. The function require_clean_work_tree()
|
||||
# Firstly, require a clean work tree. The function require_clean_work_tree()
|
||||
# was stolen with love from https://www.spinics.net/lists/git/msg142043.html
|
||||
|
||||
# Begin require_clean_work_tree()
|
||||
|
|
@ -273,5 +273,3 @@ function gitignore-reload() {
|
|||
echo >&2 "Files readded. Commit your new changes now."
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -19,4 +19,3 @@ function gw() {
|
|||
# Call gradle
|
||||
"${result}" $*
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -7,4 +7,4 @@ export LESS_TERMCAP_me=$'\e[0m'
|
|||
export LESS_TERMCAP_se=$'\e[0m'
|
||||
export LESS_TERMCAP_so=$'\e[01;33m'
|
||||
export LESS_TERMCAP_ue=$'\e[0m'
|
||||
export LESS_TERMCAP_us=$'\e[1;4;31m'
|
||||
export LESS_TERMCAP_us=$'\e[1;4;31m'
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ do
|
|||
if [ -f "$possible/pg_hba.conf" ]
|
||||
then
|
||||
# echo "PGDATA: $possible"
|
||||
export PGDATA=$possible
|
||||
export PGDATA=$possible
|
||||
fi
|
||||
done
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ function postgres_start {
|
|||
about 'Starts PostgreSQL server'
|
||||
group 'postgres'
|
||||
|
||||
echo 'Starting Postgres....';
|
||||
echo 'Starting Postgres....';
|
||||
$POSTGRES_BIN/pg_ctl -D $PGDATA -l $PGDATA/logfile start
|
||||
}
|
||||
|
||||
|
|
@ -31,7 +31,7 @@ function postgres_stop {
|
|||
about 'Stops PostgreSQL server'
|
||||
group 'postgres'
|
||||
|
||||
echo 'Stopping Postgres....';
|
||||
echo 'Stopping Postgres....';
|
||||
$POSTGRES_BIN/pg_ctl -D $PGDATA -l $PGDATA/logfile stop -s -m fast
|
||||
}
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ function postgres_status {
|
|||
about 'Returns status of PostgreSQL server'
|
||||
group 'postgres'
|
||||
|
||||
# $POSTGRES_BIN/pg_ctl -D $PGDATA status
|
||||
# $POSTGRES_BIN/pg_ctl -D $PGDATA status
|
||||
if [[ $(is_postgres_running) == "no server running" ]]
|
||||
then
|
||||
echo "Postgres service [STOPPED]"
|
||||
|
|
@ -58,7 +58,7 @@ function postgres_restart {
|
|||
about 'Restarts status of PostgreSQL server'
|
||||
group 'postgres'
|
||||
|
||||
echo 'Restarting Postgres....';
|
||||
echo 'Restarting Postgres....';
|
||||
$POSTGRES_BIN/pg_ctl -D $PGDATA restart
|
||||
}
|
||||
|
||||
|
|
@ -84,4 +84,3 @@ function postgres_serverlog {
|
|||
# tail -500 $PGDATA/pg_log/`ls -Art $PGDATA/pg_log | tail -n 1` | less
|
||||
# }
|
||||
#
|
||||
|
||||
|
|
|
|||
|
|
@ -22,5 +22,5 @@ bashPowerlineInit=$(python -c \
|
|||
'bindings', \
|
||||
'bash', \
|
||||
'powerline.sh'))")
|
||||
[ -e $bashPowerlineInit ] || return
|
||||
[ -e $bashPowerlineInit ] || return
|
||||
. $bashPowerlineInit
|
||||
|
|
|
|||
|
|
@ -6,4 +6,3 @@ about-plugin 'Load Software Development Kit Manager'
|
|||
export SDKMAN_DIR=${SDKMAN_DIR:-$HOME/.sdkman}
|
||||
|
||||
[[ -s "${SDKMAN_DIR}/bin/sdkman-init.sh" ]] && source "${SDKMAN_DIR}/bin/sdkman-init.sh"
|
||||
|
||||
|
|
|
|||
|
|
@ -1,40 +0,0 @@
|
|||
# Testing with Bats
|
||||
|
||||
## Overview
|
||||
|
||||
The Bash-it unit tests leverage the [Bats unit test framework for Bash](https://github.com/bats-core/bats-core).
|
||||
There is no need to install Bats explicitly, the test run script will automatically download and install Bats and its dependencies.
|
||||
|
||||
When making changes to Bash-it, the tests are automatically executed in a test build environment on [Travis CI](https://travis-ci.com).
|
||||
|
||||
## Test Execution
|
||||
|
||||
To execute the unit tests, please run the `run` script:
|
||||
|
||||
```bash
|
||||
# If you are in the `test` directory:
|
||||
./run
|
||||
|
||||
# If you are in the root `.bash_it` directory:
|
||||
test/run
|
||||
```
|
||||
|
||||
The `run` script will automatically install if it is not already present, and will then run all tests found under the `test` directory, including subdirectories.
|
||||
|
||||
To run only a subset of the tests, you can provide the name of the test subdirectory that you want to run, e.g. like this for the tests in the `test/themes` directory:
|
||||
|
||||
```bash
|
||||
# If you are in the root `.bash_it` directory:
|
||||
test/run test/themes
|
||||
```
|
||||
|
||||
By default, the tests run in single-threaded mode.
|
||||
If you want to speed up the test execution, you can install the [GNU `parallel` tool](https://www.gnu.org/software/parallel/), which is supported by Bats.
|
||||
When using `parallel`, the `test/run` script will use a number of threads in parallel, depending on the available CPU cores of your system.
|
||||
This can speed up test execution significantly.
|
||||
|
||||
## Writing Tests
|
||||
|
||||
When adding or modifying tests, please stick to the format and conventions of the existing test cases.
|
||||
The `test_helper.bash` script provides a couple of reusable helper functions that you should use when writing a test case,
|
||||
for example for setting up an isolated test environment.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue