https://github.com/sc0ty/grip

Indexed grep
https://github.com/sc0ty/grip

Last synced: 14 days ago
JSON representation

Indexed grep

• Host: GitHub
• URL: https://github.com/sc0ty/grip
• Owner: sc0ty
• License: gpl-3.0
• Created: 2016-12-03T23:08:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-02-04T23:36:39.000Z (10 months ago)
• Last Synced: 2024-02-05T00:34:04.569Z (10 months ago)
• Language: C++
• Size: 217 KB
• Stars: 11
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grip

Indexed grep - fast search (grep like) in huge stack of files.

Author: [Mike Szymaniak](http://sc0ty.pl)

## Features

- fast search for pattern in text files;

- intended mainly (but not limited to) source code;

- support for Huge Blobs of Legacy Code™;

- language & encoding agnostic (excluding UTF-16);

- search with regex (basic and extended) or fixed string;

- case sensitive and case insensitive search;

- search limited to current subdirectory;

- context line control (`grep`s `-B`, `-A` and `-C` switches);

- colored output.

## Limitations

- index must be generated prior to search;

- and it must be up to date with files content;

- some regular expressions are too convoluted to lookup into index;

- only limited `grep`s switches are implemented;

- search pattern is assumed to be encoded the same way as searched files (usually not the case for ASCII characters, e.g. source code).

## Requirements

- C++11 compiler (e.g. GCC 4.8+ or Clang 3.4+);

- [Boost library](http://www.boost.org): regex, filesystem and system.

## Compilation

Assuming above requirements are met

```

mkdir build

cd build

cmake ..

make

make install

```

For more information see [installation guide](doc/INSTALL.md)

## Usage

First we need to generate index database.

Under POSIX system:

```

find . -type f | gripgen

```

Or under Windows:

```

dir /b /s /a:-d | gripgen

```

It will create database directory `.grip`. Binary files (these containing zero byte) will be ignored.

In case of great number of files, this step will take some time. Indexer typically process 100 to 1000 files per second, and the resulting database size will be about 10% of the indexed data.

You could also provide file list to index

```

gripgen list.txt

```

Indexed files must be located inside current directory and its subdirectories.

Now you could perform search, e.g.:

```

grip printf

grip -E '(foo|bar)-[a-z]*'

grip -i -C3 'hello world'

grip --list main

```

For more usage information type `grip --help`.