raven-agent 0.1.0

Raven — AI-assisted learning companion. Auto-detect materials, split by chapters, generate quizzes, organize notes.

Raven — AI Learning Companion

Huginn (Thought) & Muninn (Memory) — the two ravens of Odin, now your study partners.

Raven is a CLI agent that helps you study. Drop it into any directory with learning materials, and it:

• Reads PDFs, Word docs, PowerPoints
• Splits materials into chapters (PDF slices or Markdown)
• Summarizes content with AI
• Quizzes you on what you've learned (✓/△/✗ grading)
• Organizes your rough notes into polished documents

Quick Start

pip install raven-agent
# Set your DeepSeek API key
$env:DEEPSEEK_API_KEY = "sk-..."
# Run in any directory with learning materials
Raven

Requirements

• Python >= 3.10
• DeepSeek API key (set as DEEPSEEK_API_KEY environment variable)

Directory Structure

Raven creates two directories in your working folder:

./
├── muninn/                  # Memory — structured knowledge
│   ├── chapters/            #   Chapter splits
│   ├── summaries/           #   AI-generated summaries
│   └── knowledge/           #   Extracted terminology
└── huginn/                  # Thought — active learning
    ├── 章节检测/             #   Chapter quizzes
    └── 学习笔记/             #   Study notes

Commands

Command	Action
/help	Show help
/mode read|yn|auto	Change permission mode
/clear	Reset conversation
/exit	Quit
Ctrl+C	Interrupt agent

License

MIT