https://github.com/lucky125111/cerebro-file-search

Cerebro plugin to locate files and folders in system
https://github.com/lucky125111/cerebro-file-search

Last synced: about 2 months ago
JSON representation

Cerebro plugin to locate files and folders in system

• Host: GitHub
• URL: https://github.com/lucky125111/cerebro-file-search
• Owner: lucky125111
• Created: 2020-01-29T16:31:16.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-05T19:12:06.000Z (almost 5 years ago)
• Last Synced: 2024-11-02T19:03:06.423Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 264 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-cerebro - cerebro-file-search - Cerebro plugin for fast file and folder search everywhere on your computer. (Plugins)

README

        

# Cerebro Linux/MacOS file and folder search

> Cerebro plugin to locate files and folders in system

![https://raw.githubusercontent.com/lucky125111/cerebro-search-linux/master/folder.gif](https://raw.githubusercontent.com/lucky125111/cerebro-search-linux/master/folder.gif)

## Prerequisites

This tool requires `locate`it indexes files which provides fast search results.

**Debian and Ubuntu**

```bash

sudo apt-get install locate

```

**Prepare locate command for first use**

To update the mlocate.db database before first use, run:

```bash

sudo updatedb

```

## Installation

The plugin is avaialable on [npm](https://www.npmjs.com/package/cerebro-file-search-locate)

To add plugin

1. Go to you cerebro folder typically `$XDG_CONFIG_HOME/Cerebro/` or `~/.config/Cerebro/`

2. `cd ./plugins`

3. `yarn add cerebro-file-search-locate`

To run locally use

```bash

git clone https://github.com/lucky125111/cerebro-file-search.git

yarn install 

yarn start

```

## Usage

In Cerebro, type file name or path of path to look for. Currently the file search will show only first 100 results. Clicking the file will reveal it in the folder explorer

## Features

* Typically files will by searched by only file name 

* If you include '/' paths will be searched 

* On click the file will be shown in window explorer

* Use your keyboard to navigate the entire interface. Intuitive and does what you expect

## Remark

This plugin is only available on Linux and MacOS, since Windows doesn't have locate package

## Related

* [Cerebro](http://github.com/KELiON/cerebro) – main repo for Cerebro app

* [cerebro plugin boilerplate](https://github.com/KELiON/cerebro-plugin) – boilerplate used to create this plugin

* [es-everything-plugin](https://github.com/masterperas/es-everything-plugin) - windows version utilizing everything cli

## TODO's

1. Prefered folders to be shown at the beginning of the list

2. Reveal in explorer on ctrl+enter, open on enter

3. Separate list of folders excluded from search to separate file

4. Support for regular expressions