pjht/buku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Arun Prakash Jana 2021-06-17 10:56:15 +05:30
parent c1e065370a
commit 9089cbe3cf
No known key found for this signature in database
GPG Key ID: A75979F35C080412
4 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -18,17 +18,21 @@
### Introduction
`buku` is a powerful bookmark manager written in Python3 and SQLite3. When I started writing it, I couldn't find a flexible command-line 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).
`buku` is a powerful bookmark manager and a personal textual mini-web.
For those who prefer the GUI, [bukuserver](https://github.com/jarun/buku/tree/master/bukuserver#readme) exposes a browsable front-end on a local web host server.
`buku` can auto-import bookmarks from your browser(s) or fetch the title and description of a bookmarked url from the web. 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. `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! *Buku* is too busy to track you: no hidden history, obsolete records, usage analytics or homing.
When I started writing it, I couldn't find a flexible command-line solution with a private, portable, merge-able database along with seamless GUI integration. Hence, `buku`.
To get started right away, jump to the [Quickstart](#quickstart) section. We have one of the best documentation around. You'll find handy examples in the man page too. For more details, please refer to the wiki page on [operational notes](https://github.com/jarun/buku/wiki/Operational-notes).
`buku` can import bookmarks from browser(s) or fetch the title, tags and description of a URL from the web. Use your favourite editor to add, compose and update bookmarks. Search bookmarks instantly with multiple search options, including regex and a deep scan mode (handy with URLs).
There are several [projects based on `buku`](#related-projects), including a browser plug-in.
It can look up broken links on Wayback Machine. There's an Easter Egg to revisit random bookmarks.
*Love smart and efficient utilities? Explore [my repositories](https://github.com/jarun?tab=repositories). Buy me a cup of coffee if they help you.*
There's no tracking, hidden history, obsolete records, usage analytics or homing.
To get started right away, jump to the [Quickstart](#quickstart) section. `buku` has one of the best documentation around. The man page comes with examples. For internal details, please refer to the [operational notes](https://github.com/jarun/buku/wiki/Operational-notes).
`buku` is a library too! There are several [related projects](#related-projects), including a browser plug-in.
<p align="center">
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://img.shields.io/badge/donate-@PayPal-1eb0fc.svg" alt="Donate via PayPal!" /></a>
@ -70,8 +74,8 @@ There are several [projects based on `buku`](#related-projects), including a bro
- Portable, merge-able database to sync between systems
- Import/export bookmarks from/to HTML, Markdown or Orgfile
- Smart tag management using redirection (>>, >, <<)
- Multithreaded full DB refresh, manual encryption support
- Shell completion scripts, man page with handy examples
- Multi-threaded full DB refresh, manual encryption support
- Shell completion scripts, man page with examples
- Privacy-aware (no unconfirmed user data collection)
### Installation
@ -80,12 +84,12 @@ There are several [projects based on `buku`](#related-projects), including a bro
| Feature | Dependency |
| --- | --- |
| Scripting language | Python 3.6+ |
| Lang, SQLite | Python 3.6+ |
| HTTPS | certifi, urllib3 |
| Encryption | cryptography |
| HTML | beautifulsoup4, html5lib |
To copy url to clipboard at the prompt `buku` uses `xsel` (or `xclip`) on Linux, `pbcopy` (default installed) on OS X, `clip` (default installed) on Windows, `termux-clipboard` on Termux (terminal emulation for Android), `wl-copy` on Wayland. If X11 is missing, GNU Screen or tmux copy-paste buffers are recognized.
To copy URL to clipboard `buku` uses `xsel` (or `xclip`) on Linux, `pbcopy` (default installed) on OS X, `clip` (default installed) on Windows, `termux-clipboard` on Termux (terminal emulation for Android), `wl-copy` on Wayland. If X11 is missing, GNU Screen or tmux copy-paste buffers are recognized.
#### From a package manager
@ -165,9 +169,10 @@ GENERAL OPTIONS:
- update results when used with search
- otherwise refresh all titles and desc
-w, --write [editor|index]
open editor to edit a fresh bookmark
edit and add a new bookmark in editor
else, edit bookmark at index in EDITOR
edit last bookmark, if index=-1
to specify index, EDITOR must be set
if no args, edit new bookmark in EDITOR
-d, --delete [...] remove bookmarks from DB
accepts indices or a single range
if no arguments:
@ -272,7 +277,7 @@ PROMPT KEYS:
o id|range [...] browse bookmarks by indices and/or ranges
p id|range [...] print bookmarks by indices and/or ranges
w [editor|id] edit and add or update a bookmark
c id copy url at search result index to clipboard
c id copy URL at search result index to clipboard
? show this help
q, ^D, double Enter exit buku
```
@ -297,7 +302,7 @@ PROMPT KEYS:
b -p
6. 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).
7. Handy (bash/zsh) commands to fuzzy search with fzf and open the selection in Firefox:
7. Quick (bash/zsh) commands to fuzzy search with fzf and open the selection in Firefox:
firefox $(buku -p -f 10 | fzf)
firefox $(buku -p -f 40 | fzf | cut -f1)
@ -329,7 +334,7 @@ PROMPT KEYS:
> https://ddg.gg
+ Alternative search engine with perks
# privacy,search engine
where, >: url, +: comment, #: tags
where, >: URL, +: comment, #: tags
3. **Add** a bookmark with tags `search engine` & `privacy` and **immutable custom title** `DDG`:
$ buku -a https://ddg.gg search engine, privacy --title 'DDG' --immutable 1

5
buku
View File

@ -5082,9 +5082,10 @@ POSITIONAL ARGUMENTS:
- update results when used with search
- otherwise refresh all titles and desc
-w, --write [editor|index]
open editor to edit a fresh bookmark
edit and add a new bookmark in editor
else, edit bookmark at index in EDITOR
edit last bookmark, if index=-1
to specify index, EDITOR must be set
if no args, edit new bookmark in EDITOR
-d, --delete [...] remove bookmarks from DB
accepts indices or a single range
if no arguments:

2
buku.1
View File

@ -112,7 +112,7 @@ Edit a bookmark in
.I editor
before adding it. To edit and update an existing bookmark, the
.I index
should be passed. However, in this case the environment variable EDITOR must be set. The last record is opened in EDITOR if index=-1.
should be passed. In this case the environment variable EDITOR must be set. The last record is opened in EDITOR if index=-1.
.TP
.BI \-d " " \--delete " [...]"
Delete bookmarks. Accepts space-separated list of indices (e.g. 5 6 23 4 110 45) or a single hyphenated range (e.g. 100-200). Note that range and list don't work together. Deletes search results when combined with search options, if no arguments.

2
bukuserver/README.md
View File

@ -28,7 +28,7 @@ $ source env/bin/activate
#### From PyPi
$ pip3 install buku[server]
$ pip3 install "buku[server]"
#### From source