From 080904675809fa1df0e50957e8df16a085c91811 Mon Sep 17 00:00:00 2001 From: Christian Cleberg Date: Sun, 2 Aug 2026 15:29:31 -0500 Subject: convert readme to nfo; relicense to 0bsd --- README.nfo | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README.nfo (limited to 'README.nfo') diff --git a/README.nfo b/README.nfo new file mode 100644 index 0000000..afe1c11 --- /dev/null +++ b/README.nfo @@ -0,0 +1,48 @@ +┌──────────────────────────────────────────────────────────────┐ +│ C R U M B [ KRZ ] krz.sh │ +└──────────────────────────────────────────────────────────────┘ + +WHAT + local-only browser history tracker. a webextension plugin and a + local http server. logs each page you visit to a plaintext org-mode + file at ~/.crumb/history.org. + +PARTS + - browser extension (webextension api, javascript) + - local http listener (python + flask) + - plaintext log (~/.crumb/history.org) + + on each page load the extension posts page metadata to the local + server, which appends it to the log. captured: title, url, utc + timestamp, hostname, path, and optionally query string, tab id, + window id, favicon url. + +REQUIRES + python 3.x, flask, a chromium or firefox browser with extension + developer mode. + +RUN + 1. start the listener: + + python3 -m venv venv + source ./venv/bin/activate + pip install -r requirements.txt + python server.py + + 2. load the extension: enable developer mode, load crumb_extension/. + 3. browse. entries land in ~/.crumb/history.org. + 4. search: + + python search.py + +LIMITS + - extensions can't write files directly; the local server does it. + - the log is plaintext, not encrypted. bolt on your own if needed. + - data stays local. nothing is sent anywhere. + +LICENSE + 0bsd. see LICENSE. + +┌──────────────────────────────────────────────────────────────┐ +│ krz.sh │ +└──────────────────────────────────────────────────────────────┘ -- cgit v1.2.3