Contents

# Filerary [![Build Status](https://secure.travis-ci.org/myokoym/filerary.png?branch=master)](http://travis-ci.org/myokoym/filerary)

A fulltext search tool for local files that contains text.

For example, .txt, .pdf, .xls and so on.

## Requirements

* [GrnMini](https://github.com/ongaeshi/grn_mini)
  * [Rroonga](http://ranguba.org/)
    * [Groonga - An open-source fulltext search engine and column store](http://groonga.org/)
* [ChupaText](https://github.com/ranguba/chupa-text)
* [chupa-text-decomposer-pdf](https://github.com/ranguba/chupa-text-decomposer-pdf)
  * Ruby/Poppler in [Ruby-GNOME2](http://ruby-gnome2.sourceforge.jp/)
* [chupa-text-decomposer-libreoffice](https://github.com/ranguba/chupa-text-decomposer-libreoffice)
  * [LibreOffice](https://www.libreoffice.org/)
* [Thor](http://whatisthor.com/)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'filerary'
```

And then execute:

```bash
$ bundle
```

Or install it yourself as:

```bash
$ gem install filerary
```

## Usage

### Collect files (takes time)

```bash
$ filerary collect FILE...
```

### List filenames in the collection

```bash
$ filerary list
```

### Search for files in the collection (very fast!)

```bash
$ filerary search WORD
```

### Remove deleted files in the collection

```bash
$ filerary cleanup
```
### Remove a file in the collection

```bash
$ filerary remove PATH
```

## Authors

* Masafumi Yokoyama `<[e-mail]>`

## License

LGPL 2.1 or later.

See [LICENSE](https://github.com/myokoym/filerary/blob/master/LICENSE.txt) or 'http://www.gnu.org/licenses/lgpl-2.1'.

## Contributing

1. Fork it ( http://github.com/myokoym/filerary/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
filerary-0.0.6	README.md