AnkiTutor

AI tutor for your Anki cards — explain concepts and clarify doubts during review, using the card's own context.

Demo

Review a card → click Ask AI (or Ctrl+Shift+T) → type a question → watch the streamed, Markdown-rendered answer → Save to note.

Why?

Studying with Anki is repetition. AnkiTutor adds a layer of comprehension: the AI explains the card based on what is on its front and back.

Installation

• AnkiWeb: (submitted — awaiting review)
• Manual: clone this repo into addons21/anki-tutor:

  git clone https://github.com/MpSantana31/AnkiTutor.git \
    ~/Anki2/addons21/anki-tutor
  

• Set your API key in Tools → AnkiTutor → Config.

Supported providers

Your data: only the card's front and back text plus your question are sent to the LLM provider. No personal info (deck names, review stats, etc.) is transmitted. Your API key is stored locally by Anki and never committed to the repository. The add-on makes no external calls besides the LLM provider API.

Architecture (overview)

• Strategy + Factory for LLM providers (LLMProvider).
• Error Boundary so Anki never crashes (TutorError + subclasses).
• 100% testable without network (FakeProvider in tests).

Support / Apoie

If AnkiTutor helps your study, consider supporting its development. Se o AnkiTutor te ajuda a estudar, considere apoiar o desenvolvimento.

Support via Crypto (Web3)

If you prefer to support using cryptocurrencies, send EVM-compatible tokens to: Se preferir apoiar com criptomoedas, envie tokens compatíveis com EVM para:

EVM Address (Ethereum, Polygon, Arbitrum, Optimism): 0x370D0C7d3105677138C3719722239fB2A03dC9C8

<img src="assets/crypto-qr.png" alt="EVM donation QR" width="200" />

Please double-check the address and network before sending. / Confira o endereço e a rede antes de enviar.

For developers

The addon lives in anki-tutor/. Quality is enforced by CI: ruff (lint + format) and pytest with coverage. See the architecture and ADRs in the repository.

License

MIT — see LICENSE.

AnkiTutor (Português)

Tutor de IA para seus cards do Anki — explique conceitos e tire dúvidas durante a revisão, com o contexto do próprio card.

Demo

Revise um card → clique Tirar dúvida (ou Ctrl+Shift+T) → digite uma pergunta → veja a resposta em streaming renderizada em Markdown → Salvar na nota.

Por que?

Estudar com Anki é repetir. O AnkiTutor adiciona uma camada de compreensão: a IA explica o card com base no que está na frente e no verso.

Instalação

• AnkiWeb: (submetido — aguardando revisão)
• Manual: clone este repositório em addons21/anki-tutor:

  git clone https://github.com/MpSantana31/AnkiTutor.git \
    ~/Anki2/addons21/anki-tutor
  

• Configure sua API key em Ferramentas → AnkiTutor → Config.

Provedores suportados

Seus dados: apenas o texto da frente e do verso do card mais sua pergunta são enviados ao provedor de LLM. Nenhuma informação pessoal (nomes de baralho, estatísticas de revisão, etc.) é transmitida. Sua chave de API é armazenada localmente pelo Anki e nunca é versionada no repositório. O addon não faz nenhuma chamada externa além da API do provedor de LLM.

Arquitetura (resumo)

• Strategy + Factory para provedores de LLM (LLMProvider).
• Error Boundary para não crashear o Anki (TutorError + subclasses).
• 100% testável sem rede (FakeProvider nos testes).

Para devs

O addon vive em anki-tutor/. Qualidade é garantida por CI: ruff (lint + format) e pytest com cobertura. Veja a arquitetura e os ADRs no repositório.

Support / Apoie

If AnkiTutor helps your study, consider supporting its development. Se o AnkiTutor te ajuda a estudar, considere apoiar o desenvolvimento.

Apoio via Cripto (Web3)

If you prefer to support using cryptocurrencies, send EVM-compatible tokens to: Se preferir apoiar com criptomoedas, envie tokens compatíveis com EVM para:

EVM Address (Ethereum, Polygon, Arbitrum, Optimism): 0x370D0C7d3105677138C3719722239fB2A03dC9C8

<img src="assets/crypto-qr.png" alt="EVM donation QR" width="200" />

Please double-check the address and network before sending. / Confira o endereço e a rede antes de enviar.

Licença

MIT — veja LICENSE.