tools

various tools I have been using throughout the years
Log | Files | Refs | README | LICENSE

README.md (1466B)


      1 # wrd
      2 
      3 *web recall daemon* — full-text search and reader for the offline web archive in `~/misc/www`. Launches into live full-text search across the rendered text of every page; `Tab` switches to browsing by path. Selecting a result opens it in the [cha](https://sr.ht/~bptato/chawan/) terminal browser — markdown is rendered to HTML with `lowdown` first.
      4 
      5 Search reads a plain-text cache under `$XDG_CACHE_HOME/wrd`, rebuilt incrementally as pages change. Everything runs in-process.
      6 
      7 ## Building
      8 
      9 ```sh
     10 bazel build //wrd
     11 ```
     12 
     13 Install it locally (to `~/.local/share/tools`) with:
     14 
     15 ```sh
     16 bazel run //wrd:deploy
     17 ```
     18 
     19 ## Usage
     20 
     21 ```sh
     22 wrd [scope]
     23 ```
     24 
     25 ### Options
     26 
     27 | Argument | Description |
     28 |----------|-------------|
     29 | `<scope>` | Optional. Restrict to pages whose path contains this substring (e.g. `wrd purescript`) |
     30 
     31 ### Controls
     32 
     33 | Key | Action |
     34 |-----|--------|
     35 | *type* | Filter results |
     36 | `Tab` | Toggle content / browse mode |
     37 | `↑` `↓` / `Ctrl-n` `Ctrl-p` | Move selection |
     38 | `PgUp` `PgDn` | Page through results |
     39 | `Enter` | Open the page in cha |
     40 | `Ctrl-o` | Open the reconstructed live URL in cha |
     41 | `Ctrl-y` | Yank the live URL (`wl-copy`) |
     42 | `Ctrl-u` | Clear the query |
     43 | `Esc` / `Ctrl-c` | Quit |
     44 
     45 ## Requirements
     46 
     47 | Tool | Used for |
     48 |------|----------|
     49 | `cha` | Rendering and displaying pages |
     50 | `lowdown` | Markdown → HTML for display |
     51 | `pandoc` | Markdown → text for the search index |
     52 | `wl-copy` | Clipboard (`Ctrl-y`) |