borg

command module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2016 License: Apache-2.0 Imports: 4 Imported by: 0

README

BORG - A terminal based search engine for bash snippets

cruft guaranteed Travis CI Go Report Card Slack Status

Borg was built out of the frustration of having to leave the terminal to search and click around for bash snippets. Borg's succint output also makes it easy to glance over multiple snippets quickly.

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`
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.

Advanced usage

For more commands and their explanations, please see advanced usage

How does borg work?

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)
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!

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL