Skip to main content

Braindrop

Braindrop

GitHub Actions Workflow Status GitHub commits since latest release GitHub Issues or Pull Requests GitHub Release Date PyPI - License PyPI - Python Version PyPI - Version

Introduction

Braindrop is a terminal-based client application for the raindrop.io bookmarking service. It provides the ability to manage and search your bookmarks in the terminal.

Braindrop is and generally always will be fairly opinionated about the "best" way to make use of Raindrop (AKA how I like to use it); but where possible I want to keep it quite general so it will be useful to anyone.

[!NOTE] Braindrop isn't designed as a thin client for the Raindrop API; it isn't a terminal-based browser that does all the work on the server. It is designed to download your data if it looks like it's newer on the server, and then work locally, sending updates back to the server.

If you have a huge Raindrop collection then this might not be the tool for you.

Installing

pipx

The package can be installed using pipx:

$ pipx install braindrop

Once installed run the braindrop command.

uv

The package can be install using uv:

uv tool install --python 3.13 braindrop

If you don't have uv installed you can use uvx.sh to perform the installation. For GNU/Linux or macOS or similar:

curl -LsSf uvx.sh/braindrop/install.sh | sh

or on Windows:

powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/braindrop/install.ps1 | iex"

Once installed run the braindrop command.

Getting started

Braindrop only works if you have a raindrop.io account; there is a perfectly usable free tier. If you don't have an account, go get one first.

To use Braindrop you will need an API access token. You can generate one in your account settings, under Integrations. In Integrations:

  • Look for the For Developers section
  • Click on Create new app
  • Enter a name for the new app (call it Braindrop for example, so you know what you're using it for).
  • Accept the API use terms and guidelines and press Create
  • Click on the freshly-created application in the list
  • Near the bottom of the dialog that appears, click on Create test token and say OK.
  • Copy the test token to your clipboard (or don't worry if you misplace it, you can always come back here to get it again).

Having done the above, when you run up Braindrop the first time it will ask for this token:

Raindrop API token entry dialog

Paste the token into the input field and select Connect. Braindrop will then download your data and you will be good to go.

NOTE: if it's your preference, you can set the token in an environment variable called BRAINDROP_API_TOKEN.

Using Braindrop

The best way to get to know Braindrop is to read the help screen, once in the main application you can see this by pressing F1.

Braindrop help

File locations

Braindrop stores files in a braindrop directory within both $XDG_DATA_HOME and $XDG_CONFIG_HOME. If you wish to fully remove anything to do with Braindrop you will need to remove those directories too.

Expanding for the common locations, the files normally created are:

  • ~/.config/braindrop/configuration.json -- The configuration file.
  • ~/.local/share/braindrop/.token -- The file that holds your API token.
  • ~/.local/share/braindrop/raindrops.json -- The locally-held Raindrop data.

Getting help

If you need help, or have any ideas, please feel free to raise an issue or start a discussion.

TODO

See the TODO tag in issues to see what I'm planning.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

braindrop-1.1.1.tar.gz (44.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

braindrop-1.1.1-py3-none-any.whl (64.4 kB view details)

Uploaded Python 3

File details

Details for the file braindrop-1.1.1.tar.gz.

File metadata

  • Download URL: braindrop-1.1.1.tar.gz
  • Upload date:
  • Size: 44.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for braindrop-1.1.1.tar.gz
Algorithm Hash digest
SHA256 b1361ba851330a757365e659158c911d620847389f5b44b4756f55a0abc5ce13
MD5 c6a4afa056bf7ce320de143fac87575b
BLAKE2b-256 0e431eda3b7efd30c53ff6c837fff71a71706fa290255190aa7d3abc142eaf00

See more details on using hashes here.

File details

Details for the file braindrop-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: braindrop-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 64.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for braindrop-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 99fa62a157c2ce80424d2ae78a1ef0dd3c58043edd4d9b975cb364bb460c2792
MD5 189765c8fbb78603a8774513fb6581c8
BLAKE2b-256 cfef2c6fd0bc91248410957908c0e5f4cd05c7482fd8f4c76ca3f077eb20acc8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page