ReadFlow is a modern, lightweight TUI (Terminal User Interface) web browser written in Rust. Designed for power users, developers, and anyone who prefers a keyboard-driven browsing experience.

• Keyboard-driven browsing - Full control without touching the mouse
• Reader Mode - Distraction-free article reading with clean formatting
• Multiple Themes - Dark, Light, and Sepia themes for comfortable reading
• Page Search - Find text within pages instantly
• History Navigation - Full back/forward navigation support
• Bookmarks - Save your favorite sites
• Feed Reader - Subscribe to RSS/Atom feeds
• Article Export - Export articles to Markdown, HTML, or plain text
• Tabbed Browsing - Open multiple pages in tabs
• Mouse Support - Click links and scroll with mouse

• Cross-platform - Works on Linux, macOS, and Windows
• Fast - Built with Rust for maximum performance
• SQLite Storage - Local database for history, bookmarks, and feeds
• AI Integration - Optional Ollama integration for article summarization
• Minimal Dependencies - Runs anywhere Rust compiles

# Linux/macOS
curl -sL https://raw.githubusercontent.com/irfancode/readflow/main/install.sh | bash

# Uninstall
curl -sL https://raw.githubusercontent.com/irfancode/readflow/main/install.sh | bash -s -- --uninstall

# Windows (PowerShell)
irm https://raw.githubusercontent.com/irfancode/readflow/main/install-windows.ps1 | iex

# Clone the repository
git clone https://github.com/irfancode/readflow.git
cd readflow

# Build
cargo build --release

# Install
cargo install --path .

# Linux/macOS (if installed via our installer)
curl -sL https://raw.githubusercontent.com/irfancode/readflow/main/install.sh | bash -s -- --uninstall

# From source (if installed via cargo install)
cargo uninstall readflow

readflow [OPTIONS]

Options:
  -u, --url <URL>       URL to open on startup
  -t, --theme <THEME>   Theme: dark, light, sepia (default: dark)
  -k, --insecure        Allow invalid SSL certificates
  -d, --debug           Enable debug logging
  -h, --help           Show help

# Open a website
readflow --url example.com

# Start with light theme
readflow --url wikipedia.org --theme light

# Debug mode
readflow --debug

• Linux: ~/.config/readflow/config.toml
• macOS: ~/.config/readflow/config.toml
• Windows: %APPDATA%\readflow\config.toml

# ReadFlow Configuration

# Theme: dark, light, sepia
theme = "dark"

# Default URL to open on startup
default_url = ""

# Enable cookies
enable_cookies = true

# Default search engine (for URL bar)
search_engine = "duckduckgo"

# Proxy settings (optional)
# proxy = "socks5://127.0.0.1:1080"

# Reader mode settings
[reader]
font_size = 16
line_width = 80

ReadFlow stores all data locally:

readflow/
├── src/
│   ├── main.rs           # Entry point
│   ├── lib.rs            # Core types and traits
│   ├── browser/          # Web fetching & HTML parsing
│   │   ├── fetcher.rs   # HTTP client
│   │   ├── parser.rs    # HTML parsing
│   │   └── renderer.rs  # Content rendering
│   ├── reader/           # Article extraction
│   │   └── extractor.rs # Readability algorithm
│   ├── storage/          # SQLite database
│   │   └── database.rs  # Database operations
│   ├── feeds/           # RSS/Atom parsing
│   │   └── parser.rs    # Feed parsing
│   ├── ui/              # TUI interface
│   │   ├── app.rs       # Application state
│   │   └── runner.rs    # Main loop & rendering
│   ├── ai/              # AI integration
│   │   └── summarizer.rs # Ollama integration
│   └── export/          # Export functionality
│       └── exporter.rs  # Article export
├── scripts/             # Installation scripts
├── install.sh           # One-click installer
└── Cargo.toml          # Dependencies

• Rust 1.70+
• Cargo
• OpenSSL development headers (Linux)

# Debug build
cargo build

# Release build
cargo build --release

# With all features
cargo build --release --all-features

cargo test

cargo fmt
cargo clippy

A: No. ReadFlow is a lightweight browser that displays raw HTML. Modern sites requiring JavaScript won't work properly.

A: No. ReadFlow is a text-based browser. For videos, use a traditional browser.

A:

# If installed from source
cd readflow && git pull && cargo build --release

# If installed via package manager
# Use your package manager's update command

A: Not currently, but you can use environment variables:

HTTP_PROXY=http://proxy:8080 HTTPS_PROXY=http://proxy:8080 readflow

A: Please open an issue at https://github.com/irfancode/readflow/issues

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests
5. Submit a pull request

MIT License - see LICENSE for details.

Made with ❤️ by the ReadFlow Team