README.org

 1#+title: crumb
 2
 3* what
 4local-only browser history tracker. a webextension plugin and a
 5local http server. logs each page you visit to a plaintext org-mode
 6file at ~/.crumb/history.org.
 7
 8* parts
 9- browser extension (webextension api, javascript)
10- local http listener (python + flask)
11- plaintext log (~/.crumb/history.org)
12
13on each page load the extension posts page metadata to the local
14server, which appends it to the log. captured: title, url, utc
15timestamp, hostname, path, and optionally query string, tab id,
16window id, favicon url.
17
18* requires
19python 3.x, flask, a chromium or firefox browser with extension
20developer mode.
21
22* run
231. start the listener:
24
25#+begin_src sh
26python3 -m venv venv
27source ./venv/bin/activate
28pip install -r requirements.txt
29python server.py
30#+end_src
31
322. load the extension: enable developer mode, load crumb_extension/.
333. browse. entries land in ~/.crumb/history.org.
344. search:
35
36#+begin_src sh
37python search.py <term>
38#+end_src
39
40* limits
41- extensions can't write files directly; the local server does it.
42- the log is plaintext, not encrypted. bolt on your own if needed.
43- data stays local. nothing is sent anywhere.
44
45* license
460bsd. see LICENSE.