Skip to content
Host application for the Bukubrow WebExtension
Rust Makefile
Branch: master
Clone or download
Latest commit 461b28e Jul 14, 2019

README.md

Bukubrow Host

Bukubrow is a WebExtension for Buku, a command-line bookmark manager. This is the corresponding host that facilitates interfacing with the Buku database via native messaging.

USAGE:
    bukubrow [FLAGS] [OPTIONS]

FLAGS:
        --install-chrome      Install the native messaging host for Chrome.
        --install-chromium    Install the native messaging host for Chromium.
        --install-firefox     Install the native messaging host for Firefox.
    -h, --help                Prints help information
    -l, --list                Print all bookmarks in a list to stdout.
    -V, --version             Prints version information

OPTIONS:
    -o, --open <ID[,ID]>    Open bookmark(s) in the browser by ID.

Prerequisites

  • Buku
  • Bukubrow WebExtension
  • If building the host:
    • Rust / Cargo

Installation

Installing the host and registering it with your browser is required to allow the browser extension to talk to Buku.

If you've installed the host from the AUR, skip to step 4.

If you've downloaded a host zip from the releases page, skip to step 3.

  1. Clone the repo.
  2. Run make build-linux-x64 (Linux) or make build-darwin-x64 (macOS). Note that you'll need your target platform installed and configured with Cargo. Your zip file will be located within the ./release/ directory.
  3. Extract the zip file and move the executable to a suitable location, for example /usr/local/bin/.
  4. Install the host file for your browser via the executable:
    • bukubrow --install-firefox
    • bukubrow --install-chromium
    • bukubrow --install-chrome

Further options can be viewed with bukubrow --help.

Contributing

The host is written in Rust stable. The messages it expects to receive from the WebExtension follow a faux HTTP format; for instance, to get all the bookmarks, you pass it a JSON object of the following format: { "method": "GET" }.

You can’t perform that action at this time.