mirror of
https://github.com/BurntSushi/ripgrep.git
synced 2024-12-12 19:18:24 +02:00
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
|
grep-cli
|
||
|
--------
|
||
|
A utility library that provides common routines desired in search oriented
|
||
|
command line applications. This includes, but is not limited to, parsing hex
|
||
|
escapes, detecting whether stdin is readable and more. To the extent possible,
|
||
|
this crate strives for compatibility across Windows, macOS and Linux.
|
||
|
|
||
|
[![Linux build status](https://api.travis-ci.org/BurntSushi/ripgrep.svg)](https://travis-ci.org/BurntSushi/ripgrep)
|
||
|
[![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep)
|
||
|
[![](https://img.shields.io/crates/v/grep-cli.svg)](https://crates.io/crates/grep-cli)
|
||
|
|
||
|
Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
|
||
|
|
||
|
|
||
|
### Documentation
|
||
|
|
||
|
[https://docs.rs/grep-cli](https://docs.rs/grep-cli)
|
||
|
|
||
|
**NOTE:** You probably don't want to use this crate directly. Instead, you
|
||
|
should prefer the facade defined in the
|
||
|
[`grep`](https://docs.rs/grep)
|
||
|
crate.
|
||
|
|
||
|
|
||
|
### Usage
|
||
|
|
||
|
Add this to your `Cargo.toml`:
|
||
|
|
||
|
```toml
|
||
|
[dependencies]
|
||
|
grep-cli = "0.1"
|
||
|
```
|
||
|
|
||
|
and this to your crate root:
|
||
|
|
||
|
```rust
|
||
|
extern crate grep_cli;
|
||
|
```
|