Personal AI, On Personal Devices
Python
docs: add Morning Digest quickstart guide + example configs
Jon Saad-Falconf45f7b426c9d
diff --git a/configs/openjarvis/examples/morning-digest-linux.toml b/configs/openjarvis/examples/morning-digest-linux.tomlnew file mode 100644index 00000000..6da636d7--- /dev/null+++ b/configs/openjarvis/examples/morning-digest-linux.toml@@ -0,0 +1,51 @@+# Morning Digest — Linux / Cloud GPU with Ollama or vLLM+# Copy to ~/.openjarvis/config.toml and customize+#+# Requirements:+# - Ollama or vLLM running locally+# - Cartesia or OpenAI API key for TTS++[engine]+default = "ollama"+# default = "vllm" # Use vLLM for GPU servers++[engine.ollama]+host = "http://localhost:11434"++# [engine.vllm]+# host = "http://localhost:8001"++[intelligence]+default_model = "qwen3.5:9b"++[agent]+default_agent = "simple"++[tools]+enabled = ["code_interpreter", "web_search", "file_read", "shell_exec", "digest_collect", "text_to_speech"]++# ─── Morning Digest ─────────────────────────────────────────++[digest]+enabled = true+schedule = "0 7 * * *"+timezone = "America/New_York" # Change to your timezone+persona = "jarvis"+honorific = "sir"+tts_backend = "openai" # OpenAI TTS works everywhere+voice_id = "onyx" # Deep male voice+voice_speed = 1.1++sections = ["health", "messages", "calendar", "world"]++[digest.health]+sources = ["oura"]++[digest.messages]+sources = ["gmail", "google_tasks", "slack"]++[digest.calendar]+sources = ["gcalendar"]++[digest.world]+sources = ["hackernews", "news_rss", "weather"]diff --git a/configs/openjarvis/examples/morning-digest-mac.toml b/configs/openjarvis/examples/morning-digest-mac.tomlnew file mode 100644index 00000000..ffdf6bc6--- /dev/null+++ b/configs/openjarvis/examples/morning-digest-mac.toml@@ -0,0 +1,56 @@+# Morning Digest — Mac (Apple Silicon) with Ollama+# Copy to ~/.openjarvis/config.toml and customize+#+# Requirements:+# - Ollama installed (https://ollama.com)+# - ollama pull qwen3.5:9b+# - Cartesia API key (https://play.cartesia.ai) or OpenAI API key++[engine]+default = "ollama"++[intelligence]+default_model = "qwen3.5:9b" # Good balance of speed + quality on M1/M2/M3+# default_model = "qwen3.5:4b" # Faster, lower quality+# default_model = "qwen3.5:35b" # Slower, higher quality (needs 32GB+ RAM)++[agent]+default_agent = "simple"++[tools]+enabled = ["code_interpreter", "web_search", "file_read", "shell_exec", "digest_collect", "text_to_speech"]++# ─── Morning Digest ─────────────────────────────────────────++[digest]+enabled = true+schedule = "0 7 * * *" # 7 AM daily+timezone = "America/Los_Angeles" # Change to your timezone+persona = "jarvis"+honorific = "sir" # "sir", "ma'am", "boss", or any custom+tts_backend = "cartesia" # "cartesia" or "openai"+voice_id = "c8f7835e-28a3-4f0c-80d7-c1302ac62aae" # Alistair (British male)+voice_speed = 1.2 # 1.0 = normal, 1.2 = 20% faster++# Sections in order of priority (remove any you don't want):+sections = ["health", "messages", "calendar", "world"]++[digest.health]+sources = ["oura"] # Add "apple_health" if you export from iPhone+# sources = ["oura", "apple_health", "strava"]++[digest.messages]+sources = ["gmail", "google_tasks", "imessage"]+# Add any of: "slack", "notion", "github_notifications"++[digest.calendar]+sources = ["gcalendar"]++[digest.world]+sources = ["hackernews", "news_rss"]+# Add "weather" after setting up OpenWeatherMap API key++# ─── Optional: Music section ────────────────────────────────+# Uncomment and add "music" to sections list above+# [digest.music]+# sources = ["spotify", "apple_music"]diff --git a/configs/openjarvis/examples/morning-digest-minimal.toml b/configs/openjarvis/examples/morning-digest-minimal.tomlnew file mode 100644index 00000000..12c49dac--- /dev/null+++ b/configs/openjarvis/examples/morning-digest-minimal.toml@@ -0,0 +1,31 @@+# Morning Digest — Minimal setup (just Ollama + Gmail)+# The simplest possible config to get a working digest.+# Copy to ~/.openjarvis/config.toml+#+# Requirements:+# - Ollama installed with any model+# - Google OAuth credentials (jarvis connect gdrive)+# - OpenAI API key for TTS (or skip audio with --text-only)++[engine]+default = "ollama"++[intelligence]+default_model = "qwen3.5:4b" # Small, fast, runs on any machine++[tools]+enabled = ["digest_collect", "text_to_speech"]++[digest]+enabled = true+persona = "jarvis"+honorific = "sir"+tts_backend = "openai"+voice_id = "onyx"+sections = ["messages", "calendar"]++[digest.messages]+sources = ["gmail"]++[digest.calendar]+sources = ["gcalendar"]diff --git a/docs/user-guide/morning-digest.md b/docs/user-guide/morning-digest.mdnew file mode 100644index 00000000..25a0fe98--- /dev/null+++ b/docs/user-guide/morning-digest.md@@ -0,0 +1,218 @@+# Morning Digest++A personalized daily briefing that collects data from your connected services, synthesizes a spoken narrative with a local LLM, and delivers it as audio via text-to-speech.++## Quickstart (5 minutes)++### 1. Install and set up OpenJarvis++```bash+git clone https://github.com/open-jarvis/OpenJarvis.git+cd OpenJarvis+uv sync --extra dev+```++### 2. Start a local LLM via Ollama++```bash+# Install Ollama: https://ollama.com+ollama pull qwen3.5:9b # or any model you prefer+```++### 3. Configure the digest++Edit `~/.openjarvis/config.toml`:++```toml+[engine]+default = "ollama"++[intelligence]+default_model = "qwen3.5:9b"++[digest]+enabled = true+schedule = "0 6 * * *" # 6 AM daily (cron syntax)+timezone = "America/Los_Angeles"+persona = "jarvis"+honorific = "sir" # or "ma'am", "boss", etc.+tts_backend = "cartesia" # or "openai"+voice_id = "c8f7835e-28a3-4f0c-80d7-c1302ac62aae" # Alistair (British male)+voice_speed = 1.2+sections = ["health", "messages", "calendar", "world"]++[digest.health]+sources = ["oura"]++[digest.messages]+sources = ["gmail", "google_tasks", "slack", "imessage"]++[digest.calendar]+sources = ["gcalendar"]++[digest.world]+sources = ["weather", "hackernews", "news_rss"]+```++### 4. Connect your data sources++```bash+# Google (one flow covers Gmail, Calendar, Tasks, Contacts, Drive)+jarvis connect gdrive+# Paste: <client_id>:<client_secret> — browser opens automatically++# Oura Ring (personal access token)+jarvis connect oura+# Paste your token from https://cloud.ouraring.com/personal-access-tokens++# Spotify+jarvis connect spotify++# Strava+jarvis connect strava+```++For Weather, GitHub, and News — save credential files directly:++```bash+# Weather (OpenWeatherMap — free at https://openweathermap.org/api)+echo '{"api_key": "YOUR_KEY", "location": "San Francisco,CA,US"}' > ~/.openjarvis/connectors/weather.json++# GitHub notifications (token from https://github.com/settings/tokens)+echo '{"token": "ghp_YOUR_TOKEN"}' > ~/.openjarvis/connectors/github.json++# News RSS (no auth needed — configure your feeds)+cat > ~/.openjarvis/connectors/news_rss.json << 'EOF'+{"feeds": [+ {"name": "Arxiv CS.AI", "url": "https://rss.arxiv.org/rss/cs.AI"},+ {"name": "TechCrunch", "url": "https://techcrunch.com/feed/"},+ {"name": "Bloomberg", "url": "https://feeds.bloomberg.com/markets/news.rss"},+ {"name": "WSJ", "url": "https://feeds.a.dj.com/rss/RSSWorldNews.xml"}+]}+EOF+```++Hacker News, iMessage, and Apple Music work automatically on macOS with no setup.++### 5. Set your TTS API key++```bash+# Cartesia (sign up at https://play.cartesia.ai)+export CARTESIA_API_KEY="sk_car_..."++# Or OpenAI (https://platform.openai.com/api-keys)+export OPENAI_API_KEY="sk-proj-..."+```++### 6. Run your first digest++```bash+CARTESIA_API_KEY="sk_car_..." jarvis digest --fresh+```++The digest will:+1. Collect data from all connected sources+2. Synthesize a spoken briefing with Qwen3.5 9B+3. Generate audio with the Cartesia Alistair voice+4. Print the text and play the audio++## CLI Commands++```bash+jarvis digest --fresh # Generate a new digest now+jarvis digest # Show today's cached digest+jarvis digest --text-only # Print text without audio+jarvis digest --history # Show past digests+jarvis digest --schedule "0 6 * * *" # Set daily schedule+jarvis digest --schedule off # Disable schedule+jarvis digest --schedule # Show current schedule+```++## Saying "Good morning"++When chatting with Jarvis (via CLI, desktop, or browser), saying "Good morning" or "morning digest" automatically triggers the digest — no need to use the `digest` command explicitly.++## Configuration Reference++### Sections++The `sections` list controls what the digest covers, in order of priority:++| Section | Sources | What it provides |+|---------|---------|-----------------|+| `health` | `oura`, `apple_health`, `strava` | Sleep, readiness, activity, workouts |+| `messages` | `gmail`, `google_tasks`, `slack`, `notion`, `imessage`, `github_notifications` | Email triage, tasks, texts, Slack, PRs |+| `calendar` | `gcalendar` | Today's events and schedule |+| `world` | `weather`, `hackernews`, `news_rss` | Weather forecast, tech news, RSS feeds |+| `music` | `spotify`, `apple_music` | Recently played tracks (opt-in) |++### TTS Voices++**Cartesia** (recommended — natural, expressive):+| Voice | ID | Description |+|-------|----|-------------|+| Alistair | `c8f7835e-28a3-4f0c-80d7-c1302ac62aae` | Sophisticated British male |+| Benedict | `3c0f09d6-e0d7-499c-a594-70c5b7b93048` | Polished, formal British male |+| Harrison | `df89f42f-f285-4613-adbf-14eedcec4c9e` | Crisp, professional British male |+| Sterling | `b134c304-d095-4d2b-a77a-914f5e8e84e7` | Deep, commanding, dignified |++**OpenAI TTS**:+| Voice | Description |+|-------|-------------|+| `onyx` | Deep male |+| `nova` | Female, warm |+| `alloy` | Neutral |+| `shimmer` | Female, expressive |++### Persona++The `persona` field loads a prompt file from `configs/openjarvis/prompts/personas/{name}.md`. The default `jarvis` persona delivers briefings with dry British wit, prioritizes urgent items, and interprets health data as trends rather than raw numbers.++To create a custom persona, add a new `.md` file in the personas directory.++### News Feeds++Add any RSS or Atom feed to `~/.openjarvis/connectors/news_rss.json`:++```json+{"feeds": [+ {"name": "Arxiv CS.AI", "url": "https://rss.arxiv.org/rss/cs.AI"},+ {"name": "Arxiv CS.LG", "url": "https://rss.arxiv.org/rss/cs.LG"},+ {"name": "NYT Top Stories", "url": "https://rss.nytimes.com/services/xml/rss/nyt/HomePage.xml"},+ {"name": "TechCrunch", "url": "https://techcrunch.com/feed/"},+ {"name": "Bloomberg Markets", "url": "https://feeds.bloomberg.com/markets/news.rss"},+ {"name": "WSJ World News", "url": "https://feeds.a.dj.com/rss/RSSWorldNews.xml"},+ {"name": "Hacker News", "url": "https://hnrss.org/frontpage"}+]}+```++## API Endpoints++The digest is also available via the FastAPI server:++```bash+jarvis serve # Start the server++# GET /api/digest — Get today's digest text+# GET /api/digest/audio — Stream the digest audio (MP3)+# POST /api/digest/generate — Force re-generation+# GET /api/digest/history — Past digests+# GET /api/digest/schedule — Current schedule config+# POST /api/digest/schedule — Update schedule {"enabled": true, "cron": "0 6 * * *"}+```++## Frontend++The desktop and browser apps show an inline audio player when a digest is generated. The "Connect" buttons in the setup wizard handle OAuth flows automatically — click to connect, authorize in the browser popup, done.++## Troubleshooting++**"No digest for today"** — Run `jarvis digest --fresh` to generate one.++**Empty sections** — Check connector status with `jarvis connect --list`. Ensure tokens haven't expired (Google/Spotify tokens expire after 1 hour and are auto-refreshed on next use).++**Weather not working** — OpenWeatherMap API keys can take up to 2 hours to activate after creation. Use the format `City,State,Country` (e.g., `Palo Alto,CA,US`).++**GitHub 403** — Your personal access token needs the `notifications` permission under Account permissions (not Repository permissions).++**Audio not playing** — Ensure `CARTESIA_API_KEY` or `OPENAI_API_KEY` is set. Check credits at https://play.cartesia.ai or https://platform.openai.com.