spyglass-search / spyglass

A personal search engine: Create a searchable library from your personal documents, interests, and more!
https://docs.spyglass.fyi
GNU Affero General Public License v3.0
2.54k stars 58 forks source link
cross-platform rust rust-lang search-engine tantivy tauri-app

Spyglass

A personal search engine that indexes what you want, exposing it to you in a simple & fast interface

Download now: macOS (Intel/ARM) | Windows | Linux (AppImage)

Documentation | Using Spyglass | Lenses



Create your library from:

Introduction

Spyglass lives on your device crawling & indexing websites you want with a basic set of rules.

Web pages when condensed down to text are surprisingly small. With todays' incredibly fast CPUs and ample amounts of of disk space, you can easily create a personal library of wikis, blog posts, etc. that can be referenced instantly. Cut through the SEO spam of the internet by building your own index.

For users who have been frustrated with the current state of search and the internet, Spyglass offers a powerful solution to find exactly what you want.

See Launching & Using Spyglass to get started.

Traditional web search sucks

The short answer is that Google search results are clearly dying. The long answer is that most of the web has become too inauthentic to trust.

Spyglass is a solution to the following common issues when searching the web:

How does it know what to crawl?

Spyglass expands on the ideas outlined in this paper by the Brave Search Team. There are currently a simple set of rules that will point Spyglass at a website and crawl only what you want. When available, crawling is bootstrapped w/ data from the Internet Archive to not overwhelm smaller websites.

For community lenses, we precrawl & preprocess these lenses so that you can get started searching through those topics immediately.

Not all websites & not all data can be crawled by Spyglass. If you have something that you'd like to index and would like some help, feel free to ping me on our Discord server!

See Community Lenses to install lenses others in the community have built.

See Building your own lens to see how easy it is to build your own lens. Please share w/ the community when you're done!

Developer Guide

If you'd like to help, reach out on our Discord server to see what is currently being developed and how you can help usher in a new, better search.

See Building from source to get started building & contributing to Spyglass.

TL;DR: If you want to build and run Spyglass from source, you can simply run this command:

cargo make run