ripgrep/crates/cli/README.md

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](https://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;
```
grep-cli: introduce new grep-cli crate This commit moves a lot of "utility" code from ripgrep core into grep-cli. Any one of these things might not be worth creating a new crate, but combining everything together results in a fair number of a convenience routines that make up a decent sized crate. There is potentially more we could move into the crate, but much of what remains in ripgrep core is almost entirely dealing with the number of flags we support. In the course of doing moving things to the grep-cli crate, we clean up a lot of gunk and improve failure modes in a number of cases. In particular, we've fixed a bug where other processes could deadlock if they write too much to stderr. Fixes #990 2018-08-30 02:53:52 +02:00			`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)`

doc: update several links to use https PR #1724 2020-11-03 17:33:36 +02:00			`Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org/).`
grep-cli: introduce new grep-cli crate This commit moves a lot of "utility" code from ripgrep core into grep-cli. Any one of these things might not be worth creating a new crate, but combining everything together results in a fair number of a convenience routines that make up a decent sized crate. There is potentially more we could move into the crate, but much of what remains in ripgrep core is almost entirely dealing with the number of flags we support. In the course of doing moving things to the grep-cli crate, we clean up a lot of gunk and improve failure modes in a number of cases. In particular, we've fixed a bug where other processes could deadlock if they write too much to stderr. Fixes #990 2018-08-30 02:53:52 +02:00

			`### 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;`
			```