# kmpcli

> A CLI that searches for text inside files, based on KMP algorithm

Latest version **1.2.2** (published 2019-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install kmpcli
pnpm add kmpcli
yarn add kmpcli
bun add kmpcli
```

Provides the command `kmpcli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2019-07-20 |
| First published | 2018-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | __parnab, itssayantan |
| Keywords | kmpcli, KMP, CLI, Node, JS, Node.JS, Knuth-Morris-Pratt, text, searching |

## Links

- npm: https://www.npmjs.com/package/kmpcli
- Repository: https://github.com/itsSayantan/kmpcli
- Homepage: https://github.com/itsSayantan/kmpcli#readme
- Issues: https://github.com/itsSayantan/kmpcli/issues
- npm.io page: https://npm.io/package/kmpcli

## Dependencies (1)

- [graceful-fs](https://npm.io/package/graceful-fs.md) ^4.1.15

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.2.2 (latest) — 2019-07-20
- 1.2.1 — 2019-07-20
- 1.2.0 — 2019-04-14
- 1.1.0 — 2019-04-14
- 0.0.4 — 2018-10-20
- 0.0.3 — 2018-10-20
- 0.0.2 — 2018-10-20
- 0.0.1 — 2018-10-20

## README

# kmpcli
A CLI based on KMP algorithm

# Installation
```
npm install -g kmpcli
```

# How to Use?
```
kmpcli --location <directory_name> --text <search_text>
```

# Flags
- --location (shorthand -l) [Mandatory] -> specifies the location or directory name where to find the text
- --text (shorthand -t) [Mandatory] -> specifies the search text
- --show-details [Optional] -> if provided by the user, shows detailed output like the skipped folders and number of occurances

The flags can be used in any order, however kmpcli reads the flags in such a way that the value next to a flag should be the value of the flag. For example: ```kmpcli --location --text ./somePath someText``` is invalid.

# Example
```
kmpcli ./someDir/someSubDir someText
kmpcli D:/abc/def someText
```

---
_Source: https://npm.io/package/kmpcli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._