Skip to content

getting-started.md

Latest commit

 

History

History
65 lines (47 loc) · 1.25 KB

getting-started.md

File metadata and controls

65 lines (47 loc) · 1.25 KB

Getting Started

Get up and running with Email Agent in 5 minutes.

Prerequisites

  • Python 3.13+
  • Ollama installed with llama3.2:1b model
  • Gmail account with Gmail API access

Quick Setup

1. Install Dependencies

cd email-agent
uv sync

2. Run Interactive Setup

python -m email_agent setup

This will:

  • Guide you through Gmail OAuth setup
  • Create initial config.yaml
  • Verify Ollama connection

3. Edit Configuration

Open config.yaml and customize:

agent:
  categories:
    - "Work"
    - "Personal"
    - "Finance"
  important_senders:
    - "[email protected]"
    - "@family.com"

4. Run the Agent

python -m email_agent

Running Modes

Mode Command Description
Continuous python -m email_agent Polls every 60 seconds
Once python -m email_agent --once Process emails, then exit
Dry Run python -m email_agent --dry-run Simulate without changes
Verbose python -m email_agent --verbose DEBUG logging

Next Steps