Bash-it
docs
  • Contribution Guidelines
  • Bash-it Development
  • Testing Bash-it
  • Installation
  • Bash-it Commands
    • Bash-it update
    • Bash-it migrate
    • Bash-it search
      • Syntax
      • Searching with Negations
      • Using Search to Enable or Disable Components
      • Disabling ASCII Color
    • Bash-it reload
    • Bash-it doctor
  • Custom Content
  • Themes
  • Prompt Version Control Information
  • Misc
  • Uninstalling
Bash-it
  • »
  • Bash-it Commands »
  • Bash-it search
  • Edit on GitHub

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¶

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-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-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:

❯ NO_COLOR=1 bash-it search ruby rake gem bundle irb rails -chruby
      aliases  =>   ✓bundler ✓rails
      plugins  =>   ✓ruby
  completions  =>   bundler gem rake
Next Previous

© Copyright 2020, Bash-it Team Revision a7172831.

Built with Sphinx using a theme provided by Read the Docs.