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
这是什么?Deta Surf 是一个个人 AI 笔记本,它把你的文件和网页汇集到一处,并让你据此生成 AI 撰写的笔记,让研究和写作在同一条流里完成,而不必在多个应用之间来回切换。
这是笔记应用还是网页浏览器?两者都是:Surf 像浏览器一样围绕标签页、分屏视图和侧边栏组织,但每个标签页都可以是笔记、PDF、网站或文件,你可以就它们向 AI 提问,并把内容拉进文档。
怎么安装 Surf?按照 README 中链接的安装指南,下载适用于 macOS、Windows 或 Linux 的桌面版本;自行从源码构建的方法在 CONTRIBUTING.md 中单独说明。
使用 AI 功能需要我自己的 API 密钥吗?需要,Surf 采用自带密钥模式:你可以接入 OpenAI、Claude、DeepSeek 或 Gemma 等云模型的密钥,也可以改为通过 Ollama 添加本地模型,完全不用 API 密钥。
Surf 能完全离线使用吗?你保存的文件和页面库大部分可以离线打开和使用,但生成笔记和使用云端 AI 模型需要联网和 API 密钥;只有本地模型方案可以避开这些要求。
我的数据到底存在哪里?你保存的所有内容都进入你自己机器上一个名为 SFFS 的本地存储引擎,以开放、透明的文件格式存储,而不是放在厂商的云端。
Surflets 是什么?Surflets 是 Surf 根据提示词即时生成的交互式小应用,让你无需自己写代码就能可视化或探索数据与概念。
Surf 的笔记能引入实时网络搜索结果吗?可以,你可以在撰写笔记时触发网络搜索工具,提出一个带搜索的问题,把结果和带深度链接的引用直接引入笔记。
哪些内容可以放进笔记本(Notebook)?你可以添加本地文件、网站、YouTube 视频、推文和其他网页链接,或者直接在 Surf 中创建的笔记,并把它们全部整理进笔记本。
为什么要做 Surf,而不是分开用笔记、浏览器和 PDF 应用?大多数工具一次只能处理一种媒体类型;Surf 的设计让研究和思考可以在文件、网页和笔记之间以同一条流进行,而不必在众多窗口和标签页之间来回折腾。
Creator
deta
Size
268.9 MB
Stars
3.6K
Age
11mo
Commits · 90 Days