https://github.com/rubiojr/goin

goin fork: https://bitbucket.org/zaphar/goin
https://github.com/rubiojr/goin

bleve go indexing pdf

Last synced: about 2 months ago
JSON representation

goin fork: https://bitbucket.org/zaphar/goin

• Host: GitHub
• URL: https://github.com/rubiojr/goin
• Owner: rubiojr
• License: artistic-2.0
• Created: 2017-05-14T14:13:05.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-20T13:15:13.000Z (over 4 years ago)
• Last Synced: 2024-04-14T17:10:27.257Z (6 months ago)
• Topics: bleve, go, indexing, pdf
• Language: Go
• Homepage:
• Size: 2.14 MB
• Stars: 6
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**Jeremy Wall's goin fork with some fixes**

* Audio file indexing

* Some extra flags for the CLI

* Less verbose output

goin has a few dependencies that you should install manually, see [INSTALL_MACOS](INSTALL_MACOS.md) for macOS.

See the original repo here: https://bitbucket.org/zaphar/goin

Goin Full Text Search for your files

====================================

Goin is a full text search indexer using

https://github.com/blevesearch/bleve for your files on disk. It can

handle plain text, many different images, as well as pdf files if the

correct utilities are installed.

It processes files based on their mime type making it fairly easy to

add support for more files in the future. It's still very much a work

in progress.

Usage

=====

Indexing:

`goin --index file.txt /path/to/directory/ another.file /another/directory`

Querying:

`goin --query +word -word \"phrase made up of multiple words\" field:word`

Full details of the query syntax can be found at: https://github.com/blevesearch/bleve/wiki/Query%20String%20Query

Help:

`goin --help` will give you an overview of the flags to tweak it's operation.

Install

=======

Dependencies

------------

goin depends on the (leptonica):"http://www.leptonica.com" and (tesseract):"https://github.com/tesseract-ocr" libraries to build.

You'll also need ghostscript (gs command) installed.

Depending on how you install them you may have to set the CGO_CFLAGS and CGO_LDFLAGS environment variables to tell cgo where to find them.

`go doc cmd/go` will give you more information on configuring cgo for your environment.

For pdf support goin needs a few extra items. The (ImageMagick):"http://www.imagemagick.org/" convert tool as well as the (xpdf):http://www.foolabs.com/xpdf/" suite of tools. 

Goin uses these first to try to get text out of the pdf and falling back to OCR if the pdf is only images.

Installing goin

------------------

`go get bitbucket.org/zaphar/goin` will install the tool.