BORG - A terminal based search engine for bash snippets

Borg was built out of the frustration of having to leave the terminal to search for bash snippets.

Search

borg "find all txt"

(1) Find and delete .txt files in bash
        [a] find . -name "*.txt" | xargs rm
        [b] find . -name "*.txt" -exec rm {} \;
        [c] $ find  . -name "*.txt" -type f -delete

(2) bash loop through all find recursively in sub-directories
        [a] FILES=$(find public_html -type f -name '*.php')
        [b] FILES=`find public_html -type d`

Add

First obtain an oauth token by loggin in with github at ok-b.org.

borg login my3XamPleT0k3n

You are ready to save your own content

borg new

A vim window opens and lets you save your snippet. For example:

How to grep for a file in current directory

ls | grep mySearchTerm

Save and exit vim.

Edit

Using our search example, typing borg edit 1 will present you with an editor window containing:

Find and delete .txt files in bash
 
[a]
find . -name "*.txt" | xargs rm

[b]
find . -name "*.txt" -exec rm {} \;

[c]
10 $ find  . -name "*.txt" -type f -delete

Let's say you want to remove the second snippet because your don't like it. Modify it so it becomes:

Find and delete .txt files in bash
 
[a]
find . -name "*.txt" | xargs rm

[c]
10 $ find  . -name "*.txt" -type f -delete

Save and exit.

(Do not care about the incorrect alphabetical order, it's ok)

Install

The following releases only let you search, to use add/edit install from source, releases are coming soon.

brew install borg

For linux, download a release manually releases

wget https://github.com/crufter/borg/releases/download/v0.0.1/borg_linux_amd64 -O /usr/local/bin/borg
chmod 755 /usr/local/bin/borg

Or download a release manually for Mac:

wget https://github.com/crufter/borg/releases/download/v0.0.1/borg_darwin_amd64 -O /usr/local/bin/borg
chmod 755 /usr/local/bin/borg

Rate results: `worked`

When you see a result that worked for you, you can use the worked command to give feedback:

borg worked 12

Once you do this the result will rank higher for similar queries - it is especially useful if you find a good result that you think are too down in the result list.

Who can add/edit what?

Any logged in user can edit any content. We trust you with not being a vandal.

Can borg be mine and only mine?

The client connects to a server at borg.crufter.com, but you can host your own if you want to (see daemon folder).

Self hosting will become less appealing once people start contributing their own content to the database though.

Explanation for ui

() denotes hits for your query
[] denotes snippets found for a given query
... under a [] means more lines to display (use the -f flag for full display, see more about usage below)

Usage

Borg supports gnu flags, so flags are supported both before and after the arguments, so all of the followings are valid:

borg -l 30 -f "md5 Mac"
borg "md5 Mac" -l30 -f
borg -f "md5 Mac" -l30

But what do they do?

-f  (= false)
    Print full results, ie. no more '...'
-h (= "borg.crufter.com")
    Server to connect to
-l  (= 5)
    Result list limit. Defaults to 5
-p  (= false)
    Private search. Your search won't leave a trace. Pinky promise. Don't use this all the time if you want to see the search result relevancy improved

Credits

The borg mascot has been delivered to you by the amazing Fabricio Rosa Marques.

Community:

Running with docker

You can use the dockerized borg client if you don't want to install anything on your host!

anas10/borg