CLI bookmark manager based on buku
Project description
twbm: Bookmarks via Commandline (CLI)
Inspired by https://github.com/jarun/buku.
Why not just use it directly?
- I am looking for better full-text search.
- I use tags extensively and want them to be checked during bookmark input for consistency.
- I struggle a bit with buku's user interface, getting the format right, remember the flags, ...
- I wanted some additional functionality, e.g. alphabetical ordering of
deep
results... - I do not need tools like bukuserver, after all it's about the command line.
If you are happy using buku, by all means stick with it. It is a great piece of OSS.
However, there is no risk in trying twbm. twbm is 100% buku compatible.
If you do not like it you can migrate back without loosing your bookmark database.
To harness twbm
's power, you should use the correct FTS search syntax (see: https://www.sqlite.org/fts5.html chapter 3).
I did not make efforts to sanitize incorrect user input (see examples).
If you find a bug, please open an issue.
Usage
There are two complementary commands:
- twbm: CLI tool with FTS for bookmark management
- 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
# Bulk update of tags using bash piping
echo 1 2 | twbm update -t x
# FTS examples (https://www.sqlite.org/fts5.htm)
twbm 'security "single-page"'
twbm '"https://securit" *'
twbm '^security'
twbm 'postgres OR sqlite'
twbm 'security NOT keycloak'
# FTS combined with tag filtering
twbm -t tag1,tag2 -n notag1 <searchquery>
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
The database schema needs to be upgraded to allow for FTS indexing:
- To upgrade your existing buku db:
twbm-upgrade-db.sh buku.db twbm.db
. - To downgrade your existing twbm db:
twbm-downgrade-db.sh twbm.db buku.db
.
You can downgrade any time.
Configuration
Configure the location of your 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 certain buku
functions in the background, but is generally rebuilt on top of:
This should make it easy to extend and add functionality in an object-oriented manner.
Development
patch buku
- download
buku
and compare withbuku.py
- update
buku.py
:# tw: add title tagging
(customization: search for# tw
) - GOTCHA: Exclude
buku.py
fromblack
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
, viamake install
- uninstall:
pipx uninstall twbm
# GOTCHA: NOT THE PATH !!!!
Testing
make test
Roadmap
- allow piping between twbm:
bb <word> | bb -t newtag
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.