Study Buddy

Interactive study assistant that creates flashcards, quizzes, and spaced repetition reviews from any source material (notes, PDFs, photos, text, URLs). Use w...

Security Scan

The skill's description promises PDF/URL/photo extraction and multilingual processing, but the included files only implement local deck management — key extraction/fetching capabilities are missing or left vague, so the skill's stated capabilities and its actual code/instructions are not fully consistent.

Purpose & Capability

Name/description promise: extract from PDFs, photos, URLs, detect language, and process a variety of inputs. Actual requirements and code: only python3 is required and the repository includes a deck_manager.py that only creates/manages JSON decks and scheduling. There is no code that performs web fetching, PDF parsing, OCR, or language detection. This mismatch means either the LLM is expected to do extraction or the skill is incomplete.

Instruction Scope

SKILL.md instructs the agent to 'Extract and analyze the content' from URLs, PDFs, photos and to 'fetch content' per references/guidelines.md, but the provided runtime code does not implement fetching/OCR/parsing. The instructions are somewhat open-ended about how to obtain and process inputs (implies network access and file parsing may be needed). The skill also stores decks under ~/.openclaw/study-buddy/decks (clear and expected), but there is no explicit guidance about handling sensitive content.

Install Mechanism

No install spec (instruction-only) and only python3 is required. Nothing is downloaded or written beyond the provided script; low installation risk.

Credentials

No environment variables, credentials, or external config paths are requested. Storage location is local (~/.openclaw/study-buddy/decks) which is proportionate for a flashcard manager.

Persistence & Privilege

Skill is not always-enabled and does not request elevated privileges. It writes its own deck files under a user-local path, which is expected for this purpose.

What to consider before installing

What to consider before installing: - The skill promises automatic extraction from URLs, PDFs, and photos, but the included code only manages flashcard decks locally. Expect the agent to either ask you to paste text or rely on the language model to extract/interpret content rather than running OCR or fetching pages itself. If you need automatic PDF/URL/photo processing, ask the developer for explicit code (e.g., use of requests, pdfminer/pypdf, pytesseract) or a clear statement that the model will not fetch/process files. - Decks are stored unencrypted as JSON under ~/.openclaw/study-buddy/decks. Do not store sensitive personal data or secrets in cards unless you accept local plaintext storage. - The skill requires only python3 and no credentials, which is good. Still be cautious about supplying URLs or uploads — the agent might fetch or summarize external pages depending on its runtime environment and network permissions. - If you want to trust this skill more: request the author to include or document the extraction pipeline (which libraries are used, whether network access is required, and how uploaded images/PDFs are processed) and to provide tests or a README describing how external inputs are handled. If the missing capabilities are acceptable (you will paste text yourself), the deck manager appears straightforward and low-risk.

AI-powered study assistant that turns any material into interactive learning sessions with flashcards, quizzes, and spaced repetition — delivered through chat.

Core Workflow

1. Create Flashcards from Material

When the user provides study material (text, image, PDF, URL):

1. Extract and analyze the content
2. Identify key concepts, definitions, formulas, dates, and relationships
3. Generate flashcards as Q&A pairs
4. Store them using scripts/deck_manager.py

# Create a new deck
python3 scripts/deck_manager.py create "Biology Exam" --cards '[
  {"q": "What is mitosis?", "a": "Cell division producing two identical daughter cells"},
  {"q": "What are the phases of mitosis?", "a": "Prophase, Metaphase, Anaphase, Telophase (PMAT)"}
]'

# Add cards to existing deck
python3 scripts/deck_manager.py add "Biology Exam" --cards '[
  {"q": "What is meiosis?", "a": "Cell division producing four genetically different gametes"}
]'

Card generation guidelines:

• One concept per card
• Questions should test understanding, not just recall
• Include mnemonics when helpful (e.g., PMAT for mitosis phases)
• For math/science: include both formula cards and application cards
• For languages: include context sentences, not just word translations
• Aim for 10-20 cards per topic section

2. Quiz Session

When the user asks to be quizzed:

# Get cards due for review (spaced repetition)
python3 scripts/deck_manager.py review "Biology Exam"

# Get random quiz (all cards)
python3 scripts/deck_manager.py quiz "Biology Exam" --count 10

Quiz delivery format:

Present one question at a time:

Question 3/10 What are the phases of mitosis?

Wait for the user's answer, then reveal:

Answer: Prophase, Metaphase, Anaphase, Telophase (PMAT)

How did you do? Got it | Partially | Missed it

Record the result:

python3 scripts/deck_manager.py record "Biology Exam" --card-id 2 --result "correct"

Results affect spaced repetition scheduling:

• correct: review interval increases (1d, 3d, 7d, 14d, 30d)
• partial: interval stays the same
• missed: interval resets to 1 day

3. Spaced Repetition Review

When the user starts a study session or asks "what should I review?":

# Check what's due across all decks
python3 scripts/deck_manager.py due

# Review specific deck
python3 scripts/deck_manager.py review "Biology Exam"

Only show cards that are due based on the SM-2 algorithm intervals. After each session, show a summary:

Session complete! Reviewed: 12 cards Correct: 9 | Partial: 2 | Missed: 1 Next review: 3 cards due tomorrow

4. Generate Practice Exam

When the user asks for an exam or test:

python3 scripts/deck_manager.py exam "Biology Exam" --questions 20 --types "multiple_choice,short_answer,true_false"

Generate a mix of question types from the deck:

• Multiple choice (4 options, one correct) -- use other cards' answers as distractors
• True/False -- modify real answers slightly for false statements
• Short answer -- direct questions from flashcards
• Fill in the blank -- remove key terms from answers

5. Deck Management

# List all decks
python3 scripts/deck_manager.py list

# Show deck stats
python3 scripts/deck_manager.py stats "Biology Exam"

# Export deck (share with others)
python3 scripts/deck_manager.py export "Biology Exam"

# Import deck
python3 scripts/deck_manager.py import deck_file.json

# Delete deck
python3 scripts/deck_manager.py delete "Biology Exam"

For guidance on handling different input types (text, photos, PDFs, URLs) and tips for creating effective cards, see references/guidelines.md.

Storage

All decks are stored as JSON in ~/.openclaw/study-buddy/decks/. Each deck file contains cards, review history, and scheduling metadata. See references/data_format.md for the schema.

Multilingual Support

Study Buddy works in any language. Detect the user's language from their message and:

• Generate cards in the same language
• Quiz prompts in the user's language
• Support mixed-language decks (useful for language learning)