glance-cli 0.10.6 → 0.10.7

package/README.md

@@ -1,14 +1,14 @@
 # glance-cli
 
-**AI-powered web reader for your terminal** – Fetch any webpage, extract clean content, and get instant AI summaries.
+**AI-powered web reader for your terminal** – Fetch any webpage, extract clean content, get instant AI summaries, and listen with natural voice synthesis.
 
 - **100% FREE by default** – Uses local Ollama (no API keys needed!)
 - **Privacy-first** – Your data stays on your machine
+- **Voice-enabled** – Read articles aloud with multilingual support
 - **Lightning fast** – Built with Bun and TypeScript
-- **AI-powered formatting** – Intelligent content structure for `--full` mode
-- **Production-ready** – Error handling, and retry logic
+- **Production-ready** – Smart caching, error handling, retry logic
 
-Turn any webpage into beautifully formatted, terminal-friendly insights — no browser needed.
+Turn any webpage into terminal-friendly insights with AI summaries or full content — read it, listen to it, or export it.
 
 [![npm version](https://badge.fury.io/js/glance-cli.svg)](https://www.npmjs.com/package/glance-cli)
 [![Downloads](https://img.shields.io/npm/dm/glance-cli.svg)](https://www.npmjs.com/package/glance-cli)
@@ -19,310 +19,144 @@ Turn any webpage into beautifully formatted, terminal-friendly insights — no b
 ## ⚡ Quick Start
 
 ```bash
-# Install with Bun (preferred - faster!)
-bun install -g glance-cli
+# Install
+bun install -g glance-cli  # Or: npm install -g glance-cli
 
-# Or with npm
-npm install -g glance-cli
-
-# Use immediately (works without setup!)
-glance https://example.com
+# Use immediately
+glance https://www.ayiti.ai
+glance https://www.ayiti.ai --read              # Listen to it
+glance https://www.ayiti.ai --tldr              # Quick summary
 ```
 
 **For 100% free local AI:**
 ```bash
-# One-time setup (~4GB download)
+# One-time setup (~4GB)
 curl -fsSL https://ollama.com/install.sh | sh
 ollama pull llama3
 
 # Now completely free forever
-glance https://nextjs.org/docs --tldr
+glance https://techcrunch.com --tldr --read
 ```
 
 ---
 
-## 🎯 Why Glance?
-
-| Feature | Glance + Ollama | Traditional AI Tools |
-|---------|-----------------|---------------------|
-| **Cost** | $0 forever | $20-100/month |
-| **Privacy** | 100% local | Cloud-based |
-| **Speed** | 2-3 seconds | 10-30 seconds |
-| **Setup** | 2 minutes | Instant (with $$) |
-
-Perfect for developers who want fast, private, and free AI summarization in their terminal.
-
----
-
-## 📖 Basic Usage
-
-### Summary Modes
-```bash
-# Quick summary
-glance https://nextjs.org/docs
-
-# One-sentence TL;DR
-glance https://techcrunch.com/article --tldr
-
-# Bullet point key insights
-glance https://blog.example.com --key-points
-
-# Simple explanation
-glance https://complex-topic.com --eli5
-
-# Ask specific questions
-glance https://nextjs.org/docs --ask "What's the App Router?"
-
-# Read FULL content (no summarization)
-glance https://blog.samaltman.com/article --full
-glance https://important-article.com --full --read  # Listen to entire article
-
-# Read FULL content in different languages
-glance https://blog.samaltman.com/article --full -l fr  # Translate to French
-glance https://lemonde.fr/article --full -l en --read   # French article in English with voice
-```
-
-### AI Models
+## 🎯 Core Features
 
-**Free Local AI (Recommended):**
+### 📝 **Content Modes**
 ```bash
-glance https://example.com --model llama3
-# Popular models: llama3, mistral, phi3, gemma2
-# List available: glance --list-models
+glance <url>                  # AI summary (default)
+glance <url> --tldr           # One sentence
+glance <url> --key-points     # Bullet points
+glance <url> --eli5           # Simple explanation
+glance <url> --full           # Full content (no summary)
+glance <url> --ask "..."      # Ask specific question
 ```
 
-**Optional Cloud AI:**
+### 🎤 **Voice & Audio**
 ```bash
-# OpenAI (requires API key)
-export OPENAI_API_KEY=sk-...
-glance https://example.com --model gpt-4o-mini
+glance <url> --read                           # Read aloud
+glance <url> --audio-output article.mp3       # Save as MP3
+glance <url> --voice nova --read              # Choose voice
+glance <url> -l fr --voice antoine --read     # French voice
 
-# Google Gemini (requires API key)
-export GEMINI_API_KEY=...
-glance https://example.com --model gemini-2.0-flash-exp
+glance --list-voices                          # See all voices
 ```
 
-**Smart Detection:**
-```bash
-# See what services you have
-glance --check-services
-
-# Force free-only
-glance https://example.com --free-only
-
-# Prefer quality (use paid if available)
-glance https://example.com --prefer-quality
-```
+**Voice Options:**
+- **Free**: System TTS (macOS Say, Windows SAPI, Linux espeak)
+- **Premium**: ElevenLabs (natural voices, requires `ELEVENLABS_API_KEY`)
 
-### Output Options
+### 🌍 **Multi-Language Support**
 ```bash
-# Export to Markdown
-glance https://nextjs.org/docs --export notes.md
-
-# Export to JSON
-glance https://api-docs.com --json -o data.json
-
-# Save as audio (text-to-speech)
-glance https://article.com --audio-output summary.mp3
-
-# Read aloud immediately
-glance https://blog.com --read
-
-# Use specific voice
-glance https://news.com --voice nova --read
-
-# French content with French voice
-glance https://lemonde.fr --voice antoine -l fr --read
+glance <url> --full -l fr                     # Translate to French
+glance <url> --full -l es --voice isabella --read   # Spanish + voice
 
-# Spanish content with Spanish voice
-glance https://elpais.com --voice isabella -l es --read
+# Supported: en, fr, es, ht (Haitian Creole)
 ```
 
-### Advanced Features
+### 🤖 **AI Models**
 ```bash
-# Screenshot + summary
-glance https://example.com --screenshot page.png --tldr
-
-# JavaScript-heavy sites (SPAs)
-glance https://react-app.com --full-render
+# Free local AI (recommended)
+glance <url> --model llama3
 
-# Multiple languages
-glance https://lemonde.fr --tldr -l fr  # French
-glance https://elpais.com -k -l es      # Spanish
+# Premium cloud AI (optional, requires API keys)
+glance <url> --model gpt-4o-mini              # OpenAI
+glance <url> --model gemini-2.0-flash-exp     # Google Gemini
 
-# Streaming output
-glance https://long-article.com --stream
+# Model management
+glance --list-models          # Show available local models
+glance --check-services       # Show AI/voice service status
+glance <url> --free-only      # Never use paid APIs
 ```
 
 ---
 
-## 🎨 Output Formats
+## 📖 Common Use Cases
 
 ```bash
-# Terminal (default) - colorful, emoji-rich
-glance https://example.com
+# Morning news with audio
+glance https://news.ycombinator.com --tldr --read
 
-# Markdown
-glance https://example.com -o article.md
+# Documentation lookup
+glance https://nextjs.org/docs --ask "What's the App Router?"
 
-# JSON (for scripting)
-glance https://example.com -o data.json
+# Study while coding
+glance https://tutorial.com --full --read
 
-# HTML (embeddable)
-glance https://example.com --format html -o page.html
+# Multilingual learning
+glance https://lemonde.fr --full -l en --read
 
-# Plain text (pipeable)
-glance https://example.com --format plain | grep "keyword"
+# Batch processing
+for url in $(cat urls.txt); do
+  glance "$url" --tldr >> digest.md
+done
 ```
 
 ---
 
-## 🚀 Performance
-- Fast content extraction with Cheerio
-- Optimized AI model selection 
-- Efficient text processing pipeline
-- Lightweight 8MB bundle
-
----
-
-## 🛠️ Common Use Cases
-
-### 1. Quick Documentation Lookup
-```bash
-glance https://nextjs.org/docs --ask "How do I use Server Actions?"
-```
-
-### 2. Morning News Briefing
-```bash
-glance https://news.ycombinator.com --tldr --read
-```
-
-### 3. Research & Note-Taking
-```bash
-glance https://research-paper.com --key-points --export notes.md
-```
-
-### 4. Batch Processing
-```bash
-cat urls.txt | while read url; do
-  glance "$url" --tldr >> daily-summary.md
-done
-```
+## 📚 All Options
 
-### 5. API Documentation
+### **Content**
 ```bash
-glance https://api-docs.com --ask "How do I authenticate?" --format plain
+--tldr                        # One sentence summary
+--key-points, -k              # Bullet points
+--eli5                        # Simple explanation
+--full                        # Full content (no summary)
+--ask "question"              # Custom Q&A
 ```
 
-### 6. Listen to Full Articles
+### **Voice & Audio**
 ```bash
-# Read entire blog posts or articles
-glance https://blog.example.com/long-post --full --read
-
-# Save full content as audio
-glance https://important-article.com --full --audio-output article.mp3
-
-# Export full content to markdown
-glance https://documentation.com/guide --full --export guide.md
+--read, --speak               # Read aloud
+--audio-output <file>         # Save as MP3
+--voice <name>                # Choose voice (nova, onyx, antoine, isabella)
+--list-voices                 # Show available voices
+-l, --language <code>         # Output language (en, fr, es, ht)
 ```
 
-### 7. Multilingual Full Content
+### **AI Models**
 ```bash
-# Translate entire articles to other languages
-glance https://blog.samaltman.com/post --full -l fr --read  # English to French
-glance https://lemonde.fr/article --full -l en --read       # French to English
-glance https://elpais.com/news --full -l en --voice nova --read  # Spanish to English
-
-# Perfect for language learning or accessibility
-glance https://technical-docs.com --full -l es --audio-output spanish-docs.mp3
+--model <name>                # AI model (llama3, gpt-4o-mini, gemini-2.0-flash-exp)
+--list-models                 # Show local models
+--check-services              # Show service status
+--free-only                   # Never use paid APIs
+--prefer-quality              # Use premium if available
 ```
 
-### 8. Smart Content Formatting
+### **Output & Export**
 ```bash
-# AI automatically formats messy websites for better readability
-glance https://personal-blog.com --full  # Cleans up layout
-glance https://complex-site.com --full --read  # Perfect for voice
-
-# Works great for sites with poor formatting
-glance https://old-website.com --full --export clean-article.md
-```
-
----
-
-## 🎤 Voice & Language Support
-
-Glance supports **multi-language voice synthesis** with ElevenLabs integration:
-
-```bash
-# List available voices by language
-glance --list-voices
-
-# English voices (default)
-glance https://news.com --voice nova --read       # Energetic
-glance https://docs.com --voice onyx --read       # Deep, authoritative
-
-# French voices  
-glance https://lemonde.fr --voice antoine -l fr --read
-
-# Spanish voices
-glance https://elpais.com --voice isabella -l es --read
-
-# Haitian Creole support
-glance https://example.ht --voice nova -l ht --read
+-o, --export <file>           # Save to file
+--stream                      # Live streaming output
+--markdown, --json            # Format shortcuts
 ```
 
-**Voice Quality Levels:**
-- **Free**: System TTS (macOS Say, Windows SAPI, Linux espeak)
-- **Premium**: ElevenLabs voices with natural pronunciation (requires API key)
-
-Set `ELEVENLABS_API_KEY` environment variable for premium voices.
-
----
-
-## 📚 All Options
-
+### **Advanced**
 ```bash
-# Summary modes
-glance <url>                  # Standard summary
-glance <url> --tldr           # One sentence
-glance <url> --key-points     # Bullet points
-glance <url> --eli5           # Simple explanation
-glance <url> --ask "question" # Custom Q&A
-glance <url> --full           # Full content (no summary)
-glance <url> --full -l fr     # Full content translated to French
-
-# AI models
---model <name>                # llama3, gpt-4o-mini, gemini-2.0-flash-exp
---list-models                 # Show available Ollama models
---check-services              # Show available AI/voice services
---free-only                   # Never use paid APIs
---prefer-quality              # Use premium services when available
-
-# Output
--o, --export <file>           # Save to file (auto-detects format)
---markdown                    # Markdown format
---json                        # JSON format
---format <type>               # terminal, markdown, json, html, plain
---stream                      # Live streaming output
-
-# Voice/Audio
---read, --speak               # Read aloud (text-to-speech)
---audio-output <file>         # Save as MP3
---voice <name>                # Choose voice (nova, onyx, antoine, etc.)
---list-voices                 # Show available voices by language
--l, --language <code>         # Language for voice selection (en, fr, es, ht)
-
-# Advanced
 --screenshot <file>           # Capture screenshot
 --full-render                 # Render JavaScript (for SPAs)
 --metadata                    # Show page metadata
 --links                       # Extract all links
---tables                      # Extract tables
--l, --language <code>         # Output language (en, fr, es, ht)
--e, --emoji                   # Add emojis
-
-# Other
--v, --verbose                 # Show detailed logs
+-v, --verbose                 # Detailed logs
 -h, --help                    # Show help
 -V, --version                 # Show version
 ```
@@ -331,92 +165,57 @@ glance <url> --full -l fr     # Full content translated to French
 
 ## 🔧 Configuration
 
-### Environment Variables
-
 ```bash
 # AI Providers (optional)
 export OPENAI_API_KEY=sk-...
 export GEMINI_API_KEY=...
 
-# Voice (optional)
+# Voice (optional, for premium)
 export ELEVENLABS_API_KEY=...
 
 # Ollama (optional, auto-detected)
 export OLLAMA_ENDPOINT=http://localhost:11434
-
 ```
 
 ---
 
-## 🚀 Examples
-
-### Learning & Research
-```bash
-# Understand a new framework
-glance https://nextjs.org/docs --eli5
-
-# Quick reference
-glance https://nextjs.org/docs --key-points --export nextjs-notes.md
-
-# Specific questions
-glance https://nextjs.org/docs --ask "What's the difference between pages and app router?"
-```
+## 🎓 Pro Tips
 
-### Daily Workflow
 ```bash
-# Morning news
-glance https://news.ycombinator.com --tldr --read
+# 1. Translate + voice + save
+glance https://www.ayiti.ai --full -l fr --audio-output french.mp3
 
-# Documentation lookup
-glance https://nextjs.org/docs/app/api-reference/functions/fetch --ask "How do I revalidate?"
+# 2. Use local AI for privacy
+glance https://www.ayiti.ai --model llama3 --free-only
 
-# Code examples
-glance https://tutorial.com --format plain | grep -A 10 "example"
-```
-
-### Content Creation
-```bash
-# Extract for blog post
-glance https://source-article.com --key-points --export research.md
+# 3. Match voice to language
+glance https://lemonde.fr --voice antoine -l fr --read
 
-# Multilingual content
-glance https://lemonde.fr --tldr -l fr --export french-news.md
+# 4. Streaming for long content
+glance https://long-article.com --stream
 ```
 
 ---
 
-## 🎓 Pro Tips
+## 🚀 Performance
 
-**1. Use local AI for daily tasks:**
-```bash
-glance https://example.com --model llama3  # Free, fast, private
-```
+- **Fast**: 2-3 seconds with local AI (Ollama)
+- **Efficient**: Cheerio-based content extraction
+- **Smart caching**: Reduces redundant API calls
+- **Lightweight**: ~8MB bundle size
 
-**2. Pipe output for scripting:**
-```bash
-glance https://example.com --format plain | grep "keyword" | wc -l
-```
-
-**3. Save audio for commute:**
-```bash
-glance https://article.com --tldr --audio-output commute.mp3
-```
+---
 
-**4. Use streaming for long content:**
-```bash
-glance https://long-article.com --stream
-```
+## 📊 Why Glance?
 
-**5. Read full articles without summarization:**
-```bash
-glance https://blog-post.com --full --read
-```
-
-**6. AI-powered smart formatting:**
-```bash
-# Automatically formats messy content for readability
-glance https://complex-site.com --full  # AI fixes formatting
-```
+| Feature | Glance + Ollama | Traditional Tools |
+|---------|-----------------|-------------------|
+| **Cost** | $0 forever | $20-100/month |
+| **Privacy** | 100% local | Cloud-based |
+| **Voice** | Built-in | Often separate |
+| **Speed** | 2-3 seconds | 10-30 seconds |
+| **Multilingual** | Full support | Limited |
+| **Offline** | Works offline | Requires internet |
 
 ---
 
@@ -428,11 +227,19 @@ Contributions welcome! Check out our [Contributing Guide](CONTRIBUTING.md).
 git clone https://github.com/jkenley/glance-cli.git
 cd glance-cli
 bun install
-bun dev https://example.com
+bun dev https://www.ayiti.ai
 ```
 
 ---
 
+## ☕ Support
+
+I built this in my spare time because I wanted a better way to read web content from my terminal. If you find it useful and want to support continued development, you can [buy me a coffee](https://ko-fi.com/jkenley). It's completely optional—the tool will always be free and open source regardless.
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/jkenley)
+
+---
+
 ## 📄 License
 
 MIT License - see [LICENSE](LICENSE) for details.
@@ -444,7 +251,6 @@ MIT License - see [LICENSE](LICENSE) for details.
 - **GitHub**: [github.com/jkenley/glance-cli](https://github.com/jkenley/glance-cli)
 - **NPM**: [npmjs.com/package/glance-cli](https://www.npmjs.com/package/glance-cli)
 - **Issues**: [github.com/jkenley/glance-cli/issues](https://github.com/jkenley/glance-cli/issues)
-- **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
 ---