Skip to content
forked from dpunj/weft

A vim-like terminal reader to chat with your books

License

Notifications You must be signed in to change notification settings

cpeters008/weft-fork

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

weft 🪢

A vim-like terminal reader to chat with your books

https://x.com/dpunjabi/status/1854361314040446995

Features

Vim-like navigation

  • Flip between chapters: h/l or /
  • Scroll through pages: j/k or /
  • Jump to start/end: g/G
  • See table of contents: t

Chat with your books

  • a - Chat with your current text
  • s - Generate summary
  • r - Listen text
  • > - Listen to the compass

Uses LLM to interface with OpenAI, Anthropic, and other providers.

Getting started

Clone this repo and setup & activate venv using either uv (recommended)

uv venv
source .venv/bin/activate

Or, standard Python tools:

python3 -m pip install virtualenv
python3 -m virtualenv .venv
source .venv/bin/activate

Install dependencies with:

uv pip install -r requirements.txt # if using `uv` - faster!
# or
pip install -r requirements.txt

Bring your keys from OpenAI (default):

llm keys set OPENAI_API_KEY

Or use Anthropic's Claude:

llm install llm-claude-3
llm keys set ANTHROPIC_API_KEY
llm models default claude-3-5-sonnet-latest

Try it!

Get a book from Project Gutenberg and try it out:

uv run reader.py path/to/book.epub

About

A vim-like terminal reader to chat with your books

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%