Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arsham/blush
Grep with colours
https://github.com/arsham/blush
go golang grep terminal-app
Last synced: 1 day ago
JSON representation
Grep with colours
- Host: GitHub
- URL: https://github.com/arsham/blush
- Owner: arsham
- License: mit
- Created: 2018-05-21T12:23:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-03T19:23:19.000Z (over 1 year ago)
- Last Synced: 2025-01-19T12:05:36.653Z (8 days ago)
- Topics: go, golang, grep, terminal-app
- Language: Go
- Size: 153 KB
- Stars: 553
- Watchers: 7
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Blush
[](https://pkg.go.dev/github.com/arsham/dbtools)
[](https://github.com/arsham/dbtools/actions/workflows/go.yml)
[](https://opensource.org/licenses/MIT)
[](https://codecov.io/gh/arsham/blush)
[](https://goreportcard.com/report/github.com/arsham/blush)
With Blush, you can highlight matches with any colours of your choice.
1. [Install](#install)
2. [Usage](#usage)
- [Note](#note)
- [Normal Mode](#normal-mode)
- [Dropping Unmatched](#dropping-unmatched)
- [Piping](#piping)
3. [Arguments](#arguments)
- [Notes](#notes)
4. [Colour Groups](#colour-groups)
5. [Colours](#colours)
6. [Complex Grep](#complex-grep)
7. [Suggestions](#suggestions)
8. [License](#license)
## Install
You can grab a binary from [releases](https://github.com/arsham/blush/releases)
page. If you prefer to install it manually you can get the code and install it
with the following command:
```bash
$ go install github.com/arsham/blush@latest
```
Make sure you have `go>=1.18` installed.
## Usage
Blush can read from a file or a pipe:
```bash
$ cat FILENAME | blush -b "print in blue" -g "in green" -g "another green"
$ cat FILENAME | blush "some text"
$ blush -b "print in blue" -g "in green" -g "another green" FILENAME
$ blush "some text" FILENAME
```
### Note
Although this program has a good performance, but performance is not the main
concern. There are other tools you should use if you are searching in large
files. Two examples:
- [Ripgrep](https://github.com/BurntSushi/ripgrep)
- [The Silver Searcher](https://github.com/ggreer/the_silver_searcher)
### Normal Mode
This method shows matches with the given input:
```bash
$ blush -b "first search" -g "second one" -g "and another one" files/paths
```
Any occurrence of `first search` will be in blue, `second one` and `and another one`
are in green.
### Dropping Unmatched
By default, unmatched lines are not dropped. But you can use the `-d` flag to
drop them:
## Arguments
| Argument | Shortcut | Notes |
| :------------ | :------- | :---------------------------------------------- |
| N/A | -i | Case insensitive matching. |
| N/A | -R | Recursive matching. |
| --no-filename | -h | Suppress the prefixing of file names on output. |
| --drop | -d | Drop unmatched lines |
File names or paths are matched from the end. Any argument that doesn't match
any files or paths are considered as regular expression. If regular expressions
are not followed by colouring arguments are coloured based on previously
provided colour:
```bash
$ blush -b match1 match2 FILENAME
```
### Notes
- If no colour is provided, blush will choose blue.
- If you only provide file/path, it will print them out without colouring.
- If the matcher contains only alphabets and numbers, a non-regular expression is applied to search.
## Colour Groups
You can provide a number for a colour argument to create a colour group:
```bash
$ blush -r1 match1 -r2 match2 -r1 match3 FILENAME
```
All matches will be shown as blue. But `match1` and `match3` will have a
different background colour than `match2`. This means the numbers will create
colour groups.
You also can provide a colour with a series of match requests:
```bash
$ blush -r match1 match3 -g match2 FILENAME
```
## Colours
You can choose a pre-defined colour, or pass it your own colour with a hash:
| Argument | Shortcut |
| :-------- | :------- |
| --red | -r |
| --green | -g |
| --blue | -b |
| --white | -w |
| --black | -bl |
| --yellow | -yl |
| --magenta | -mg |
| --cyan | -cy |
You can also pass an RGB colour. It can be in short form (--#1b2, -#1b2), or
long format (--#11bb22, -#11bb22).
## Complex Grep
You must put your complex grep into quotations:
```bash
$ blush -b "^age: [0-9]+" FILENAME
```
## Suggestions
This tool is made to make your experience in terminal a more pleasant. Please
feel free to make any suggestions or request features by creating an issue.
## License
Use of this source code is governed by the MIT License. License file can be
found in the [LICENSE](./LICENSE) file.