2016-04-22 16:11:16 -05:00
< h1 align = "center" > Buku< / h1 >
2015-11-10 01:15:35 -06:00
2016-04-23 00:46:27 -05:00
< p align = "center" >
2017-03-12 23:31:35 -05:00
< a href = "https://github.com/jarun/Buku/releases/latest" > < img src = "https://img.shields.io/github/release/jarun/buku.svg?maxAge=600" alt = "Latest release" / > < / a >
< a href = "https://aur.archlinux.org/packages/buku" > < img src = "https://img.shields.io/aur/version/buku.svg?maxAge=600" alt = "AUR" / > < / a >
2017-12-02 10:57:12 -06:00
< a href = "http://formulae.brew.sh/formula/buku" > < img src = "https://img.shields.io/homebrew/v/buku.svg?maxAge=600" alt = "Homebrew" / > < / a >
2017-03-12 23:31:35 -05:00
< a href = "https://pypi.python.org/pypi/buku" > < img src = "https://img.shields.io/pypi/v/buku.svg?maxAge=600" alt = "PyPI" / > < / a >
2017-11-21 10:05:12 -06:00
< a href = "https://packages.debian.org/search?keywords=buku&searchon=names&exact=1" > < img src = "https://img.shields.io/badge/debian-9+-blue.svg?maxAge=2592000" alt = "Debian Stretch+" / > < / a >
2018-03-18 04:23:20 -05:00
< a href = "https://apps.fedoraproject.org/packages/buku" > < img src = "https://img.shields.io/badge/fedora-27+-blue.svg?maxAge=2592000" alt = "Fedora 27+" / > < / a >
2018-02-28 05:48:57 -06:00
< a href = "https://software.opensuse.org/search?q=buku" > < img src = "https://img.shields.io/badge/opensuse%20leap-15.0+-blue.svg?maxAge=2592000" alt = "openSUSE Leap 15.0+" / > < / a >
2017-09-23 12:49:26 -05:00
< a href = "https://packages.ubuntu.com/search?keywords=buku&searchon=names&exact=1" > < img src = "https://img.shields.io/badge/ubuntu-17.04+-blue.svg?maxAge=2592000" alt = "Ubuntu Zesty+" / > < / a >
2017-09-23 11:49:31 -05:00
< / p >
< p align = "center" >
2016-04-26 03:36:14 -05:00
< a href = "https://github.com/jarun/buku/blob/master/LICENSE" > < img src = "https://img.shields.io/badge/license-GPLv3-yellow.svg?maxAge=2592000" alt = "License" / > < / a >
2017-09-09 17:13:58 -05:00
< a href = "http://buku.readthedocs.io/en/latest/?badge=latest" > < img src = "https://readthedocs.org/projects/buku/badge/?version=latest" alt = "Docs Status" / > < / a >
2016-06-03 19:32:38 -05:00
< a href = "https://travis-ci.org/jarun/Buku" > < img src = "https://travis-ci.org/jarun/Buku.svg?branch=master" alt = "Build Status" / > < / a >
2016-04-23 00:46:27 -05:00
< / p >
2016-04-22 16:11:16 -05:00
< p align = "center" >
2018-04-25 14:34:20 -05:00
< a href = "https://asciinema.org/a/137065" > < img src = "https://asciinema.org/a/137065.png" alt = "Buku in action!" width = "734" / > < / a >
2016-04-22 16:11:16 -05:00
< / p >
2015-11-10 01:15:35 -06:00
2017-09-10 13:31:47 -05:00
< p align = "center" > < i > Buku in action!< / i > < / p >
2017-03-29 02:07:43 -05:00
### Introduction
2017-03-12 23:31:35 -05:00
2018-05-07 09:03:41 -05:00
`buku` is a powerful bookmark manager written in Python3 and SQLite3. When I started writing it, I couldn't find a flexible cmdline solution with a private, portable, merge-able database along with seamless GUI integration. Hence, `Buku` (after my son's nickname, meaning *close to the heart* in my language).
2017-03-12 23:31:35 -05:00
2018-05-25 22:59:34 -05:00
`buku` fetches the title of a bookmarked url and stores it along with any user-provided comments and tags. You can use your favourite editor to compose and update bookmarks. With multiple search options, including regex and a deep scan mode (particularly for URLs), it can find any bookmark instantly. Multiple search results can be opened in the browser at once. `buku` can look up the latest snapshot of a broken link on the Wayback Machine. There's an Easter egg to revisit random forgotten bookmarks too!
2017-03-12 23:31:35 -05:00
2018-03-29 08:35:55 -05:00
For GUI and browser integration (or to sync bookmarks with your favourite bookmark management service), refer to the wiki page on [System integration ](https://github.com/jarun/Buku/wiki/System-integration ). If you prefer the terminal, the [shell completion ](#shell-completion ) scripts can be handy.
2017-03-12 23:31:35 -05:00
2018-04-21 07:43:11 -05:00
[bukuserver ](https://github.com/jarun/Buku/tree/master/bukuserver ) exposes a browsable frontend on a local webhost server.
2018-03-29 08:35:55 -05:00
We have one of the best documentation around. You can start with the [Examples ](#examples ). *Buku* is too busy to track you - no hidden history, obsolete records, usage analytics or homing. For more details, please refer to the wiki page on [operational notes ](https://github.com/jarun/Buku/wiki/Operational-notes ).
2017-03-29 02:07:43 -05:00
2017-09-29 02:13:54 -05:00
There are several [projects based on `buku` ](#related-projects ), including a browser plug-in.
2017-03-12 23:31:35 -05:00
2018-04-20 20:06:30 -05:00
Missing a feature? There's a rolling [ToDo List ](https://github.com/jarun/Buku/issues/268 ) with identified tasks. Contributions are welcome! Please follow the [PR guidelines ](https://github.com/jarun/Buku/wiki/PR-guidelines ).
2017-03-12 23:31:35 -05:00
2017-12-09 00:46:32 -06:00
*Love smart and efficient terminal utilities? Explore my repositories. Buy me a cup of coffee if they help you.*
2017-05-07 02:42:25 -05:00
< p align = "center" >
< a href = "https://saythanks.io/to/jarun" > < img src = "https://img.shields.io/badge/say-thanks!-ff69b4.svg" / > < / a >
2018-01-09 07:42:39 -06:00
< a href = "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q" > < img src = "https://img.shields.io/badge/PayPal-donate-green.svg" alt = "Donate via PayPal!" / > < / a >
2017-03-12 23:31:35 -05:00
< / p >
2017-08-18 07:28:26 -05:00
### Table of Contents
- [Features ](#features )
- [Installation ](#installation )
- [Dependencies ](#dependencies )
- [From a package manager ](#from-a-package-manager )
- [Release packages ](#release-packages )
- [From source ](#from-source )
- [Running standalone ](#running-standalone )
- [Shell completion ](#shell-completion )
- [Usage ](#usage )
2017-08-24 16:46:54 -05:00
- [Cmdline options ](#cmdline-options )
- [Colors ](#colors )
2017-08-18 07:28:26 -05:00
- [Examples ](#examples )
2017-09-18 19:25:22 -05:00
- [Troubleshooting ](#troubleshooting )
- [Editor integration ](#editor-integration )
2017-08-18 07:28:26 -05:00
- [Collaborators ](#collaborators )
- [Related projects ](#related-projects )
- [In the Press ](#in-the-press )
2017-03-29 02:07:43 -05:00
### Features
2016-09-05 11:27:11 -05:00
2017-08-22 17:09:43 -05:00
- Lightweight, clean interface, custom colors
2017-08-14 23:36:29 -05:00
- Text editor integration
2017-08-13 04:03:06 -05:00
- Fetch, edit page title; add tags and notes
2017-08-14 23:36:29 -05:00
- Powerful search modes (regex, substring...)
- Continuous search with on the fly mode switch
2016-12-30 04:35:12 -06:00
- Open bookmarks and search results in browser
2017-08-13 04:03:06 -05:00
- Manual encryption support
2017-11-06 19:26:56 -06:00
- Auto-import from Firefox, Google Chrome and Chromium
2018-05-10 20:16:47 -05:00
- Import/export bookmarks from/to HTML, Markdown or Orgfile
2018-05-25 11:39:12 -05:00
- Shorten, expand URLs, browse cached page from Wayback Machine
2017-08-13 04:03:06 -05:00
- Smart tag management using redirection (>>, >, << )
2016-12-30 04:35:12 -06:00
- Portable, merge-able database to sync between systems
2017-03-12 23:31:35 -05:00
- Multithreaded full DB refresh
2017-08-12 23:26:39 -05:00
- Shell completion scripts, man page with handy examples
2016-09-05 11:27:11 -05:00
2017-03-29 02:07:43 -05:00
### Installation
2016-05-23 04:02:46 -05:00
2017-03-29 02:07:43 -05:00
#### Dependencies
2016-05-23 04:02:46 -05:00
2017-03-12 23:31:35 -05:00
| Feature | Dependency |
| --- | --- |
2017-12-02 10:04:58 -06:00
| Scripting language | Python 3.4+ |
2017-03-12 23:31:35 -05:00
| HTTP(S) | urllib3 |
| Encryption | cryptography |
| Import browser exported html | beautifulsoup4 |
2015-11-08 16:04:49 -06:00
2017-03-16 22:05:27 -05:00
To install package dependencies using pip3, run:
2016-05-28 08:36:09 -05:00
2018-03-28 08:42:50 -05:00
# pip3 install urllib3 cryptography beautifulsoup4
2016-02-28 08:11:27 -06:00
or on Ubuntu:
2018-03-28 08:42:50 -05:00
# apt-get install python3-urllib3 python3-cryptography python3-bs4
2016-05-23 04:02:46 -05:00
2018-02-10 17:51:36 -06:00
To copy url to clipboard at the prompt, `Buku` uses `xsel` on Linux, `pbcopy` (default installed) on OS X and `clip` (default installed) on Windows.
2017-08-13 18:54:16 -05:00
#### From a package manager
2017-03-16 22:05:27 -05:00
2018-03-28 08:42:50 -05:00
- [AUR ](https://aur.archlinux.org/packages/buku/ ) (`pacman -S buku`)
- [Debian ](https://packages.debian.org/search?keywords=buku&searchon=names&exact=1 ) (`apt-get install buku`)
2018-03-18 04:23:20 -05:00
- [Fedora ](https://apps.fedoraproject.org/packages/buku ) (`dnf install buku`)
2017-11-22 05:06:54 -06:00
- [FreeBSD ](https://www.freshports.org/www/py-buku/ ) (`pkg install www/py-buku`)
2018-02-23 18:00:51 -06:00
- [Gentoo ](https://packages.gentoo.org/packages/www-misc/buku ) (`emerge buku`)
2018-03-28 08:42:50 -05:00
- [Homebrew ](http://formulae.brew.sh/formula/buku ) (`brew install buku`)
- [NixOS ](https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/misc/buku ) (`nix-env -i buku`)
2018-02-03 06:47:38 -06:00
- [OpenBSD ](https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/www/buku/ ) (`pkg_add buku`)
2018-03-28 08:42:50 -05:00
- [openSUSE ](https://software.opensuse.org/search?q=buku ) (`zypper in python3-buku`)
- [PyPi ](https://pypi.python.org/pypi/buku/ ) (`pip3 install buku`)
- [Ubuntu ](https://packages.ubuntu.com/search?keywords=buku&searchon=names&exact=1 ) (`apt-get install buku`)
- [Ubuntu PPA ](https://launchpad.net/~twodopeshaggy/+archive/ubuntu/jarun/ ) (`apt-get install buku`)
- [Void Linux ](https://github.com/voidlinux/void-packages/tree/master/srcpkgs/buku ) (`xbps-install -S buku`)
2016-05-23 04:02:46 -05:00
2017-08-13 18:54:16 -05:00
#### Release packages
2018-01-01 07:33:17 -06:00
Packages for Arch Linux, CentOS, Debian, Fedora, openSUSE Leap and Ubuntu are available with the [latest stable release ](https://github.com/jarun/Buku/releases/latest ).
2017-11-24 17:37:04 -06:00
NOTE: CentOS may not have the python3-beautifulsoup4 package in the repos. Install it using pip3.
2017-08-13 18:54:16 -05:00
#### From source
2016-02-28 08:11:27 -06:00
2017-08-12 23:26:39 -05:00
If you have git installed, clone this repository. Otherwise download the [latest stable release ](https://github.com/jarun/Buku/releases/latest ) or [development version ](https://github.com/jarun/Buku/archive/master.zip ) (*risky*).
2016-02-28 08:11:27 -06:00
2016-05-23 04:02:46 -05:00
Install to default location (`/usr/local`):
2016-02-28 08:11:27 -06:00
2016-04-10 07:41:00 -05:00
$ sudo make install
To remove, run:
2015-11-08 16:04:49 -06:00
2016-02-28 08:11:27 -06:00
$ sudo make uninstall
2015-12-19 12:15:22 -06:00
2017-08-13 18:54:16 -05:00
`PREFIX` is supported, in case you want to install to a different location.
#### Running standalone
2016-05-23 04:02:46 -05:00
2016-02-28 08:11:27 -06:00
`buku` is a standalone utility. From the containing directory, run:
2016-11-06 12:44:44 -06:00
$ chmod +x buku.py
$ ./buku.py
2016-05-23 04:02:46 -05:00
2017-03-29 02:07:43 -05:00
### Shell completion
2016-09-11 10:24:33 -05:00
Shell completion scripts for Bash, Fish and Zsh can be found in respective subdirectories of [auto-completion/ ](https://github.com/jarun/Buku/blob/master/auto-completion ). Please refer to your shell's manual for installation instructions.
2017-03-29 02:07:43 -05:00
### Usage
2016-05-23 04:02:46 -05:00
2017-08-24 16:46:54 -05:00
#### Cmdline options
2017-01-04 10:17:02 -06:00
```
usage: buku [OPTIONS] [KEYWORD [KEYWORD ...]]
2016-03-20 14:53:57 -05:00
2018-05-10 21:30:40 -05:00
Bookmark manager like a text-based mini-web.
2016-02-28 08:11:27 -06:00
2017-01-29 07:49:47 -06:00
POSITIONAL ARGUMENTS:
KEYWORD search keywords
2017-01-04 10:17:02 -06:00
GENERAL OPTIONS:
2016-11-14 12:37:22 -06:00
-a, --add URL [tag, ...]
2016-05-18 22:24:46 -05:00
bookmark URL with comma-separated tags
2017-02-11 00:03:29 -06:00
-u, --update [...] update fields of an existing bookmark
2016-10-11 02:39:58 -05:00
accepts indices and ranges
2017-02-11 00:03:29 -06:00
refresh the title, if no edit options
if no arguments:
- update results when used with search
- otherwise refresh all titles
-w, --write [editor|index]
open editor to edit a fresh bookmark
2017-10-08 14:51:13 -05:00
edit last bookmark, if index=-1
to specify index, EDITOR must be set
2017-02-11 00:03:29 -06:00
-d, --delete [...] remove bookmarks from DB
accepts indices or a single range
if no arguments:
- delete results when used with search
- otherwise delete all bookmarks
2016-05-31 00:53:01 -05:00
-h, --help show this information and exit
2017-02-11 00:03:29 -06:00
-v, --version show the program version and exit
2016-05-21 12:29:41 -05:00
2017-01-04 10:17:02 -06:00
EDIT OPTIONS:
2017-02-11 00:03:29 -06:00
--url keyword bookmark link
--tag [+|-] [...] comma-separated tags
clear bookmark tagset, if no arguments
'+' appends to, '-' removes from tagset
2017-03-16 13:15:37 -05:00
--title [...] bookmark title; if no arguments:
2016-05-20 13:26:01 -05:00
-a: do not set title, -u: clear title
2017-03-16 22:05:27 -05:00
-c, --comment [...] notes or description of the bookmark
2017-02-11 00:03:29 -06:00
clears description, if no arguments
2016-11-12 11:06:31 -06:00
--immutable N disable title fetch from web on update
2016-11-05 17:32:03 -05:00
N=0: mutable (default), N=1: immutable
2016-04-29 13:09:39 -05:00
2017-01-04 10:17:02 -06:00
SEARCH OPTIONS:
2018-03-26 18:08:24 -05:00
-s, --sany [...] find records with ANY matching keyword
2017-01-29 07:49:47 -06:00
this is the default search option
2018-03-26 18:08:24 -05:00
-S, --sall [...] find records matching ALL the keywords
2016-11-06 08:41:45 -06:00
special keywords -
2016-11-12 11:06:31 -06:00
"blank": entries with empty title/tag
"immutable": entries with locked title
2016-11-25 12:10:25 -06:00
--deep match substrings ('pen' matches 'opens')
2018-03-26 18:08:24 -05:00
-r, --sreg expr run a regex search
2017-08-14 16:07:01 -05:00
-t, --stag [tag [,|+] ...] [- tag, ...]
search bookmarks by tags
use ',' to find entries matching ANY tag
use '+' to find entries matching ALL tags
2017-09-17 01:23:55 -05:00
excludes entries with tags after ' - '
2017-01-29 07:49:47 -06:00
list all tags, if no search keywords
2018-03-25 22:33:46 -05:00
-x, --exclude [...] omit records matching specified keywords
2017-08-14 23:36:29 -05:00
2017-01-04 10:17:02 -06:00
ENCRYPTION OPTIONS:
2017-09-17 01:23:55 -05:00
-l, --lock [N] encrypt DB in N (default 8) # iterations
-k, --unlock [N] decrypt DB in N (default 8) # iterations
2016-04-29 13:09:39 -05:00
2017-01-04 10:17:02 -06:00
POWER TOYS:
2017-11-06 19:26:56 -06:00
--ai auto-import from Firefox/Chrome/Chromium
-e, --export file export bookmarks to Firefox format html
2017-02-10 10:39:02 -06:00
export markdown, if file ends with '.md'
format: [title ](url ), 1 entry per line
2018-05-10 20:16:47 -05:00
export orgfile, if file ends with '.org'
format: *[[url][title]], 1 entry per line
2017-09-17 01:23:18 -05:00
export buku DB, if file ends with '.db'
2017-09-18 01:03:49 -05:00
use --tag to export specific tags
2017-11-06 19:26:56 -06:00
-i, --import file import bookmarks html in Firefox format
2017-02-10 10:39:02 -06:00
import markdown, if file ends with '.md'
2018-05-10 20:16:47 -05:00
import orgfile, if file ends with '.org'
2017-09-16 22:03:06 -05:00
import buku DB, if file ends with '.db'
2017-02-11 00:03:29 -06:00
-p, --print [...] show record details by indices, ranges
print all bookmarks, if no arguments
2017-03-18 14:15:26 -05:00
-n shows the last n results (like tail)
2016-11-25 12:10:25 -06:00
-f, --format N limit fields in -p or Json search output
2017-05-03 14:33:45 -05:00
N=1: URL, N=2: URL and tag, N=3: title,
2017-09-23 12:01:37 -05:00
N=4: URL, title and tag. To omit DB index,
2017-11-09 23:21:06 -06:00
use N0, e.g., 10, 20, 30, 40.
2016-11-07 11:35:02 -06:00
-j, --json Json formatted output for -p and search
2017-08-22 23:43:55 -05:00
--colors COLORS set output colors in five-letter string
2017-02-10 07:55:05 -06:00
--nc disable color output
2018-06-16 21:35:32 -05:00
-n, --count N show N results per page (default 10)
2017-02-10 07:59:02 -06:00
--np do not show the prompt, run and exit
2017-02-11 00:03:29 -06:00
-o, --open [...] browse bookmarks by indices and ranges
open a random bookmark, if no arguments
--oa browse all search results immediately
2017-03-16 22:05:27 -05:00
--replace old new replace old tag with new tag everywhere
delete old tag, if new tag not specified
2017-02-11 00:03:29 -06:00
--shorten index|URL fetch shortened url from tny.im service
--expand index|URL expand a tny.im shortened url
2018-05-25 11:39:12 -05:00
--cached index|URL browse a cached page from Wayback Machine
2017-08-01 10:37:03 -05:00
--suggest show similar tags when adding bookmarks
2016-11-06 09:30:45 -06:00
--tacit reduce verbosity
2016-12-03 07:20:53 -06:00
--threads N max network connections in full refresh
2017-01-29 07:49:47 -06:00
default N=4, min N=1, max N=10
2017-02-10 09:04:24 -06:00
-V check latest upstream version available
2016-11-25 12:10:25 -06:00
-z, --debug show debug information and verbose logs
2016-04-29 13:09:39 -05:00
2017-01-04 10:17:02 -06:00
SYMBOLS:
2017-04-08 15:19:25 -05:00
> url
2016-07-03 05:06:50 -05:00
+ comment
# tags
2017-07-24 22:58:32 -05:00
2017-08-13 04:03:06 -05:00
PROMPT KEYS:
2017-07-24 22:58:32 -05:00
1-N browse search result indices and/or ranges
a open all results in browser
s keyword [...] search for records with ANY keyword
S keyword [...] search for records with ALL keywords
d match substrings ('pen' matches 'opened')
r expression run a regex search
2017-08-14 16:07:01 -05:00
t [...] search bookmarks by tags or show taglist
2017-08-13 04:03:06 -05:00
list index after a tag listing shows records with the tag
2018-06-16 21:35:32 -05:00
n show next page of search results
2017-08-13 04:03:06 -05:00
o id|range [...] browse bookmarks by indices and/or ranges
p id|range [...] print bookmarks by indices and/or ranges
g [taglist id|range ...] [>>|>|< < ] record id|range [...]
append, set, remove (all or specific) tags
w [editor|id] edit and add or update a bookmark
2018-02-10 17:42:21 -06:00
c id copy url at search result index to clipboard
2018-02-18 11:21:23 -06:00
O toggle try to open in a GUI browser
2017-07-24 22:58:32 -05:00
? show this help
q, ^D, double Enter exit buku
2017-01-04 10:17:02 -06:00
```
2016-07-03 05:06:50 -05:00
2017-08-24 16:46:54 -05:00
#### Colors
2017-08-24 16:30:45 -05:00
`buku` supports custom colors. Visit the wiki page on how to [customize colors ](https://github.com/jarun/Buku/wiki/Customize-colors ) for more details.
2017-03-29 02:07:43 -05:00
### Examples
2016-05-23 04:02:46 -05:00
2017-02-05 11:05:45 -06:00
1. **Edit and add** a bookmark from editor:
2017-10-01 21:11:16 -05:00
$ buku -w
$ buku -w 'gedit -w'
$ buku -w 'macvim -f' -a https://ddg.gg search engine, privacy
2017-09-18 19:25:22 -05:00
The first command picks editor from the environment variable `EDITOR` . The second command opens gedit in blocking mode. The third command opens macvim with option -f and the URL and tags populated in template.
2017-02-05 11:05:45 -06:00
2. **Add** a bookmark with **tags** `search engine` and `privacy` , **comment** `Search engine with perks` , **fetch page title** from the web:
2017-10-01 21:11:16 -05:00
$ buku -a https://ddg.gg search engine, privacy -c Search engine with perks
336. DuckDuckGo
> https://ddg.gg
+ Alternative search engine with perks
# privacy,search engine
2017-04-08 15:19:25 -05:00
where, >: url, +: comment, #: tags
2017-02-05 11:05:45 -06:00
3. **Add** a bookmark with tags `search engine` & `privacy` and **immutable custom title** `DDG` :
2016-02-28 08:32:10 -06:00
2017-10-01 21:11:16 -05:00
$ buku -a https://ddg.gg search engine, privacy --title 'DDG' --immutable 1
336. DDG (L)
> https://ddg.gg
# privacy,search engine
2017-03-16 22:05:27 -05:00
Note that URL must precede tags.
2017-02-05 11:05:45 -06:00
4. **Add** a bookmark **without a title** (works for update too):
2016-02-28 08:32:10 -06:00
2017-10-01 21:11:16 -05:00
$ buku -a https://ddg.gg search engine, privacy --title
2017-02-07 12:03:51 -06:00
5. **Edit and update** a bookmark from editor:
2017-10-01 21:11:16 -05:00
$ buku -w 15012014
2017-03-16 22:05:27 -05:00
This will open the existing bookmark's details in the editor for modifications. Environment variable `EDITOR` must be set.
2017-02-07 12:03:51 -06:00
6. **Update** existing bookmark at index 15012014 with new URL, tags and comments, fetch title from the web:
2016-05-20 13:26:01 -05:00
2017-10-01 21:11:16 -05:00
$ buku -u 15012014 --url http://ddg.gg/ --tag web search, utilities -c Private search engine
2017-02-07 12:03:51 -06:00
7. **Fetch and update only title** for bookmark at 15012014:
2016-05-20 13:26:01 -05:00
2017-10-01 21:11:16 -05:00
$ buku -u 15012014
2017-02-07 12:03:51 -06:00
8. **Update only comment** for bookmark at 15012014:
2016-05-20 13:26:01 -05:00
2017-10-01 21:11:16 -05:00
$ buku -u 15012014 -c this is a new comment
2017-03-16 22:05:27 -05:00
Applies to --url, --title and --tag too.
2018-05-10 20:16:47 -05:00
9. **Export** bookmarks tagged `tag 1` or `tag 2` to HTML, markdown or orgfile:
2016-09-20 13:02:04 -05:00
2017-10-01 21:11:16 -05:00
$ buku -e bookmarks.html --tag tag 1, tag 2
$ buku -e bookmarks.md --tag tag 1, tag 2
2018-05-10 20:16:47 -05:00
$ buku -e bookmarks.org --tag tag 1, tag 2
2017-10-01 21:11:16 -05:00
$ buku -e bookmarks.db --tag tag 1, tag 2
2017-03-16 22:05:27 -05:00
All bookmarks are exported if --tag is not specified.
2018-05-10 20:16:47 -05:00
10. **Import** bookmarks from HTML, markdown or orgfile:
2016-05-22 18:36:41 -05:00
$ buku -i bookmarks.html
2017-02-10 10:39:02 -06:00
$ buku -i bookmarks.md
2018-05-10 20:16:47 -05:00
$ buku -i bookmarks.org
2017-09-17 07:36:31 -05:00
$ buku -i bookmarks.db
2017-02-04 08:45:33 -06:00
11. **Delete only comment** for bookmark at 15012014:
2016-02-28 08:32:10 -06:00
2016-05-20 13:26:01 -05:00
$ buku -u 15012014 -c
2017-03-16 22:05:27 -05:00
Applies to --title and --tag too. URL cannot be deleted without deleting the bookmark.
2017-02-04 08:45:33 -06:00
12. **Update** or refresh **full DB** with page titles from the web:
2016-02-28 08:32:10 -06:00
2016-04-30 23:33:21 -05:00
$ buku -u
2016-11-08 11:32:45 -06:00
$ buku -u --tacit (show only failures and exceptions)
2017-03-16 22:05:27 -05:00
This operation does not modify the indexes, URLs, tags or comments. Only title is refreshed if fetched title is non-empty.
2017-02-04 08:45:33 -06:00
13. **Delete** bookmark at index 15012014:
2016-02-28 08:32:10 -06:00
$ buku -d 15012014
2016-03-20 00:53:59 -05:00
Index 15012020 moved to 15012014
2017-03-16 22:05:27 -05:00
The last index is moved to the deleted index to keep the DB compact.
2017-02-04 08:45:33 -06:00
14. **Delete all** bookmarks:
2016-02-28 08:32:10 -06:00
2016-04-30 23:33:21 -05:00
$ buku -d
2017-02-04 08:45:33 -06:00
15. **Delete** a **range or list** of bookmarks:
2016-06-16 16:08:38 -05:00
2016-10-22 01:42:11 -05:00
$ buku -d 100-200
$ buku -d 100 15 200
2017-02-04 08:45:33 -06:00
16. **Search** bookmarks for **ANY** of the keywords `kernel` and `debugging` in URL, title or tags:
2016-02-28 08:32:10 -06:00
2017-02-20 08:05:55 -06:00
$ buku kernel debugging
2016-02-28 08:32:10 -06:00
$ buku -s kernel debugging
2017-02-04 08:45:33 -06:00
17. **Search** bookmarks with **ALL** the keywords `kernel` and `debugging` in URL, title or tags:
2016-02-28 08:32:10 -06:00
$ buku -S kernel debugging
2017-02-04 08:45:33 -06:00
18. **Search** bookmarks **tagged** `general kernel concepts` :
2016-04-19 12:30:06 -05:00
2016-11-07 11:35:02 -06:00
$ buku --stag general kernel concepts
2017-08-14 16:07:01 -05:00
19. **Search** for bookmarks matching **ANY** of the tags `kernel` , `debugging` , `general kernel concepts` :
$ buku --stag kernel, debugging, general kernel concepts
20. **Search** for bookmarks matching **ALL** of the tags `kernel` , `debugging` , `general kernel concepts` :
$ buku --stag kernel + debugging + general kernel concepts
2018-03-25 22:33:46 -05:00
21. **Search** for bookmarks matching any of the keywords `hello` or `world` , excluding the keywords `real` and `life` , matching both the tags `kernel` and `debugging` , but **excluding** the tags `general kernel concepts` and `books` :
2017-08-14 16:07:01 -05:00
2018-03-25 22:33:46 -05:00
$ buku hello world --exclude real life --stag 'kernel + debugging - general kernel concepts, books'
2017-08-14 16:07:01 -05:00
22. List **all unique tags** alphabetically:
2016-05-01 03:43:26 -05:00
2016-11-07 11:35:02 -06:00
$ buku --stag
2017-08-14 16:07:01 -05:00
23. Run a **search and update** the results:
2017-01-08 22:22:22 -06:00
2017-03-16 22:05:27 -05:00
$ buku -s kernel debugging -u --tag + linux kernel
2017-08-14 16:07:01 -05:00
24. Run a **search and delete** the results:
2016-11-26 08:28:22 -06:00
$ buku -s kernel debugging -d
2017-08-14 16:07:01 -05:00
25. **Encrypt or decrypt** DB with **custom number of iterations** (15) to generate key:
2016-02-28 08:32:10 -06:00
2016-04-30 23:33:21 -05:00
$ buku -l 15
$ buku -k 15
2017-03-16 22:05:27 -05:00
The same number of iterations must be specified for one lock & unlock instance. Default is 8, if omitted.
2017-08-14 16:07:01 -05:00
26. **Show details** of bookmarks at index 15012014 and ranges 20-30, 40-50:
2016-05-01 03:43:26 -05:00
2016-10-11 11:45:07 -05:00
$ buku -p 20-30 15012014 40-50
2017-08-14 16:07:01 -05:00
27. Show details of the **last 10 bookmarks** :
2017-03-18 14:15:26 -05:00
$ buku -p -10
2017-08-14 16:07:01 -05:00
28. **Show all** bookmarks with real index from database:
2016-05-01 03:43:26 -05:00
$ buku -p
2016-05-03 12:52:36 -05:00
$ buku -p | more
2017-08-14 16:07:01 -05:00
29. **Replace tag** 'old tag' with 'new tag':
2016-05-01 03:43:26 -05:00
2017-03-16 22:05:27 -05:00
$ buku --replace 'old tag' 'new tag'
2017-08-14 16:07:01 -05:00
30. **Delete tag** 'old tag' from DB:
2016-05-01 03:43:26 -05:00
2017-03-16 13:37:51 -05:00
$ buku --replace 'old tag'
2017-08-14 16:07:01 -05:00
31. **Append (or delete) tags** 'tag 1', 'tag 2' to (or from) existing tags of bookmark at index 15012014:
2016-06-12 05:48:10 -05:00
$ buku -u 15012014 --tag + tag 1, tag 2
2016-07-11 12:18:40 -05:00
$ buku -u 15012014 --tag - tag 1, tag 2
2017-08-14 16:07:01 -05:00
32. **Open URL** at index 15012014 in browser:
2016-05-01 03:43:26 -05:00
$ buku -o 15012014
2017-08-14 16:07:01 -05:00
33. List bookmarks with **no title or tags** for bookkeeping:
2016-03-29 07:43:43 -05:00
2016-05-01 08:44:17 -05:00
$ buku -S blank
2017-08-14 16:07:01 -05:00
34. List bookmarks with **immutable title** :
2016-11-06 08:41:45 -06:00
$ buku -S immutable
2017-08-14 16:07:01 -05:00
35. **Shorten URL** www.google.com and the URL at index 20:
2016-11-12 09:47:36 -06:00
$ buku --shorten www.google.com
$ buku --shorten 20
2017-08-14 16:07:01 -05:00
36. **Append, remove tags at prompt** (taglist index to the left, bookmark index to the right):
2017-04-06 14:19:08 -05:00
// append tags at taglist indices 4 and 6-9 to existing tags in bookmarks at indices 5 and 2-3
buku (? for help) g 4 9-6 >> 5 3-2
// set tags at taglist indices 4 and 6-9 as tags in bookmarks at indices 5 and 2-3
buku (? for help) g 4 9-6 > 5 3-2
// remove all tags from bookmarks at indices 5 and 2-3
buku (? for help) g > 5 3-2
// remove tags at taglist indices 4 and 6-9 from tags in bookmarks at indices 5 and 2-3
buku (? for help) g 4 9-6 < < 5 3-2
2017-08-22 17:09:43 -05:00
37. List bookmarks with **colored output** :
2017-08-24 15:59:39 -05:00
$ buku --colors oKlxm -p
2017-08-22 17:09:43 -05:00
38. More **help** :
2016-02-28 08:32:10 -06:00
2016-11-26 08:28:22 -06:00
$ buku -h
2016-05-23 01:21:29 -05:00
$ man buku
2015-11-08 16:04:49 -06:00
2017-09-18 19:25:22 -05:00
### Troubleshooting
#### Editor integration
You may encounter issues with GUI editors which maintain only one instance by default and return immediately from other instances. Use the appropriate editor option to block the caller when a new document is opened. See issue [#210 ](https://github.com/jarun/Buku/issues/210 ) for gedit.
2017-03-29 02:07:43 -05:00
### Collaborators
2016-05-31 11:21:10 -05:00
2017-03-29 02:07:43 -05:00
- [Arun Prakash Jana ](https://github.com/jarun )
- [Rachmadani Haryono ](https://github.com/rachmadaniHaryono )
2017-08-12 17:16:34 -05:00
- [Johnathan Jenkins ](https://github.com/shaggytwodope )
- [SZ Lin ](https://github.com/szlin )
2016-05-23 04:02:46 -05:00
2018-01-01 08:30:01 -06:00
Copyright © 2015-2018 [Arun Prakash Jana ](mailto:engineerarun@gmail.com )
2017-03-29 02:07:43 -05:00
< br >
< p > < a href = "https://gitter.im/jarun/Buku" > < img src = "https://img.shields.io/gitter/room/jarun/buku.svg?maxAge=2592000" alt = "gitter chat" / > < / a > < / p >
2017-08-14 23:36:29 -05:00
### Related projects
- [bukubrow ](https://github.com/SamHH/bukubrow ), WebExtension for browser integration
- [oil ](https://github.com/AndreiUlmeyda/oil ), search-as-you-type cli frontend
- [buku_run ](https://github.com/carnager/buku_run ), rofi frontend
2017-11-05 20:38:26 -06:00
- [pinku ](https://github.com/mosegontar/pinku ), A Pinboard-to-Buku importation utility
2017-08-14 23:36:29 -05:00
2017-09-10 16:57:45 -05:00
< a href = "http://buku.readthedocs.io/en/stable/?badge=stable" > < img src = "https://img.shields.io/badge/docs-stable-brightgreen.svg?maxAge=2592000" alt = "Stable Docs" / > < / a >
2017-08-14 23:36:29 -05:00
### In the Press
- [2daygeek ](http://www.2daygeek.com/buku-command-line-bookmark-manager-linux/ )
2017-10-10 07:54:25 -05:00
- [It's F.O.S.S. ](https://itsfoss.com/buku-command-line-bookmark-manager-linux/ )
2017-08-14 23:36:29 -05:00
- [LinOxide ](https://linoxide.com/linux-how-to/buku-browser-bookmarks-linux/ )
2017-10-10 07:54:25 -05:00
- [LinuxUser Magazine 01/2017 Issue ](http://www.linux-community.de/LU/2017/01/Das-Beste-aus-zwei-Welten )
- [Make Tech Easier ](https://www.maketecheasier.com/manage-browser-bookmarks-ubuntu-command-line/ )
- [One Thing Well ](http://onethingwell.org/post/144952807044/buku )
- [ulno.net ](https://ulno.net/blog/2017-07-19/of-bookmarks-tags-and-browsers/ )