Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myokoym/filerary
Filerary is a fulltext search tool for local files that contains text. For example, .txt, .pdf, .xls and so on.
https://github.com/myokoym/filerary
Last synced: 2 days ago
JSON representation
Filerary is a fulltext search tool for local files that contains text. For example, .txt, .pdf, .xls and so on.
- Host: GitHub
- URL: https://github.com/myokoym/filerary
- Owner: myokoym
- License: lgpl-2.1
- Created: 2014-02-15T12:58:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-02-25T12:12:40.000Z (over 10 years ago)
- Last Synced: 2024-10-18T22:08:24.750Z (28 days ago)
- Language: Ruby
- Homepage: http://rubygems.org/gems/filerary
- Size: 526 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Filerary [](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
```
### Show a file content
```bash
$ filerary show PATH
```
### Update the collection
```bash
$ filerary update
```
### Remove deleted files in the collection
```bash
$ filerary cleanup
```
### Remove a file in the collection
```bash
$ filerary remove PATH
```
### Delete the database and the collection
```bash
$ filerary destroy
```
## Authors
* Masafumi Yokoyama ``
## 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