Installation

rolod0x in Chrome Web Store Download for Chrome rolod0x for Firefox Download for Firefox

The Chrome download link above should also work for other browsers in the Chrome family, such as Chromium and Brave.

However, if you want to install directly from GitHub, read on!

Table of contents

Downloads from GitHub

You can download a .zip file from one of three places:

  1. Go to the releases page, pick a recent release, and then look for an asset named something like rolod0x-v1.4.0-chrome.zip at the Assets section at the bottom of the release page.

  2. View the list of recent builds of the main branch. Click on the latest, or another recent one, then scroll down to the bottom of the page and download the relevant artifact .zip file, which will be called rolodox-main-firefox or similar.

  3. Go to the zip workflow page, and pick any recent build. This is especially useful if you want to test a particular pull request which is still in development (e.g. for a bug fix or new feature). Then download the artifact in the same way as in step 2.

Then unpack the .zip file into a fresh folder anywhere on your machine, remembering the location.

Then follow the relevant installation steps below for your browser:

Installation from GitHub in Chrome

This should also work for other browsers in the Chrome family, such as Chromium and Brave.

  1. Open <chrome://extensions> in your browser.
  2. Enable Developer mode at the top right.
  3. Click Load unpacked at the top left.
  4. Select the folder you just unpacked.

Upgrading an existing GitHub installation in Chrome

Obviously you can uninstall the existing installation and do a fresh install, but that may lose all your config. So the following is probably better:

  1. Download and unpack the new version in exactly the same place.
  2. Open <chrome://extensions> in your browser.
  3. Click the reload icon near the bottom right of the rolod0x extension card.

Installation from GitHub in Firefox

N.B. Firefox support has not been heavily tested yet! However the core functionality is working fine. Please try it out and report bugs. After following the download instructions above, take the following steps:

  1. Open about:debugging#/runtime/this-firefox in your browser.
  2. Click Load Temporary Add-on....
  3. Select manifest.json from the folder you just unpacked.

Please note that in Firefox when you add plugin in temporary mode, that means it will disappear after closing the browser, so you have to do it again on next launch.

Installation from source

See the developer guide.

Any pull request providing an enhancement or bugfix is extremely welcome!

Installation of the command-line utility

For now this requires building from source as per above. Once you have done pnpm install then in theory it should be enough to run:

pnpm link --global

and this should install a rolod0x executable within a pnpm-controlled directory on your $PATH. However, it seems that pnpm still has issues installing scripts in some cases, so if you run into problems with this, please follow the guidelines in CONTRIBUTING.md.