arete 1.0.0

A robust, fast, and feature-rich CLI for syncing Obsidian vault to Anki.

Arete (formerly o2a)

Pro-grade synchronization from Obsidian to Anki.

arete is a robust, fast, and feature-rich tool that adheres to a strict One-Way Sync philosophy: Obsidian is the Source of Truth.

graph TD
    subgraph "Obsidian Vault"
        MD["Markdown Files"]
        Media["Images/Files"]
    end

    subgraph "Sync Component (Arete)"
        CLI["Python CLI"]
        Plugin["Obsidian Plugin (GUI wrapper)"]
        Cache[("SQLite Cache")]
    end

    subgraph "Anki"
        AC["AnkiConnect / apy"]
        CollectionMedia["collection.media (Filesystem)"]
        Cards["Anki Decks"]
    end

    MD --> Plugin
    Plugin -- "Invokes" --> CLI
    CLI <--> Cache
    CLI -- "Pushes Notes" --> AC
    CLI -- "Copies Media" --> CollectionMedia
    AC --> Cards

---

📚 Documentation

• CLI Guide: Command-line usage, configuration, and syntax.
• Obsidian Plugin Guide: Installation and usage of the Obsidian plugin.
• Architecture: Deep dive into how it works.
• Troubleshooting: Common fixes for WSL, networking, and sync issues.

---

Quick Start

1. Install CLI (Python)

Ensure you have uv installed.

git clone https://github.com/Adanato/obsidian_2_anki
cd obsidian_2_anki
uv sync

2. Install Plugin (Optional)

Download main.js, manifest.json, styles.css from Releases and place in .obsidian/plugins/obsidian-2-anki.

3. Initialize & Sync

uv run arete init   # Set up your vault path
uv run arete sync   # First sync (will scan and link cards)

Key Features

• ⚡ Fast: SQLite caching skips unchanged files, making syncs near-instant.
• 🧹 Prune Mode: Automatically removes cards from Anki that you've deleted in Obsidian.
• 🩹 Self-Healing: Fixes duplicate IDs or broken links automatically.
• 📐 MathJax/LaTeX: Native protection for complex mathematical notation.
• 📸 Media Support: Full synchronization of local images and attachments.
• 💻 WSL Friendly: Specialized bridge for Windows Subsystem for Linux users.

License

MIT

Roadmap

• Community Plugin: Official Obsidian Community Plugins list submission.
• PyPI Release: Publish as obsianki via uv publish.
• Cloud Sync: Research remote sync strategies.