Ankiniki helps create, manage and study Anki notes from the terminal, VS Code and a Tauri desktop application. The current collection and review scheduling are managed by Anki through AnkiConnect.
The next milestone is compatible import/export: preserve Anki note fields, HTML, tags and model names when exchanging JSON. Independent local collections, shared mobile screens and scheduling come after the exchange format is reliable.
The intended learning uses also include private audio-assisted practice and public exercises embedded in technical articles, with Anki downloads generated from the same lesson source. Static browser sessions can come before independent collections. The v1 lesson format, offline validation and stable Anki packages with audio are implemented. Shared plain-text practice cards and a standalone Storybook are available; playback, the widget and Web publishing are planned.
| Component | Implementation | Current role |
|---|---|---|
| CLI | TypeScript, Commander | Note/deck management, import/export, study, AnkiWeb sync |
| Shared | TypeScript, Zod | AnkiConnect client, parsers, types and validation |
| Backend | Express | Import, AI integration and desktop API |
| Desktop | Tauri 2, Rust, React, Hozo/Vite | Decks, card creation, study and settings |
| VS Code | TypeScript extension | Selection/code cards and file generation |
| ML service | Python, FastAPI | Optional content processing and generation |
| Mobile | Planned React Native + Hozo | Shared screens; no mobile application exists yet |
Tauri's Rust layer currently handles settings and menus. Desktop data operations still call the Express backend. Most screens still use DOM elements; installing Hozo's build plugin alone does not make them reusable on React Native.
Install mise and Git, then run from the repository root:
mise trust
mise install
mise exec -- npm run setupThe pinned versions are in mise.toml. Native desktop development also needs
Rust and Tauri's OS prerequisites.
See development environment.
For real Anki operations, install AnkiConnect (Anki add-on code 2055492159)
and keep Anki running. Automated tests use mocks and do not require Anki.
After building, use mise exec -- node apps/cli/dist/index.js ... or optionally
link the CLI with mise exec -- npm link -w apps/cli to use ankiniki directly.
ankiniki note add "Programming" "What is a closure?" "A function with access to its enclosing scope"
ankiniki note import cards.json --preview
ankiniki export "Programming" programming.json --format json
ankiniki bundle cards.json cards.apkg
ankiniki content validate docs/examples/content/basic-practice/content.json --public
ankiniki content export docs/examples/content/basic-practice/content.json practice.apkg --modified-at 2026-10-14T12:00:00Z --public
ankiniki study "Programming" --due
ankiniki syncsync triggers Anki's AnkiWeb sync. bundle creates an APKG from source files
without running Anki. JSON currently represents note content, not a full
collection backup; use Anki's native package export when scheduling or full
collection fidelity is required.
See CLI commands, JSON import and the exchange design for the current limits.
Run in separate terminals:
mise exec -- npm run dev -w packages/backend
mise exec -- npm run dev -w apps/desktopmise exec -- npm run dev:frontend -w apps/desktop opens a frontend development
server on port 1420. The backend defaults to port 3001 and AnkiConnect to 8765.
The native app and browser preview have different origins; configure backend
CORS for the origin being used.
mise exec -- npm run ciInstall bundled Chromium first with
mise exec -- npm exec -- playwright install --no-shell chromium (add
--with-deps on Linux). This builds the packages, extension, Storybook and desktop
frontend, type-checks, lints, checks formatting and runs shared/backend/CLI and
real-browser practice-card tests. Native app packaging
is separate: mise exec -- npm run build:app -w apps/desktop.
- Documentation index
- Development guide
- Compatibility-first architecture
- Anki exchange contract
- Content, audio practice and public article widgets
- Lesson format and offline validation
- Shared practice cards and Storybook
- Lesson APKG export and update rules
- Current roadmap
The original strategy is historical context, not a description of current features. This project is distributed under the MIT License.