Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

Peersky Browser Documentation

Features

  • Basic browser navigation:

    • Back
    • Forward
    • Reload
    • Browser protocol (peersky://)
    • Home page (peersky://home)
    • Cross browser themeing (browser://theme/)
    • Search engine
      • DuckDuckGo (default)
      • Brave Search
      • Ecosia
      • Kagi
      • Startpage
    • Page zoom, per tab, with a percentage readout
    • Address bar suggestions drawn from browsing history
    • Downloads, with progress in the toolbar (peersky://downloads)
      • Pause, resume or cancel a download in progress
    • Browsing history (peersky://history), searchable
    • First-run onboarding (peersky://onboarding)
    • Tabs
      • Vertical tabs toggle
      • Tab groups, with colours and collapsing
      • Pinned tabs
      • Split view: two tabs side by side, with a draggable divider
      • Drag a tab onto another window, or out into one of its own
      • Preview card on hover
      • Memory saver: sleeps inactive tabs, with an exclusion list
    • Incognito windows, from the File menu (Cmd/Ctrl+Shift+N), the Dock or the Windows taskbar
      • No history, saved tabs, download records or AI memory
      • Cookies, cache and site permissions live in memory and go when the last incognito window closes
      • Extensions stay out, and sites cannot publish to your drives from one
      • Their downloads show only in incognito windows, and their tabs cannot be dragged into a normal window
      • hyper:// and ipfs:// content still goes through the same local nodes as normal windows

  • Hypercore protocol handler:

    • Run a local hyper node
    • hyper:// native URLs support

  • BitTorrent protocol handler:

    • WebTorrent in isolated child process
    • bittorrent:// / bt:// / magnet: native URLs support
    • Real-time download progress UI with pause/resume
    • Auto-destroy torrent on completion (no seeding)
    • Optional bt:// seeding

  • IPFS protocol handler:

    • Run a local Helia node
    • ipfs:// / ipns:// native URLs support
    • Directory listings support
    • Native ENS domain resolution:
      • Resolve .eth domains directly to IPFS/IPNS content without centralized gateways (e.g., ipfs://vitalik.eth).
      • Local caching for resolved ENS content to enhance performance and reduce RPC calls.

  • Holesail protocol handler:

    • hs:// native URLs support
    • Direct peer-to-peer connections for real-time apps, over Holesail

  • Local file:// browsing with P2P publishing:

    • Custom file:// support with privileged access
    • Directory listings (Chrome-style)
    • One-click P2P publishing to:
      • IPFS (ipfs://)
      • Hypercore (hyper://)

  • Web3 protocol handler:

    • Run a local web3 protocol node
      • Access on-chain websites.
      • Fetch data from smart contracts using auto, manual, and resource request resolve modes.
      • Query account balances or other data directly from smart contracts.

  • P2P Applications:

    • peersky://p2p/peerchat/
      • Peer-to-peer messaging over Hyper
      • Works over the local network with no internet, via our hyperdht mDNS discovery
    • peersky://p2p/p2pmd/
      • Real-time collaborative markdown editor
      • Presentation slides mode with speaker notes
      • Offline KaTeX math mode with inline scientific templates
      • IEEE-style two-column research paper preview/export
      • AI-powered content generation
      • Publish to IPFS/Hypercore
      • Peers dashboard with roles, live editing status, and edit history
    • peersky://p2p/peertunes/
      • Music player
      • Syncs songs from hyper:// drives or local folders, with tags and album art
    • peersky://p2p/ai-chat/
      • Chat with local AI models, with nothing leaving the device
    • peersky://p2p/hyperdrive/
      • Decentralized file storage, published as a public or private drive
    • And several others, including a website builder, a Wikipedia reader over IPFS, and the Social Reader ActivityPub client for the fediverse.

  • Electron’s Auto-updater:

    • Download and install the latest release from Github automatically

  • Context menu:

    • Back / Forward
    • Reload
    • Inspect
    • Undo / Redo
    • Cut / Copy / Paste
    • Copy Link Address
    • Open Link in New Tab

  • Find in page:

    • Search for text within a document or web page

  • Window state persistence:

    • Save and restore open windows on app launch

  • Keyboard shortcuts:

    • New Window: CommandOrControl+N
    • New Tab: CommandOrControl+T
    • Close Tab: CommandOrControl+Shift+W
    • Close Window: CommandOrControl+W
    • Next Tab: CommandOrControl+Option+Right, or CommandOrControl+Tab off macOS
    • Previous Tab: CommandOrControl+Option+Left, or CommandOrControl+Shift+Tab off macOS
    • Back: CommandOrControl+[
    • Forward: CommandOrControl+]
    • Reload: CommandOrControl+R
    • Zoom In: CommandOrControl+Plus or CommandOrControl+=
    • Zoom Out: CommandOrControl+-
    • Actual Size: CommandOrControl+0
    • Print: CommandOrControl+P
    • Find in Page: CommandOrControl+F
    • Open Dev Tools: CommandOrControl+Shift+I
    • Focus URL Bar: CommandOrControl+L
    • Minimize: CommandOrControl+M
    • Toggle Full Screen: F11

  • Settings (peersky://settings):

    • Switch search engines, or point at a custom search URL
    • Set custom home page wallpapers
    • Hide/show the home page clock, and choose its format
    • Change themes
    • Clear browser cache
    • Vertical tabs, and whether they stay expanded
    • Memory saver, with an exclusion list
    • Automatic updates, plus a manual check
    • Set Peersky as the default browser
    • About: version and release notes

  • Local LLM integration for P2P apps:

    • window.llm APIs (chat + streaming, complete)

    • Trusted-domain exposure (PeerSky-native + allowlist)

    • AI Chat app (peersky://p2p/ai-chat/)

    • P2P Editor integration (peersky://p2p/peerpad/)

      • New AI generator (ai-generator.js) to generate code with AI

    • LLM Memory

      • llm.json to store prompts/responses across P2P apps
      • Reusable History component (P2P editor, AI chat, etc.)
      • Settings toggle to enable/disable memory
      • “Reset P2P Data” also clears llm.json

  • Web extensions:

  • Bookmarks (peersky://bookmarks):

    • Option to add favourite pages in the nav bar (peersky://bookmarks)

  • QR Code generator:

    • Option to generate a QR code for any page, from the address bar.

  • Archive (peersky://archive):

    • List and showcase published content from peersky://p2p/ apps for enhanced discoverability.
    • Provide metadata (e.g., creation date, content type) to improve navigation and usability.
    • Ability to download all the hashes of published data in a .json file.

  • Backup & Restore (peersky://backup):

    • Create offline .zip backups containing tabs, window layout, ENS cache, and full IPFS/Hypercore data.
    • Upload backups to IPFS or Hypercore to share and restore via a P2P CID.
    • Note: When restoring a backup from a P2P CID, the original device (or another peer) must remain online to serve the data.