Welcome to FlashGenie! This guide will help you install FlashGenie, create your first deck, and experience the power of intelligent spaced repetition learning.
Before installing FlashGenie, make sure you have:
!!! tip “Check Your Python Version”
Open your terminal and run:
```bash
python --version
# or
python3 --version
```
You should see Python 3.8.0 or higher.
=== “Windows”
```cmd
# Open Command Prompt or PowerShell
git clone https://github.com/himent12/FlashGenie.git
cd FlashGenie
pip install -r requirements.txt
```
=== “macOS”
```bash
# Open Terminal
git clone https://github.com/himent12/FlashGenie.git
cd FlashGenie
pip3 install -r requirements.txt
```
=== “Linux”
```bash
# Open Terminal
git clone https://github.com/himent12/FlashGenie.git
cd FlashGenie
pip3 install -r requirements.txt
```
pip install -r requirements.txtTest that FlashGenie is working:
python -m flashgenie --version
You should see: FlashGenie 1.0.0
!!! success “Installation Complete!”
If you see the version number, FlashGenie is successfully installed! 🎉
Let’s start with the sample data to see FlashGenie in action:
# Import the included sample flashcards
python -m flashgenie import assets/sample_data/example_deck.csv --name "Sample Deck"
You should see:
Successfully imported 15 flashcards into deck 'Sample Deck'
# See how FlashGenie automatically organizes your cards
python -m flashgenie collections
This shows you FlashGenie’s smart collections - dynamic groups that automatically categorize your cards!
# Start an adaptive quiz session
python -m flashgenie quiz "Sample Deck"
During the quiz, you’ll experience:
!!! tip “During Your First Quiz”
- Answer honestly - FlashGenie learns from your responses
- Use confidence ratings - they help optimize your learning schedule
- Pay attention to difficulty adjustments - they show FlashGenie adapting to you
- Don't worry about perfect scores - the system optimizes for long-term retention
# See detailed statistics about your learning
python -m flashgenie stats
This shows you comprehensive analytics including:
Now let’s create a deck with your own flashcards!
FlashGenie supports multiple formats with intelligent auto-detection:
=== “CSV Format”
Create a file called `my_flashcards.csv`:
```csv
question,answer,tags
What is the capital of France?,Paris,"geography,europe"
What does CPU stand for?,Central Processing Unit,"technology,computers"
What is photosynthesis?,Process plants use to convert light to energy,"biology,science"
```
=== “TXT Format”
Create a file called `my_flashcards.txt`:
```
Q: What is the capital of Spain?
A: Madrid
Q: What does API stand for?
A: Application Programming Interface
Q: What is machine learning?
A: A subset of AI that learns from data
```
=== “Advanced TXT Format”
FlashGenie supports multiple TXT patterns:
```
Question: What is quantum computing?
Answer: Computing using quantum mechanical phenomena
# Separator-based format
What is blockchain?
---
A distributed ledger technology
# Simple format
What is DNA?
Deoxyribonucleic acid
```
# Import your flashcards
python -m flashgenie import my_flashcards.csv --name "My Study Deck"
# Or import TXT format
python -m flashgenie import my_flashcards.txt --name "My Study Deck"
Let FlashGenie automatically suggest tags based on content:
# Load your deck
python -m flashgenie load "My Study Deck"
# Auto-tag cards based on content analysis
python -m flashgenie autotag
FlashGenie will analyze your card content and suggest relevant tags automatically!
FlashGenie uses a powerful command-line interface. Here are the essential commands:
# Start interactive mode
python -m flashgenie
# You'll see:
FlashGenie > help
In interactive mode, you can use commands without the python -m flashgenie prefix.
| Command | Purpose | Example |
|---|---|---|
list |
Show all decks | python -m flashgenie list |
load <deck> |
Load a specific deck | python -m flashgenie load "My Deck" |
import <file> |
Import flashcards | python -m flashgenie import cards.csv |
quiz [mode] |
Start quiz session | python -m flashgenie quiz |
stats |
View statistics | python -m flashgenie stats |
collections |
Show smart collections | python -m flashgenie collections |
autotag |
Auto-tag current deck | python -m flashgenie autotag |
tags |
Manage tags | python -m flashgenie tags |
help |
Show help | python -m flashgenie help |
FlashGenie offers several quiz modes:
spaced (default): Intelligent spaced repetition with difficulty adjustmentrandom: Questions in random ordersequential: Questions in original orderdifficult: Focus on challenging cards first# Examples
python -m flashgenie quiz # Default spaced repetition
python -m flashgenie quiz --mode random # Random order
python -m flashgenie quiz --mode difficult # Hard cards first
During and after quizzes, FlashGenie provides rich feedback:
Question: What is the capital of France?
Your answer: Paris
✓ Correct!
How confident were you? (1=Very Low, 2=Low, 3=Medium, 4=High, 5=Very High): 4
# FlashGenie may show:
Difficulty adjusted: Difficulty increased slightly based on high accuracy, fast response times
Quiz Session Complete!
=====================================
Questions Answered: 10
Correct Answers: 8 (80%)
Average Response Time: 3.2 seconds
Session Duration: 5 minutes
Cards with Difficulty Adjustments: 3
- "What is photosynthesis?" - Difficulty decreased (struggling)
- "What is DNA?" - Difficulty increased (mastered)
FlashGenie automatically adjusts card difficulty based on:
!!! info “Why Difficulty Matters”
Difficulty adjustment ensures:
- **Optimal Challenge**: Cards stay at the right difficulty level
- **Efficient Learning**: Focus time on cards that need it
- **Reduced Frustration**: Hard cards become easier over time
- **Accelerated Progress**: Easy cards become more challenging
Congratulations! You’ve successfully:
!!! warning “Python Version Error”
**Error**: `python: command not found`
**Solution**: Try `python3` instead of `python`, or install Python from [python.org](https://python.org)
!!! warning “Permission Error”
**Error**: `Permission denied` or `Access denied`
**Solution**:
- On Windows: Run Command Prompt as Administrator
- On macOS/Linux: Use `pip3 install --user -r requirements.txt`
!!! warning “Module Not Found”
**Error**: `ModuleNotFoundError: No module named 'pandas'`
**Solution**: Ensure you ran `pip install -r requirements.txt` in the FlashGenie directory
If you’re still having issues:
Ready to dive deeper? Continue to Smart Features to discover what makes FlashGenie truly intelligent! 🧞♂️✨