π 3-Minute Quickstart β
Get up and running with Flashcard Master in three minutes. Turn any web article, markdown note, or book chapter into atomic, active-recall flashcards with verified verbatim citations.
β‘ 1. Launch Flashcard Master β
Flashcard Master runs completely locally on your computer as a standalone desktop app, a local browser-bound Web UI, or a scriptable CLI.
Option A: Standalone Desktop App (Recommended for Most Users) β
Download the latest native desktop installer from the Flashcard Master GitHub Releases Page:
| Operating System | Download Formats | Notes |
|---|---|---|
| Windows | Flashcard.Master.Setup.1.3.0.exe (NSIS) or Flashcard.Master.1.3.0.exe (Portable) | 64-bit Windows 10/11 installer or standalone portable binary |
| macOS | Flashcard.Master-1.3.0-universal.dmg, arm64.dmg, x64.dmg | Universal binary supporting Apple Silicon (M1/M2/M3/M4) & Intel |
| Linux | Flashcard.Master-1.3.0.deb or Flashcard.Master-1.3.0.AppImage | Native Debian/Ubuntu .deb package or portable AppImage |
π‘ Windows Defender SmartScreen Note
Because Flashcard Master is a community open-source project without a costly commercial EV code-signing certificate, Windows or Edge may show an "Unrecognized app" or "Isn't commonly downloaded" prompt on new releases:
- In Edge/Chrome: Click
...next to the download β select Keep β click Show more β select Keep anyway. - When opening the installer: On the blue SmartScreen prompt, click the More info link β then click Run anyway.
π macOS Gatekeeper Note
On first launch on macOS, if prompted with "unidentified developer": Open System Settings β Privacy & Security β scroll to Security and click Open Anyway (or right-click the app in /Applications and select Open).
Desktop Benefits:
- Zero Terminal Required: Double-click and run like any native application.
- System Tray Minimization: Keep Flashcard Master running in your background tray/dock without cluttering your workspace.
- Unified Local Storage (
~/.flashcard-master/): Desktop App, Web UI, and CLI all share~/.flashcard-master/(data.sqlite,media/, andlocal-files/) so your sources, documents, and decks stay seamlessly synchronized across every interface. - Ephemeral Port Protection: Binds an internal loopback port dynamically to prevent conflicts with other services.
Option B: Zero-Install (Web UI via NPX) β
You can run the web dashboard immediately using npx without installing anything permanently:
# Launch the interactive terminal setup wizard:
npx @flashcard-master/cli init
# Or launch the local Web UI dashboard directly:
npx @flashcard-master/cli serveThe Web UI dashboard will open automatically in your browser at http://localhost:3000.
Option C: Global CLI Installation β
If you prefer having the flashcard-master command available anywhere in your terminal:
npm install -g @flashcard-master/cliOnce installed, start the dashboard anytime:
flashcard-master serve
# Or point CLI/Web at a custom data directory instead of ~/.flashcard-master/:
flashcard-master --data-dir /path/to/my-kb serveπ 2. Configure Your AI Provider β
Flashcard Master supports 4 cutting-edge AI providers:
| Provider | Recommended Default Model | Ideal Use Case | Setup Requirements |
|---|---|---|---|
| Ollama | phi4-mini | 100% offline, private, zero API fees | Local Ollama daemon running on localhost:11434 |
| Google Gemini | gemini-3.6-flash | Blazing fast, high free-tier limits | Free Google AI Studio API Key |
| OpenAI | gpt-4o-mini | Ultra-reliable, fast synthesis | OpenAI API Key |
| Anthropic | claude-haiku-4-5-20251001 | Sophisticated reasoning, clean formatting | Anthropic API Key |
Setting Up via the Web UI: β
- Navigate to βοΈ Settings in the left sidebar (shortcut:
6). - Under AI Model Configurations, enter your API key or configure your Ollama endpoint URL.
- Click π§ͺ Test Connection to verify your credentials.
- Click πΎ Save Settings.
π 3. Add Your First Data Source β
- Navigate to Data Sources in the sidebar (shortcut:
2ors). - Click β Add Source.
- Choose your source type:
- Web Article: Enter any public article URL (e.g., Wikipedia or technical blog).
- RSS Feed: Enter an Atom/RSS feed URL to periodically auto-sync articles.
- Local File / Book: Upload a
.md,.epub, or.pdfdocument. - Notion Workspace: Connect your Notion page or database.
- Audio / Video / YouTube: Import local
.mp3/.mp4recordings (with optional.srt/.vttsubtitles and timestamp ranges) or YouTube URLs with subtitle-first extraction, Speech-to-Text fallback, and chapter/timestamp slicing.
- Click Save & Ingest. Flashcard Master extracts clean text and breaks it into semantic chapters or chunks automatically.
- On subsequent runs, click β‘ Sync (Sync New Items Only by default) to ingest only new additions and skip already-synced itemsβor open the dropdown (βΎ) to choose Full Re-sync (All Items) (or run
flashcard-master sync --fullin CLI).
β‘ 4. Generate Active-Recall Flashcards β
- Navigate to Generate Studio (shortcut:
3org). - Select Target Scope: Choose your newly ingested document or chapter.
- Configure Generation Parameters:
- Difficulty Level: Choose
Beginner,Intermediate, orAdvanced. - Cognitive Persona: Select a tailored tutor style (e.g. Socratic Tutor, Exam Drill Sergeant, or Analogy Weaver).
- Target Card Count: Specify how many cards to produce (e.g.,
5to20).
- Difficulty Level: Choose
- Click β‘ Start Generation.
- Watch the Task Center drawer stream new cards in real time as the background worker runs synthesis and validates verbatim quote citations!
ποΈ 5. Review & Export β
- Navigate to Question Explorer (shortcut:
4) to view your synthesized cards.- Each card highlights the Source Quote from your material proving zero hallucination.
- Edit, rephrase, or tag individual cards with the inline card editor drawer.
- Navigate to Export & Anki (shortcut:
5ore):- AnkiConnect (1-Click Sync): Push cards straight into your open Desktop Anki application.
- Anki Package (
.apkg): Download a standalone deck file for Anki mobile or desktop. - E-Reader Study Guide (
.epub): Export a styled, chapter-based study book for Kindle, Kobo, or Apple Books. - Markdown / CSV / TSV: Export raw data for Obsidian, Notion, or spreadsheets.
Congratulations! You have completed your first end-to-end active-recall learning workflow.