diff --git a/README.md b/README.md index 054a20b0..6f6268e7 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,38 @@ uv run jarvis ask "What is the capital of France?" `jarvis init` auto-detects your hardware and recommends the best engine. Run `uv run jarvis doctor` at any time to diagnose issues. +## Starter Configs + +Copy a config to `~/.openjarvis/config.toml` to get started with a pre-built use case. Each config includes the model, agent, tools, and connectors you need. + +| Use Case | Config | What it does | +|----------|--------|-------------| +| **Morning Digest** | [`morning-digest-mac.toml`](configs/openjarvis/examples/morning-digest-mac.toml) | Daily spoken briefing from your email, calendar, health tracker, and news — delivered by a Jarvis-style AI voice | +| **Morning Digest (minimal)** | [`morning-digest-minimal.toml`](configs/openjarvis/examples/morning-digest-minimal.toml) | Just Gmail + Calendar, runs on any machine | +| **Morning Digest (Linux)** | [`morning-digest-linux.toml`](configs/openjarvis/examples/morning-digest-linux.toml) | For Linux servers with GPU | + +```bash +# Example: set up Morning Digest on Mac +cp configs/openjarvis/examples/morning-digest-mac.toml ~/.openjarvis/config.toml +jarvis connect gdrive # one OAuth flow covers Gmail, Calendar, Tasks +jarvis digest --fresh # generate and play your first briefing +``` + +### Built-in Agents + +| Agent | Type | What it does | +|-------|------|-------------| +| `morning_digest` | Scheduled | Daily briefing from email, calendar, health, news — with TTS audio | +| `deep_research` | On-demand | Multi-hop research with citations across web and local docs | +| `monitor_operative` | Continuous | Long-horizon monitoring with memory, compression, and retrieval | +| `orchestrator` | On-demand | Multi-turn reasoning with automatic tool selection | +| `native_react` | On-demand | ReAct (Thought-Action-Observation) loop agent | +| `operative` | Continuous | Persistent autonomous agent with state management | +| `native_openhands` | On-demand | CodeAct — generates and executes Python code | +| `simple` | On-demand | Single-turn chat, no tools | + +See the [User Guide](https://open-jarvis.github.io/OpenJarvis/user-guide/morning-digest/) and [Tutorials](https://open-jarvis.github.io/OpenJarvis/tutorials/) for detailed setup instructions. + Full documentation — including Docker deployment, cloud engines, development setup, and tutorials — at **[open-jarvis.github.io/OpenJarvis](https://open-jarvis.github.io/OpenJarvis/)**. ## Contributing diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 10f7fcfc..2f5f2ac8 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -45,8 +45,33 @@ OpenJarvis is a modular AI assistant framework. Here's what developers build wit # Now use any OpenAI-compatible client ``` +=== "Morning Digest" + + ```bash + cp configs/openjarvis/examples/morning-digest-mac.toml ~/.openjarvis/config.toml + jarvis connect gdrive # one OAuth flow for Gmail, Calendar, Tasks + CARTESIA_API_KEY="..." jarvis digest --fresh + # Plays a spoken daily briefing with your email, calendar, health, and news + ``` + For complete copy-paste patterns, see [Code Snippets](snippets.md). +## Starter Configs + +Copy one of these to `~/.openjarvis/config.toml` to get a pre-configured setup: + +| Config | For | What it does | +|--------|-----|-------------| +| [`morning-digest-mac.toml`](https://github.com/open-jarvis/OpenJarvis/blob/main/configs/openjarvis/examples/morning-digest-mac.toml) | Mac (Apple Silicon) | Daily spoken briefing from email, calendar, health, news | +| [`morning-digest-linux.toml`](https://github.com/open-jarvis/OpenJarvis/blob/main/configs/openjarvis/examples/morning-digest-linux.toml) | Linux / GPU server | Same, with vLLM support | +| [`morning-digest-minimal.toml`](https://github.com/open-jarvis/OpenJarvis/blob/main/configs/openjarvis/examples/morning-digest-minimal.toml) | Any machine | Just Gmail + Calendar | + +Or generate a config with digest included: + +```bash +jarvis init --digest +``` + This guide walks through the core workflows of OpenJarvis: the browser app, CLI, Python SDK, agents with tools, memory, benchmarks, and the API server. !!! info "Prerequisites"