Complete Command Reference.md - himent12/FlashGenie GitHub Wiki

📚 Complete Command Reference

This comprehensive reference documents all FlashGenie CLI commands with examples and usage patterns.

🎯 Command Structure

FlashGenie commands follow this general structure:

python -m flashgenie <command> [arguments] [options]

For example:

python -m flashgenie quiz "Spanish Vocabulary" --mode spaced --limit 20

🧠 Core Commands

Quiz Commands

Command Description Example
quiz Start a quiz session python -m flashgenie quiz "Spanish"
review Review due cards python -m flashgenie review "Biology"
plan Create study plan python -m flashgenie plan "Math" --time 30
practice Quick practice session python -m flashgenie practice "French" --time 10

Quiz Options

# Basic quiz with default settings
python -m flashgenie quiz "Spanish Vocabulary"

# Spaced repetition mode with card limit
python -m flashgenie quiz "Biology" --mode spaced --limit 20

# Focus on difficult cards
python -m flashgenie quiz "Math" --mode difficult --confidence-threshold 3

# Time-limited session
python -m flashgenie quiz "History" --time-limit 15 --priority due

Deck Management

Command Description Example
list List all decks python -m flashgenie list
create Create new deck python -m flashgenie create "New Deck"
delete Delete a deck python -m flashgenie delete "Old Deck"
rename Rename a deck python -m flashgenie rename "Deck" "New Name"
merge Merge decks python -m flashgenie merge "Deck1" "Deck2" "Combined"
split Split a deck python -m flashgenie split "Big Deck" --by-tag

Deck Examples

# Create a new deck
python -m flashgenie create "French Vocabulary"

# List all decks with statistics
python -m flashgenie list --stats

# Merge multiple decks
python -m flashgenie merge "Spanish Basics" "Spanish Advanced" "Spanish Complete"

# Split deck by difficulty
python -m flashgenie split "Math" --by-difficulty --output-prefix "Math-"

Card Management

Command Description Example
add Add a card python -m flashgenie add "Q" "A" --deck "Deck"
edit Edit a card python -m flashgenie edit 123 --question "New Q"
delete-card Delete a card python -m flashgenie delete-card 123
search Search for cards python -m flashgenie search "keyword"
tag Manage card tags python -m flashgenie tag 123 --add "grammar"

Card Examples

# Add a new card
python -m flashgenie add "What is photosynthesis?" "The process by which plants convert light to energy" --deck "Biology"

# Edit an existing card
python -m flashgenie edit 123 --question "Updated question" --answer "Updated answer"

# Search for cards containing keyword
python -m flashgenie search "mitochondria" --deck "Biology"

# Add tags to a card
python -m flashgenie tag 123 --add "important,exam,difficult"

📊 Analytics Commands

Statistics

Command Description Example
stats View statistics python -m flashgenie stats "Spanish"
progress View progress python -m flashgenie progress "Math" --period 30
velocity Learning velocity python -m flashgenie velocity "French" --predict
heatmap Activity heatmap python -m flashgenie heatmap --year 2023

Statistics Examples

# View basic statistics for a deck
python -m flashgenie stats "Spanish Vocabulary"

# View detailed progress over time
python -m flashgenie progress "Biology" --period 90 --chart

# Analyze learning velocity with predictions
python -m flashgenie velocity "Math" --predict --confidence-interval 0.9

# Generate activity heatmap
python -m flashgenie heatmap --year 2023 --export heatmap.html

Advanced Analytics

Command Description Example
analyze Deep analysis python -m flashgenie analyze "Spanish" --full
predict Predictive analytics python -m flashgenie predict mastery-timeline "Math"
compare Compare decks python -m flashgenie compare "Deck1" "Deck2"
trends Identify trends python -m flashgenie trends "Biology" --period 90
# Perform comprehensive deck analysis
python -m flashgenie analyze "Spanish" --full --export analysis.pdf

# Predict mastery timeline
python -m flashgenie predict mastery-timeline "Math" --target 0.9

# Compare learning across multiple decks
python -m flashgenie compare "Spanish" "French" "German" --metric accuracy

# Identify learning trends
python -m flashgenie trends "Biology" --period 90 --metric difficulty

🔄 Data Management

Import/Export

Command Description Example
import Import cards python -m flashgenie import cards.csv --deck "New"
export Export cards python -m flashgenie export "Spanish" --format csv
backup Create backup python -m flashgenie backup create
restore Restore backup python -m flashgenie backup restore backup.zip

Import/Export Examples

# Import from CSV file
python -m flashgenie import flashcards.csv --deck "New Deck" --delimiter ","

# Import from Anki
python -m flashgenie import-anki anki_export.apkg --preserve-scheduling

# Export to CSV
python -m flashgenie export "Spanish" --format csv --output spanish_cards.csv

# Export to JSON with metadata
python -m flashgenie export "Biology" --format json --include-metadata

Backup & Restore

# Create a full backup
python -m flashgenie backup create --compress --encrypt

# Create a selective backup
python -m flashgenie backup create --decks "Spanish,French" --output custom_backup.zip

# Restore from backup
python -m flashgenie backup restore backup_2023-06-15.zip

# List available backups
python -m flashgenie backup list

🎨 Customization

Configuration

Command Description Example
config Manage config python -m flashgenie config set quiz.default_mode spaced
theme Change theme python -m flashgenie theme set dark
alias Create aliases python -m flashgenie alias create q quiz
defaults Set defaults python -m flashgenie defaults set --deck "Spanish"

Configuration Examples

# View current configuration
python -m flashgenie config list

# Set configuration value
python -m flashgenie config set quiz.default_mode spaced

# Reset configuration to defaults
python -m flashgenie config reset

# Create command alias
python -m flashgenie alias create q "quiz --mode spaced --limit 20"

🧩 Smart Features

AI Features

Command Description Example
suggest Get suggestions python -m flashgenie suggest "Spanish" --cards 5
autotag Auto-tag cards python -m flashgenie autotag "Biology"
graph Knowledge graph python -m flashgenie graph "Math" --type network
optimize Optimize deck python -m flashgenie optimize "History"

AI Feature Examples

# Get card suggestions
python -m flashgenie suggest "Spanish" --cards 5 --difficulty medium

# Auto-tag all cards in a deck
python -m flashgenie autotag "Biology" --confidence 0.7

# Generate knowledge graph
python -m flashgenie graph "Math" --type network --depth 3 --export graph.html

# Optimize deck structure
python -m flashgenie optimize "History" --reorder --suggest-splits

Collections

Command Description Example
collections List collections python -m flashgenie collections
create-collection Create collection python -m flashgenie create-collection "Hard Cards"
update-collection Update collection python -m flashgenie update-collection "Hard Cards"
delete-collection Delete collection python -m flashgenie delete-collection "Old Collection"
# List all smart collections
python -m flashgenie collections

# Create a custom collection
python -m flashgenie create-collection "Exam Prep" --filter "tag:exam AND difficulty>0.6"

# Study using a collection
python -m flashgenie quiz --collection "Struggling Cards"

# Update collection criteria
python -m flashgenie update-collection "Exam Prep" --filter "tag:exam AND difficulty>0.5"

🛠️ System Commands

Maintenance

Command Description Example
update Check for updates python -m flashgenie update
repair Repair database python -m flashgenie repair
clean Clean temporary files python -m flashgenie clean
version Show version python -m flashgenie version
# Check for FlashGenie updates
python -m flashgenie update

# Repair database issues
python -m flashgenie repair --thorough

# Clean temporary files
python -m flashgenie clean --all

# Show version information
python -m flashgenie version --verbose

Help & Documentation

Command Description Example
help Show help python -m flashgenie help quiz
examples Show examples python -m flashgenie examples quiz
tutorial Interactive tutorial python -m flashgenie tutorial
completion Shell completion python -m flashgenie completion bash
# Get help for a specific command
python -m flashgenie help quiz

# See examples for a command
python -m flashgenie examples import

# Start interactive tutorial
python -m flashgenie tutorial --topic "Getting Started"

# Generate shell completion
python -m flashgenie completion bash > ~/.bash_completion.d/flashgenie

🎮 Interactive Mode

Enter interactive mode for a shell-like experience:

# Start interactive mode
python -m flashgenie

FlashGenie > load "Spanish Vocabulary"
Loaded deck "Spanish Vocabulary" (150 cards)

FlashGenie > stats
[Statistics displayed]

FlashGenie > quiz --mode spaced --limit 20
[Quiz starts]

FlashGenie > exit

🚀 Next Steps


FlashGenie v1.5.0 | Last updated: June 2025

⚠️ **GitHub.com Fallback** ⚠️