+42 -38

README.md

reviewed

··· 4 4 5 5 Today's browsers are one-size-fits-all applications, cramming the vast universe of user needs across an unimaginably large web into in an unmodifiable tabbed-window design. 6 6 7 7 - Peek is a web user agent that is a workbench for experimenting with task alignment - making it easy to create new user interface shapes for the web which fit our need in the moment. 7 7 + We often use the web with a specific goal in mind - that goal should drive the design of the interface of the web user agent. We should be the driver, creator, maker, shaper of that design and interface. 8 8 9 9 - We often use the web with a specific goal in mind - that goal should drive the design of the interface of the web user agent. 9 9 + Peek is designed to allow you to experiment and create flows for task alignment in interfaces that are personal. It aims to make it easy to create new user interface shapes for the web which fit your need in the moment. 10 10 11 11 - <img width="969" alt="settings screenshot" src="settings-screenshot.png"> 11 11 + Peek is a workbench for the web. 12 12 + Peek is a window manager for the web. 13 13 + Peek is what you want it to be. 14 14 + 15 15 + <img width="969" alt="peek desktop screenshot" src="peek-desktop-screenshot.png"> 12 16 13 17 ## Important notes 14 18 15 15 - ___PEEK IS NOT A WEB BROWSER___ 19 19 + ___PEEK IS NOT A BROWSER___ 16 20 17 17 - Peek is not a web browser, and will never be a browser in the way you are probably familiar with: There are no tabs, and no windows in the tabbed-browser-like sense of them. Peek likely does not have many other of many details we are used to in web browsers, but do not notice until they are missing. Peek may be most useful to you if you view it as an entirely different type of application than a traditional web browser. 21 21 + Peek is not a browser, and will never be a browser in the way you are probably familiar with: There are no tabs, and no windows in the tabbed-browser-like sense of them. Peek likely does not have many other of many details we are used to in web browsers, but do not notice until they are missing. Peek may be most useful to you if you view it as an entirely different type of application than a traditional web browser. 18 22 19 23 ___PEEK IS A CONCEPT PREVIEW___ 20 24 21 25 Peek is not safe for daily use yet! It is a proof of concept. Do not use it for anything critical. Peek does not have the same security approach as traditional web browsers, and its security model and security user interface have not yet been determined. Peek has not had a security audit. 22 26 23 23 - ## Features 24 24 - 25 25 - You can use Peek in a few ways, with more coming: 26 26 - 27 27 - - Peeks - Keyboard-activated modal chromeless web pages for quickly glancing at or interacting with pages 28 28 - - Slides - Keyboard- or gesture-activated modal chromeless web pages which slide in from any screen edges 29 29 - - Scripts - Scripts periodically executed against a web page in the background which extract data for you to route to other pages or applications, or to aggregate, store and process later 30 30 - 31 31 - In progress, or thinking about: 32 32 - 33 33 - - Commands - a graphical command entry palette (GCLI) for opening pages or executing commands against them 34 34 - - Groups - a way to categorize, recall and interact with groups of pages 35 35 - - "native" web apps - using Peek as a way to "install" web pages on the local device, as separate applications instead of just separate processes 36 36 - - "Peeklets" HUD - select parts of pages to add to collection which are rendered as an overlay, toggled by shortcut 37 37 - 38 38 - ### Usage 39 39 - 40 40 - - Settings 41 41 - * In app, `Cmd/Ctrl+r,` or launch app to open settings, or click tray icon 42 42 - * Configure Peeks/Slides/Scripts in settings 43 43 - - Peeks 44 44 - * `Opt+0-9` to open Peeks 45 45 - - Slides 46 46 - * `Opt+←→↑↓` to open Slides 47 47 - 48 48 - ### Peeks 27 27 + ## Core 49 28 50 50 - Peeks are keyboard activated modal chromeless web pages mapped to `Opt+0-9` and closed on blur, the `Escape` key or `cmd/ctrl+w`. 51 51 - 52 52 - ### Slides 29 29 + Built-in capabilities that form the foundation of Peek. 53 30 54 54 - Slides are gesture activated modal chromeless web pages which slide in from left/right/bottom/top, and closed on blur, the `Escape` key or `cmd/ctrl+w`. 31 31 + - **IZUI Navigation** — Inverted Zooming User Interface. ESC-key-based navigation model that provides consistent "zoom out" behavior across all interfaces. Enter from anywhere, ESC to go back — predictable at every level. 32 32 + - **Window Management** — Heterogeneous windowing: chromeless modals, overlays, slides, workspaces and content windows, each with role-specific behavior. 33 33 + - **Extension System** — All features are extensions with manifest-declared commands, shortcuts, and settings. Extensions can be eager, lazy-loaded, or fully declarative. 34 34 + - **PubSub Messaging** — Cross-window event system for communication between extensions and windows. 35 35 + - **Data Persistence** — SQLite datastore with schema management, history tracking, and cross-device sync support. 36 36 + - **peek:// Protocol** — Custom protocol for internal navigation and cross-origin access. 37 37 + - **Settings** — Per-extension configuration with live reload. `Cmd/Ctrl+,` or tray icon. 55 38 56 56 - ### Scripts 39 39 + ## Features 57 40 58 58 - Scripts periodically load a web page in the background and extract data matching a CSS selector, stores it, and notify the user when the resulting data changes. 41 41 + - **Commands** — Graphical command palette (GCLI) for opening pages, executing commands, chaining outputs, and parameter entry. `Ctrl+Cmd+P` 42 42 + - **Groups** — Categorize, recall and interact with groups of pages. Tag-based with smart and curated grouping. `Ctrl+G` 43 43 + - **Peeks** — Keyboard-activated modal chromeless web pages for quickly glancing at or interacting with pages. `Opt+0-9` 44 44 + - **Slides** — Keyboard-activated modal chromeless web pages which slide in from any screen edge. `Opt+Arrow Keys` 45 45 + - **Editor** — Markdown editor with outline sidebar, live preview, and vim mode. `Ctrl+E` 46 46 + - **Search** — Search across all items by text and tags. 47 47 + - **Tags** — Tag, untag, and browse items by tag. Tag visualization and management. 48 48 + - **Tag Actions** — Define custom actions triggered by tags, enabling automated workflows. 49 49 + - **Web Search** — Search the web with engine discovery — Google, DuckDuckGo, Kagi, Bing, Wikipedia, and more. 50 50 + - **Windows** — Full-screen window switcher overlay showing all open windows as cards. `Ctrl+Shift+W` 51 51 + - **Pagestream** — Chat-like vertical navigation interface for browsing history. `Ctrl+P` 52 52 + - **Entities** — Automatic extraction of people, places, organizations, and events from visited pages. 53 53 + - **Scripts** — Periodically execute scripts against web pages in the background to extract data, with change notifications. 54 54 + - **Files** — Open local files, CSV conversion, markdown formatting, save operations. 55 55 + - **Feeds** — RSS/Atom feed reader. 56 56 + - **Lex** — Lexicon Studio: AT Protocol identity and data browser/editor. 57 57 + - **Sheets** — Widget sheets with freeform card layouts hosting webviews. 58 58 + - **Timers** — Countdown timers, alarms, stopwatches, and interval timers. 59 59 + - **Sync** — Cross-device synchronization of items, tags, and groups. 60 60 + - **HUD** — Always-on-top heads-up display showing current state and mode. `Ctrl+H` 59 61 60 60 - Ok, so not really "scripts" yet. But safe and effective enough for now. 62 62 + Coming: 63 63 + - "native" web apps — using Peek as a way to "install" web pages on the local device as separate applications 64 64 + - "Peeklets" HUD — select parts of pages to add to a collection rendered as an overlay 61 65 62 66 ## Design 63 67

peek-desktop-screenshot.png

reviewed

This is a binary file and will not be displayed.