brrowser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 305e3bb502291756cc66668c1788e23bd78aaae2eb398d7a3de19162ce6bb142
+  data.tar.gz: 90c4f79eddcca96d1db71099c809cce2fd789d5d2aa94924553ba9a2ae7f3376
+SHA512:
+  metadata.gz: 5ac1afb5836953f07dfc2605aa9316291367364621bf00e8fa00a0832b9ebed17ed24ad3e6e3ccfd19b2463b36fdaf20197a19b4341675fe344cba4a49cce8e6
+  data.tar.gz: 8c9423a9f9b8c32206072273ef2d37f05aaae74e0ed3c9bbdb069b9627d7346b7d3a201db32ee515c802077d611cc7ee5282d6793cf886203abdbbc976ec254b

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

data/README.md

@@ -0,0 +1,170 @@
+# brrowser
+
+<img src="img/brrowser.svg" align="right" width="150">
+
+**The terminal web browser with vim-style keys.**
+
+![Ruby](https://img.shields.io/badge/language-Ruby-red) [![Gem Version](https://badge.fury.io/rb/brrowser.svg)](https://badge.fury.io/rb/brrowser) ![Unlicense](https://img.shields.io/badge/license-Unlicense-green) ![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS-blue) ![Stay Amazing](https://img.shields.io/badge/Stay-Amazing-important)
+
+A terminal web browser combining w3m-style rendering with qutebrowser-style keyboard navigation. Renders HTML with styled headings, links, tables, forms, and inline images. No modes, no mouse, just keys.
+
+![Screenshot](img/screenshot.png)
+
+## Features
+
+**Browsing:**
+- Full HTML rendering (headings, paragraphs, lists, tables, blockquotes, code blocks, forms)
+- Inline image display via [termpix](https://github.com/isene/termpix) (kitty/sixel/w3m protocols)
+- ASCII art fallback via [chafa](https://hpjansson.org/chafa/) for non-graphical terminals
+- YouTube embed detection with thumbnails and direct video links
+- Back/forward history per tab
+- Search engines (Google, DuckDuckGo, Wikipedia)
+- Ad blocking via StevenBlack hosts list
+
+**Navigation:**
+- `j`/`k` or arrows to scroll, `gg`/`G` for top/bottom
+- `TAB`/`S-TAB` to cycle through links and form fields (highlighted with reverse video)
+- `Enter` to follow focused link or edit focused field
+- `o` to open URL, `t` to open in new tab, `O` to edit current URL
+- `H`/`Backspace` for back, `L` for forward
+- `/` to search page, `n`/`N` for next/previous match
+
+**Tabs:**
+- `J`/`Right` next tab, `K`/`Left` previous tab
+- `d` close tab, `u` restore closed tab
+
+**Bookmarks and quickmarks:**
+- `b` bookmark page, `B` show bookmarks
+- `m` + `0-9` set quickmark, `'` + `0-9` go to quickmark
+
+**Forms and passwords:**
+- `f` to fill and submit forms with auto-fill from stored passwords
+- Prompts to save new passwords after first login (Firefox-style)
+- `p` to show stored credentials, `:password` to save manually
+- `Ctrl-g` to edit a form field in `$EDITOR`
+
+**Clipboard:**
+- `y` copy page URL
+- `Y` copy focused link URL or field value
+
+**Images:**
+- Inline display in reserved space (no text overlap)
+- Images follow content during scrolling
+- `i` to toggle images on/off
+- Standalone image pages display full-screen
+- Image mode configurable: auto, termpix, ascii, off
+
+**AI and editing:**
+- `I` to get an AI summary of the page (OpenAI, shown in scrollable popup)
+- `e` to edit page source in `$EDITOR` and re-render
+- `Ctrl-l` to force redraw
+
+**Other:**
+- `:download URL` to save files to ~/Downloads
+- Binary files prompt: open with `xdg-open`, download, or cancel
+- `P` for preferences popup (image mode, colors, homepage, search engine)
+- `?` for built-in help page
+- Cookie persistence across sessions
+- Configurable colors for all UI elements
+
+## Installation
+
+```
+gem install brrowser
+```
+
+### Dependencies
+
+- Ruby 3.0+
+- [rcurses](https://github.com/isene/rcurses) (terminal UI)
+- [nokogiri](https://nokogiri.org/) (HTML parsing)
+- [termpix](https://github.com/isene/termpix) (image display, optional)
+
+Optional:
+- [chafa](https://hpjansson.org/chafa/) for ASCII art images on non-graphical terminals
+- ImageMagick (`convert`) for image scaling and SVG conversion
+- `xclip`/`xsel`/`wl-copy` for clipboard support
+
+## Usage
+
+```bash
+brrowser                        # Open blank page
+brrowser https://example.com    # Open URL directly
+brrowser isene.org              # Auto-adds https://
+```
+
+## Keybindings
+
+| Key | Action |
+|-----|--------|
+| `j` / `k` / arrows | Scroll up/down |
+| `Left` / `Right` | Previous/next tab |
+| `gg` / `G` | Top / bottom of page |
+| `Ctrl-d` / `Ctrl-u` | Half page down/up |
+| `Space` / `PgDn` / `PgUp` | Page down/up |
+| `TAB` / `S-TAB` | Next/previous link or field |
+| `Enter` | Follow link or edit field |
+| `o` / `O` | Open URL / edit current URL |
+| `t` | Open URL in new tab |
+| `H` / `Backspace` | Go back |
+| `L` | Go forward |
+| `r` | Reload page |
+| `d` | Close tab |
+| `u` | Undo close tab |
+| `/` | Search page |
+| `n` / `N` | Next/previous search match |
+| `b` / `B` | Bookmark / show bookmarks |
+| `m` + `0-9` | Set quickmark |
+| `'` + `0-9` | Go to quickmark |
+| `f` | Fill and submit form |
+| `y` / `Y` | Copy URL / copy focused element |
+| `e` | Edit page source in $EDITOR |
+| `Ctrl-g` | Edit field in $EDITOR |
+| `i` | Toggle images |
+| `I` | AI page summary |
+| `p` | Show stored password |
+| `P` | Preferences |
+| `Ctrl-l` | Redraw screen |
+| `?` | Help |
+| `q` | Quit |
+
+## Commands
+
+Type `:` to enter command mode.
+
+| Command | Action |
+|---------|--------|
+| `:open URL` / `:o` | Navigate |
+| `:tabopen URL` / `:to` | Open in new tab |
+| `:close` / `:q` | Close tab |
+| `:quit` / `:qa` | Quit |
+| `:back` / `:forward` | History navigation |
+| `:bookmark` / `:bm` | Add bookmark or open by name |
+| `:bookmarks` / `:bms` | List bookmarks |
+| `:download URL` / `:dl` | Download file |
+| `:adblock` | Update ad blocklist |
+| `:password` / `:pw` | Save password for current site |
+| `:about` | Open project page |
+
+## Configuration
+
+Settings are stored in `~/.brrowser/config.yml`. Press `P` in the browser to open the preferences popup where you can change:
+
+- Image mode (auto/termpix/ascii/off)
+- Homepage and default search engine
+- Colors for all UI elements (info bar, tab bar, content, status bar, links, headings)
+
+Other data files in `~/.brrowser/`:
+- `bookmarks.yml` - saved bookmarks
+- `quickmarks.yml` - quickmark shortcuts
+- `passwords.yml` - stored credentials (chmod 600)
+- `cookies.yml` - persistent cookies
+- `adblock.txt` - blocked domains list
+
+## License
+
+[Unlicense](https://unlicense.org/) - public domain.
+
+## Credits
+
+Created by Geir Isene (https://isene.org) with extensive pair-programming with Claude Code.