How to install borg on Linux?

You can install borg on Linux by manually downloading a release from GitHub, such as using wget to get the binary and setting permissions with chmod, as shown in the README. Note that pre-built binaries only allow searching, not editing snippets.

Borg vs tldr – which is better for shell snippets?

Borg focuses on community-curated snippets with a terminal-native interface and self-hosting, while tldr is a simpler, client-side tool with pre-built cheat sheets. Choose Borg if you value community feedback and self-hosting, but be aware of its current hosted service issues.

Can I host my own borg server?

Yes, Borg supports self-hosting by running your own server, as mentioned in the daemon folder of the repository. This gives you full control over the database, but the README cautions it might be less appealing as the community version grows.

Why is the borg website down?

The official Borg website (ok-b.org) is down because the maintainer didn't have time to maintain it, as stated in the README. There are plans to resurrect it on 1backend in a few months, but currently, self-hosting is the reliable alternative.

How to add a new snippet to borg?

To add or edit snippets, you need to install Borg from source, as pre-built releases don't support this. Contribute by tweaking existing snippets or adding your own through the GitHub repository, which helps expand the community knowledge base.

Does borg work offline?

Borg requires a connection to a server (either the hosted one or self-hosted) to search snippets. If the server is offline, it won't function, so self-hosting on a local network can provide offline access, but the default hosted service is currently down.

Open-Awesome

borg

Apache-2.0Gov0.0.3

Search and save shell snippets directly from your terminal without switching to a browser.

GitHub

1.6k stars55 forks0 contributors

What is borg?

Borg is a command-line utility that allows developers to search and save shell snippets without leaving their terminal. It solves the problem of constantly switching to a browser to look up bash commands by providing a fast, in-terminal searchable database of community-contributed snippets.

Target Audience

Developers, sysadmins, and power users who frequently work in the terminal and want quick access to shell command examples without disrupting their workflow.

Value Proposition

Borg offers a streamlined, terminal-native experience for discovering and sharing shell knowledge, with the ability to self-host and a voting system that surfaces the most helpful snippets based on real user feedback.

Overview

Search and save shell snippets without leaving your terminal

Use Cases

Best For

Quickly finding bash one-liners for common tasks
Building a personal or team knowledge base of shell commands
Reducing context switching when working in the terminal
Learning shell scripting through practical examples
Self-hosting a private snippet repository for internal use
Rating and curating the most effective shell snippets

Not Ideal For

Teams needing a guaranteed, always-online hosted service without self-hosting maintenance
Users who require full snippet editing capabilities with pre-built binaries, not source compilation
Projects demanding advanced snippet organization like tagging, categories, or GUI management

Pros & Cons

Pros

Terminal-Native Search

Borg allows querying shell snippets directly from the command line with succinct output, minimizing workflow disruption, as designed to avoid leaving the terminal for bash commands.

Community Curation System

The `worked` command lets users upvote helpful snippets, improving search rankings based on real feedback, fostering a shared knowledge base that surfaces the best results.

Piping Flexibility

Supports piping search results to tools like `less` for easier browsing, mentioned in the README with `borg pipeto less`, enhancing usability for long outputs.

Self-Hosting Option

Offers the ability to run your own Borg server for full control over the snippet database, enabling private or customized setups, though the README notes it might become less appealing as community content grows.

Cons

Unreliable Hosted Service

The official hosted website (ok-b.org) is down due to lack of maintainer time, forcing users to self-host or wait for a planned resurrection, which limits out-of-the-box usability.

Limited Release Functionality

Pre-built releases only support searching snippets; adding or editing requires installing from source, as stated in the README, making it inconvenient for casual users.

Dependent on Community Activity

The snippet database relies on user contributions, and with the hosted service down, content may be stagnant or incomplete, reducing search effectiveness for niche commands.

Frequently Asked Questions

Related Projects

croc

Easily and securely send things from one computer to another :crocodile: :package:

Fast, secure, efficient backup program

Stars35,923

Forks1,869

Last commit7 days ago

gor

GoReplay is an open-source tool for capturing and replaying live HTTP traffic into a test environment in order to continuously test your system with real data. It can be used to increase confidence in code deployments, configuration changes and infrastructure changes.

Stars19,319

Forks96

Last commit7 months ago

JuiceFS

JuiceFS is a distributed POSIX file system built on top of Redis and S3.

Stars14,400

Forks1,284