twbm 0.6.0

CLI bookmark manager based on buku

twbm: Bookmarks via Commandline (CLI)

Inspired by https://github.com/jarun/buku.

Why not just use it directly?

• better full-text search.
• check tags for consistency when adding new bookmark
• alphabetical ordering of deep search results
• no tools like bukuserver, only CLI

If you are happy using buku, by all means stick with it. It is battle tested.

twbm is 100% buku compatible.
Switch back and forth between twbm and buku is possible without data loss.

To harness twbm's power, use correct FTS search syntax (see: https://www.sqlite.org/fts5.html chapter 3).

Usage

Two complementary commands are provided:

1. twbm: CLI tool with FTS for bookmark management
2. twbuku: plain buku with small enhancements and usage of an enhanced database

This allows to use the battle-tested buku interface where applicable and benefit from additional features while using one enhanced bookmark database.

Getting help: twbm --help

Examples

# FTS examples (https://www.sqlite.org/fts5.htm)
twbm search 'security "single-page"'
twbm search '"https://securit" *'
twbm search '^security'
twbm search 'postgres OR sqlite'
twbm search 'security NOT keycloak'

# FTS combined with tag filtering
twbm search -t tag1,tag2 -n notag1 <searchquery>

# Match exact taglist
twbm search -e tag1,tag2

# Search -> select interactively -> pipe bookmark id downstream for processing
twbm search xxxxx | twbm update -t x

Taglists must not have blanks and have comma separator.

Selection of multiple bookmarks for opening in browser is possible, of course:

After selecting you are straight back at the bash prompt.

Installation

pipx twbm

Database schema upgrade:

• To upgrade existing buku-db: twbm-upgrade-db.sh buku.db twbm.db.
• To downgrade twbm-db: twbm-downgrade-db.sh twbm.db buku.db.

All transactions do not affect existing databases.

Tested configuration:

• sqlite 3.28.0 (requires update on macOS)
• macOS 10.15.7

Configuration

Location of sqlite database:

# aliases which I use
alias b="twbuku --db $HOME/bm.db -n 1000 --deep"  # using patched original buku

alias bb="TWBM_DB_URL=sqlite:////$HOME/bm.db twbm search"  # using extended CLI tool
alias bbb="TWBM_DB_URL=sqlite:////$HOME/bm.db twbm"

Architecture

twbm uses a few buku functions in the background, but is generally rebuilt on top of:

• Typer
• Pydantic
• SQLite FTS5
• aiosql
• SQLAlchemy
• alembic

This should make it easy to extend and add functionality in an object-oriented manner.

Development

patch buku

• download buku and compare with buku.py
• update buku.py: # tw: add title tagging (customization: search for # tw)
• GOTCHA: Exclude buku.py from black

rm buku
wget https://raw.githubusercontent.com/jarun/buku/master/buku .
diff buku.py buku

Local installation from sources

• install twbm with pipx for local development: pipx install ~/dev/py/twbm, via make install
• uninstall: pipx uninstall twbm # GOTCHA: NOT THE PATH !!!!

Testing

make test

Roadmap

• tbd