Skip to content

davep/tinboard

Repository files navigation

Tinboard

Tinboard

Introduction

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

Installing

pipx

The package can be installed using pipx:

$ pipx install tinboard

Once installed run the tinboard command.

Homebrew

The package is available via Homebrew. Use the following commands to install:

$ brew tap davep/homebrew
$ brew install tinboard

Once installed run the tinboard command.

Getting started

To use Tinboard you will need a Pinboard account (this application isn't going to be useful to anyone who isn't a Pinboard user). Assuming you do have a Pinboard account, you can get going by running up tinboard and providing your API token when asked:

The Tinboard token input dialog

If you're not sure where to find your API token, just press F1, or the Go to token button, and you'll be taken to the relevant Pinboard page in your browser; copy the token, come back to this dialog and paste it in.

Once done Tinboard will download your bookmarks and you're good to go!

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

Using Tinboard

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

Tinboard Help

Quick add on the command line

Tinboard has a (currently experimental) quick inline add feature. If you run:

$ tinboard add

an inline version of the bookmark editor will be shown in your terminal, allowing you to quickly add a bookmark and then carry on without running up the full application.

Getting help

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

TODO

Things I'm considering adding or addressing:

  • Double-check the rate limits on the API calls to be sure they're correct.
  • A bookmark export facility.
  • A bookmark availability checker.
    • Check the current bookmark.
    • A mode that slowly checks all bookmarks.
  • Support for Pinboard Notes.
  • Optionally sort the tags by count.