Skip to content
Recursive grep function for the command line
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
mock
spec
src
.editorconfig
.gitignore
.travis.yml
LICENSE
Makefile
README.md
shard.yml

README.md

Grepper

A simple commandline tool to search recursively through files of given file extention

Travis Build Status

Supported Systems

  • Mac OS version: 10.12.6 or higher

Requirements

  • Crystal version: 0.28.0 or higher

Installation

Install source from tarball

download the source code: version v1.0.1 and unpack the tarball, from here you can enter the directory and run the following command

  1. To build the binary run $ make
  2. To install the binary run $ sudo make install

Install source from git

  1. Clone the repository $ git clone git@github.com:Nopzen/grepper.git
  2. Enter the directory $ cd grepper
  3. To build the binary run $ make
  4. To install the binary run $ sudo make install

Both of the installations above should install the binary in your /usr/local/bin by default, unless $DESTDIR or $prefix is defined. See the makefile for more information regarding final location of the bin.

OSX - With Homebrew

  1. $ brew tap nopzen/grepper
  2. $ brew install grepper
  3. run $ grepper -h to see if its installed if not create a issue here

Usage

Defaults: path: if --path is not defined, path wil be set to current working directory. extention: if --extention is not defined the default would be set to .txt.

Usage: grepper [query] -- [arguments]

  • -p=PATH, --path=PATH Define path to search for files in
  • -e=EXT, --extention=EXT Define file extention should be read
  • -q=QUERY, --query Define the string to search for (Required)
  • -h, --help Show this help

Development

TODO: Write development instructions here

Contributing

  1. Fork it (https://github.com/nopzen/grepper/fork)
  2. Create your feature branch (git checkout -b feature/my-new-feature)
  3. Commit your changes (git commit -am 'change: mychange' <change should be either, update: fix: added: deprecated:)
  4. Push to the branch (git push origin feature/my-new-feature)
  5. Create a new Pull Request

Contributors

You can’t perform that action at this time.