# Anki Forge

> Anki Forge generates Anki APKG decks from code using Rust, Node / TypeScript or Python.

Current public package version: 0.3.1. Exporting a deck does not require Anki. The APIs available in published packages differ from those in source builds. For updates, keep the original APKG from the previous release; Anki import settings and newer local edits can affect the result.

- Rust: `cargo add ankiforge@0.3.1` (Rust 1.92+)
- Node / TypeScript: `npm install --include=optional ankiforge@0.3.1` (Node.js 22.13+)
- Python: `python -m pip install ankiforge==0.3.1` (CPython 3.11+)

## Start here

- [Build Anki decks from code](https://ankiforge.dev/docs/index.md): Choose a language, build your first deck, and learn how to add media, templates and repeatable updates.
- [Choose your language](https://ankiforge.dev/docs/languages/index.md): Install the public Rust, Node or Python package and export your first Anki deck.
- [Compatibility and releases](https://ankiforge.dev/docs/compatibility/index.md): Published packages, verified environments and Anki client conditions.

## Quickstarts

- [Generate Anki flashcards with Rust](https://ankiforge.dev/docs/quickstart/index.md): Install the public Rust package, write a Spanish flashcard, and export a persistent APKG file.
- [Generate Anki flashcards with Node.js](https://ankiforge.dev/docs/node-quickstart/index.md): Install ankiforge from npm, generate Anki flashcards with Node.js or TypeScript, and export an APKG deck you can import into Anki.
- [Generate Anki flashcards with Python](https://ankiforge.dev/docs/python-quickstart/index.md): Install ankiforge from PyPI, generate Anki flashcards with a short Python script, and export an APKG deck you can import into Anki.

## API references

- [Public API overview](https://ankiforge.dev/docs/api/index.md): Explore Anki Forge APIs for Rust, Python and Node.js: create notes, package images and audio, diagnose failures, and compare deck updates before distribution.
- [Rust API guide](https://ankiforge.dev/docs/rust-api/index.md): Find public authoring methods, build defaults, reports and diagnostic behavior.
- [Node and TypeScript API](https://ankiforge.dev/docs/node-api/index.md): Public methods, async behavior, build options and reports.
- [Python API](https://ankiforge.dev/docs/python-api/index.md): Project, media, build options, reports and temporary artifact ownership.

## Task guides

- [CSV to Anki: generate flashcards with Python](https://ankiforge.dev/docs/csv-to-anki/index.md): Convert a UTF-8 vocabulary spreadsheet to an Anki APKG with a complete Python script, sample CSV, stable note IDs and import checks.
- [Generate and update Anki decks from JSON](https://ankiforge.dev/docs/json-to-anki/index.md): Read JSON with Rust, Python or TypeScript, package images and audio, then review an answer-only APKG update.
- [AI-assisted Anki flashcards: from notes to APKG](https://ankiforge.dev/docs/ai-anki-cards/index.md): Draft Anki cards with an AI assistant, review the answers, then export an APKG using Anki Forge. Follow a CSV workflow or use a coding-assistant brief.
- [Generate Anki Basic and Cloze flashcards](https://ankiforge.dev/docs/cards/index.md): Generate Anki Basic question-and-answer and Cloze fill-in-the-blank cards from code. A verified Rust example builds two notes and three cards.
- [Add images and audio to Anki cards](https://ankiforge.dev/docs/media/index.md): Add images and audio to generated Anki cards with Rust, Python or Node.js. Import files, compose card content, and manage export names, MIME types and budgets.
- [Reusable Anki card templates, CSS and media](https://ankiforge.dev/docs/templates/index.md): Load a reusable Anki note type from one bundle of card templates, CSS and media, for normal or Cloze cards, with Rust, Python or Node.js.
- [Generate Anki Image Occlusion cards](https://ankiforge.dev/docs/image-occlusion/index.md): Create Anki Image Occlusion cards programmatically from an image and the rectangle masks you supply, in either occlusion mode, with Rust, Python or Node.js.
- [Update Anki decks with stable note IDs](https://ankiforge.dev/docs/updates/index.md): Release a new version of a generated Anki deck: keep stable note IDs, build from the previous original APKG and review the comparison before publishing.

## Constraints

- [Build and output guarantees](https://ankiforge.dev/docs/build-guarantees/index.md): Understand temporary artifacts, path protection and candidate publication.
- [Troubleshooting](https://ankiforge.dev/docs/troubleshooting/index.md): Resolve installation, media, template, identity and output errors.

## Optional

- [Anki Forge vs genanki: choose for your workflow](https://ankiforge.dev/docs/anki-forge-vs-genanki/index.md): Compare Anki APKG authoring workflows, runtime requirements, update review and migration costs.
- [Move from genanki](https://ankiforge.dev/docs/genanki-migration/index.md): Understand content, template and media behavior when moving to Anki Forge.
- [Build SDKs from source](https://ankiforge.dev/docs/development/index.md): Development/source environment. Build SDKs and examples from a source checkout.
- [Build your first Anki deck with Rust](https://ankiforge.dev/blog/your-first-anki-deck/index.md): Historical article, published 2026-09-22. Build your first Anki deck with a complete Rust example: create a Spanish flashcard, export and import an APKG, and assign stable note keys for future updates.
- [A note’s identity should outlive its wording](https://ankiforge.dev/blog/stable-ids-and-deck-updates/index.md): Historical article, published 2026-09-22. How stable IDs and a build baseline work together when you update a generated Anki deck.
- [GitHub](https://github.com/morehardy/anki-forge): Source repository and development resources.
- [简体中文](https://ankiforge.dev/zh-cn/llms.txt): 简体中文 AI documentation index.
- [Español](https://ankiforge.dev/es/llms.txt): Español AI documentation index.
- [Português do Brasil](https://ankiforge.dev/pt-br/llms.txt): Português do Brasil AI documentation index.
- [日本語](https://ankiforge.dev/ja/llms.txt): 日本語 AI documentation index.
- [Deutsch](https://ankiforge.dev/de/llms.txt): Deutsch AI documentation index.