arvis-filesearch-plugin/README.md

File search plugin for Arvis

# arvis-filesearch-plugin
[![CodeFactor](https://www.codefactor.io/repository/github/jopemachine/arvis-filesearch-plugin/badge)](https://www.codefactor.io/repository/github/jopemachine/arvis-filesearch-plugin)
[![NPM download total](https://img.shields.io/npm/dt/arvis-filesearch-plugin)](http://badge.fury.io/js/arvis-filesearch-plugin)
[![NPM version](https://badge.fury.io/js/arvis-filesearch-plugin.svg)](http://badge.fury.io/js/arvis-filesearch-plugin)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
[![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
[![GitHub issues](https://img.shields.io/github/issues/jopemachine/arvis-filesearch-plugin.svg)](https://GitHub.com/jopemachine/arvis-filesearch-plugin/issues/)

Cross platform file search plugin for [Arvis](https://github.com/jopemachine/arvis)

![](./media/demo.gif)

![](./media/demo2.png)

## Installation

```
$ npm i -g arvis-filesearch-plugin
```

## Config

You can edit this plugin's config on `User config table` like below.

![](./media/config.png)

### include

type: `string []`

default value: `desktop`, `documents`, `downloads`, `home`

To add more directory, refer to this [platform](https://github.com/jopemachine/arvish/blob/master/documents/lib-workflow.md#platform) env variables.

### customInclude

type: `string []`

default value: `[]`

You can include directory add custom directories you want to search.

### exclude

type: `string []`

default value: `[]`

To exclude some directory, Add path to exclude to `exclude` of `conf.js`

### deep

type: `number`

default value: `1`

Sets the depth to explore

### concurrency

type: `number | undefined`

default value: `os.cpus().length`

Specifies the number of cpu to use for navigation

### maxItem

type: `number`

default value: `30`

Maximum number of output files

It doesn't affect performance.

### includeDotFiles

type: `boolean`

default value : `false`

Include files beginning with `.` in your search

## Related

- [fast-glob](https://github.com/mrmlnc/fast-glob) - API for this module.

- [arvish](https://github.com/jopemachine/arvish) - Arvis workflow, plugin creator tools

- [other plugins](https://github.com/jopemachine/arvis/blob/master/documents/plugin-links.md)

## Icon sources

This plugin uses below icon sources

<a target="_blank" href="https://icons8.com">Image</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>