# @vmarcosp/findr

> Findr CLI ● A simple and beatiful find & replace command-line interface.

Latest version **0.0.11** (published 2020-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vmarcosp/findr
pnpm add @vmarcosp/findr
yarn add @vmarcosp/findr
bun add @vmarcosp/findr
```

Provides the command `findr`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2020-11-30 |
| First published | 2020-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Maintainers | vmarcosp |

## Links

- npm: https://www.npmjs.com/package/@vmarcosp/findr
- npm.io page: https://npm.io/package/@vmarcosp/findr

## Recent versions

- 0.0.11 (latest) — 2020-11-30
- 0.0.10 — 2020-11-28
- 0.0.9 — 2020-11-28
- 0.0.8 — 2020-11-28
- 0.0.7 — 2020-11-28
- 0.0.6 — 2020-11-27
- 0.0.5 — 2020-11-27
- 0.0.4 — 2020-11-04
- 0.0.3 — 2020-11-04
- 0.0.2 — 2020-11-04
- 0.0.1 — 2020-11-04

## README

<p align="center">
  <br />
  <img src="./assets/logo.svg" width="500" /> 
</p>
<p align="center">
   <a href="#preview">Preview</a> •
   <a href="#features">Features</a> •
   <a href="#commands">Commands</a> •
   <a href="#license">License</a> 
</p>
<br/>

## Preview
<p align="center">
  <br />
  
  <p align="center"><b><i>Find command</i></b></p>
  <p align="center"><img src="./assets/find.gif" width="600" /> </p>
</p>
<br/>
<p align="center">
  <br />
 
  <p align="center"><b><i>Replace command + regex</i></b></p>
  <p align="center"><img src="./assets/replace.gif" width="600" /> </p>
</p>

## Installation
```
npm i -g @vmarcosp/findr
```

## OS Support
- :white_check_mark: &nbsp; Mac
- :white_check_mark: &nbsp; Linux
- :gear: &nbsp; Windows *(WIP)*

## Features

- :white_check_mark: &nbsp; Find
- :white_check_mark: &nbsp; Replace
- :white_check_mark: &nbsp; Colorized output
- :white_check_mark: &nbsp; Highlight and preview occurrences
- :white_check_mark: &nbsp; Select files to replace
- :white_check_mark: &nbsp; Regex support
- ⚙️  &nbsp; Select ocurrences to replace *(WIP)*

## Commands

### Find command:
Positional arguments:
  - 1º *Text to find*

Named arguments:
  - `--folder` or `-f`
  - `--regex` or `-r` regex mode
  - `--extension` or `-e` filter files by extension


Example:
```sh
  # Basic usage
  findr find "write_file" --folder src

  # Filtering by extension
  findr find "write_file" --folder src --extension re,js
```

### Replace command:
Positional arguments:
 - 1º *Text to replace*
 - 2º *New text*

Named arguments:
  - `--folder` or `-f`
  - `--regex` or `-r` *regex mode*
  - `--extension` or `-e` filter files by extension


Example:
```sh
  # Basic usage
  findr replace "write_file" "create_file" --folder src

  # Regex mode
  findr replace "\bwrite_file" "create_file" --folder src --regex
```

## License

MIT

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