github.com/yieldbot/ferret/assets

Ferret is a search engine that unifies search results from Github, Slack, Trello and more


License
MIT
Install
go get github.com/yieldbot/ferret/assets

Documentation

Ferret

Build Status GoDoc Release

Ferret is a search engine that unifies search results from different resources such as Github, Slack, AnswerHub and more.

Distributed knowledge and avoiding context switching are very important for efficiency. Ferret provides a unified search interface for retrieving and accessing to information with minimal effort.

IT'S STILL UNDER DEVELOPMENT

Installation

OSX Linux Win
64bit 64bit 64bit

See for building from source.

Usage

Make sure Ferret is configured properly before use it.

Help

./ferret -h

Search Github

./ferret search github intent
./ferret search github intent+extension:md

See for more Github search syntax.

Search Slack

./ferret search slack "meeting minutes"

Search AnswerHub

./ferret search answerhub vpn

Opening search results

# search for alerting on Github
./ferret search github alerting

# go to the second search result
./ferret search github alerting --goto 2

Configuration

Keep environment files in ~/.bash_profile file for persistence.

Global Configuration

  • FERRET_GOTO_CMD: The command for opening links. This command is used for --goto argument. (i.e. ferret search PROVIDER KEYWORD --goto #1). Default is open

Providers Configurations

Each search provider needs set of environment variables for operating. You can define environment variables for one or more search provider.

Github

See for getting an access token and set following environment variables;

  • FERRET_GITHUB_URL (i.e. https://api.github.com/)
  • FERRET_GITHUB_TOKEN
  • FERRET_GITHUB_SEARCH_USER (optional)
Slack

See for getting an access token and set following environment variables;

  • FERRET_SLACK_TOKEN
AnswerHub

See for enabling the REST API and set following environment variables;

  • FERRET_ANSWERHUB_URL (i.e. https://answerhub.example.com/)
  • FERRET_ANSWERHUB_USERNAME (see My Preferences->Authentication Modes in AnswerHub site)
  • FERRET_ANSWERHUB_PASSWORD (see My Preferences->Authentication Modes in AnswerHub site)

Building from source

go get -u -v github.com/yieldbot/ferret
cd $GOPATH/src/github.com/yieldbot/ferret
go build

License

Licensed under The MIT License (MIT)
For the full copyright and license information, please view the LICENSE.txt file.