surf README

The project's README from github.com/deta/surf. As one markdown file: README.md.

splash

Website - Discord


Deta Surf: Your AI Notebook

Deta Surf is an AI notebook that brings all your files and the web directly into your stream of thought.

It’s meant for simultaneous research and thinking that minimizes the grunt work: manually searching, opening windows & tabs, scrolling, copying and pasting into a document editor.

Surf is primarily built in Svelte, TypeScript and Rust, runs on MacOS, Windows & Linux, stores data locally in open formats, and is open source.

split

Motivation

Most applications are focused on a single task, or a single media type: notes, websites, or PDFs. Real thinking requires juggling media across sources to make connections and synthesize ideas. We want to help people think better, across all their media.

Surf is built to be personal and open, in service of the user. This means local first data, open data formats, open source, and openness with respect to AI models. Read more.

Installation

Checkout the installation guide for detailed instructions.

For building from source and local development, see CONTRIBUTING.md.

TL;DR - Things to try

Features

Multi-Media Library & Notebooks

notebooks

Store almost any media in a private library on your computer, in an open and transparent format.

Surf's library is built on a local storage engine called SFFS (Surf Flat File System), which stores data in open and transparent formats.

Details on the library.

Smart Notes

smart-notes

Explore and think across your digital stuff without opening up a bunch of windows, clicking, scrolling and copying & pasting into your document (or chatbot).

Read more.

Tabs, Split View & Sidebar

split

Surf is built around tabs, split view and a sidebar for easy navigation.

Surflets (App Generation)

surflets

Surf can code interactive applets to help you visualize, understand or explore concepts or data that are aided with code.

Read more.

AI

models.png

Surf’s notes and Surflets are powered by large language models of your choice.

Read more.

Shortcuts

Find the most common shortcuts here.

Security

To report a security concern, please see https://github.com/deta/surf/security/policy

Contributing

See CONTRIBUTING.md for details on contributing to the project and an overview of the codebase.

Code of Conduct

See CODE_OF_CONDUCT.md for details on our code of conduct.

License

The source code for this project is licensed under the Apache 2.0 license, with the following exceptions:

  1. Our patch for the @ghostery/adblocker-electron package is licensed under the Mozilla Public License 2.0 (MPL-2.0), consistent with the upstream project's licensing.
  2. Select files may contain their own specific license headers that override the default license.

Unless otherwise specified in the file or directory, all code defaults to the Apache 2.0 license.

See LICENSE for more details about the Apache 2.0 license.

Note: The Deta name and logos are not covered by the Apache 2.0 license.

Acknowledgements

This project makes use of the following open source packages (not a comprehensive list):

surf (deta/surf)

Searching Database…

3.6K ·GitHub
What is this?Deta Surf is a personal AI notebook that brings your files and webpages into one place and lets you generate AI-written notes from them, so research and writing happen in the same stream instead of jumping between apps.
Is this a note app or a web browser?It is both at once: Surf is organized around tabs, split view and a sidebar like a browser, but every tab can be a note, PDF, website or file that you can ask AI questions about and pull into a document.
How do I install Surf?You download the desktop build for macOS, Windows or Linux using the installation guide linked from the README; building it yourself from source is documented separately in CONTRIBUTING.md.
Do I need my own API key to use the AI features?Yes, Surf is bring-your-own-key: you plug in a key for a cloud model like OpenAI, Claude, DeepSeek or Gemma, or you can add a local model through Ollama instead and skip API keys entirely.
Can I use Surf fully offline?Much of your library of saved files and pages can be opened and used offline, but generating notes and using cloud AI models needs internet access and an API key; only the local-model option avoids that.
Where does my data actually live?Everything you save goes into a local storage engine on your own machine called SFFS, stored in open, transparent file formats rather than on a vendor's cloud.
What are Surflets?Surflets are interactive mini-apps that Surf can generate on the fly from a prompt, so you can visualize or explore data and concepts without writing any code yourself.
Can Surf's notes pull in live web search results?Yes, you can trigger a web search tool while writing a note and ask a question with search in it to bring results and deep-linked citations straight into your note.
What kinds of content can go into a Notebook?You can add local files, websites, YouTube videos, tweets and other web links, or notes created directly in Surf, and organize all of it into Notebooks.
Why build Surf instead of using separate note, browser and PDF apps?Most tools only handle one media type at a time; Surf was built so research and thinking can happen across files, web pages and notes in one stream instead of juggling many windows and tabs.
Creator
deta
Size
268.9 MB
Stars
3.6K
Age
11mo
Commits · 90 Days