bookworm_genai 0.7.1b42

Bookworm - A LLM-powered bookmark search engine

bookworm 📖

LLM-powered bookmark search engine

bookworm allows you to search your locally stored bookmarks using human language.

Install

python -m pip install bookworm_genai

Usage

export OPENAI_API_KEY=

# Run once and then anytime bookmarks across supported browsers changes
bookworm sync

# Ask questions against the bookmark database
bookworm ask

# Ask questions against the bookmark database
# Specify the query when invoking the command
# If you omit this then you will be asked for a query when the tool is running
bookworm ask -q pandas

# Ask questions against the bookmark database and specify the number of results that should come back
bookworm ask -n 1

The sync process currently supports the following configurations:

Operating System	Google Chrome	Mozilla Firefox	Brave	Microsoft Edge
Linux	✅	✅	✅	❌
macOS	✅	❌	❌	❌
Windows	❌	❌	❌	❌

Processes

bookworm sync

python -m bookworm sync

graph LR

subgraph Bookmarks
    Chrome(Chrome Bookmarks)
    Brave(Brave Bookmarks)
    Firefox(Firefox Bookmarks)
end

Bookworm(bookworm sync)

EmbeddingsService(Embeddings Service e.g OpenAIEmbeddings)

VectorStore(Vector Store e.g DuckDB)

Chrome -->|load bookmarks|Bookworm
Brave -->|load bookmarks|Bookworm
Firefox -->|load bookmarks|Bookworm

Bookworm -->|vectorize bookmarks|EmbeddingsService-->|store embeddings|VectorStore

---

bookworm ask

python -m bookworm ask

graph LR

query
Bookworm(bookworm ask)

subgraph _
    LLM(LLM e.g OpenAI)
    VectorStore(Vector Store e.g DuckDB)
end

query -->|user queries for information|Bookworm

Bookworm -->|simularity search|VectorStore -->|send similar docs + user query|LLM
LLM -->|send back response|Bookworm

---

Developer Setup

# LLMs
export OPENAI_API_KEY=

# Langchain (optional, but useful for debugging)
export LANGCHAIN_API_KEY=
export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_PROJECT=bookworm

# Misc (optional)
export LOGGING_LEVEL=INFO

Recommendations:

• Install pyenv and ensure build dependencies are installed for your OS.
• Install Poetry we will be using environment management below.

poetry env use 3.9 # or path to your 3.9 installation

poetry shell
poetry install

bookworm --help