ankit 0.1.0

Complete async Rust client for the AnkiConnect API
Documentation

ankit

A complete, async-first Rust client for the AnkiConnect API.

Crates.io Documentation License

Features

  • Complete API coverage - 79 AnkiConnect actions implemented (~85% coverage)
  • Async-first - Built on reqwest and tokio
  • Type-safe - Strongly typed request/response types with serde
  • Ergonomic - Fluent API with action groups (client.notes(), client.decks(), etc.)
  • Well-documented - Comprehensive doc comments and examples

Quick Start

Add to your Cargo.toml:

[dependencies]
ankit = "0.1"
tokio = { version = "1", features = ["rt-multi-thread", "macros"] }

use ankit::{AnkiClient, NoteBuilder};

#[tokio::main]
async fn main() -> ankit::Result<()> {
    let client = AnkiClient::new();

    // Check connection
    let version = client.misc().version().await?;
    println!("AnkiConnect version: {}", version);

    // List decks
    let decks = client.decks().names().await?;
    println!("Decks: {:?}", decks);

    // Add a note
    let note = NoteBuilder::new("Default", "Basic")
        .field("Front", "What is the capital of France?")
        .field("Back", "Paris")
        .tag("geography")
        .build();

    let note_id = client.notes().add(note).await?;
    println!("Created note: {}", note_id);

    Ok(())
}

Action Groups

Operations are organized into logical groups:

Group Description Examples
client.cards() Card operations find, info, suspend, unsuspend, forget
client.decks() Deck management create, delete, names, stats, config
client.gui() GUI control browse, add_cards, show_answer
client.media() Media files store, retrieve, list, delete
client.models() Note types names, field_names, templates, create
client.notes() Note operations add, find, update, delete, add_tags
client.statistics() Study stats cards_reviewed_today, reviews_by_day
client.misc() Utilities version, sync, profiles, multi

Examples

Find and inspect cards

// Find due cards
let due = client.cards().find("is:due").await?;

// Get card details
let info = client.cards().info(&due[..10]).await?;
for card in info {
    println!("{}: {} reps, {} lapses", card.card_id, card.reps, card.lapses);
}

Work with media

use ankit::StoreMediaParams;

// Store from base64
let params = StoreMediaParams::from_base64("audio.mp3", base64_data);
client.media().store(params).await?;

// Store from URL
let params = StoreMediaParams::from_url("image.png", "https://example.com/image.png");
client.media().store(params).await?;

// List media files
let files = client.media().list("*.mp3").await?;

Batch operations

use ankit::actions::MultiAction;

let actions = vec![
    MultiAction::new("deckNames"),
    MultiAction::new("modelNames"),
    MultiAction::with_params("findNotes", serde_json::json!({"query": "deck:Default"})),
];

let results = client.misc().multi(&actions).await?;

Client Configuration

use std::time::Duration;
use ankit::AnkiClient;

let client = AnkiClient::builder()
    .url("http://localhost:8765")  // Custom URL
    .api_key("your-api-key")       // If AnkiConnect requires auth
    .timeout(Duration::from_secs(60))
    .build();

Related Crates

  • ankit-engine - High-level workflows (import, export, analyze, organize)
  • ankit-builder - TOML-based deck builder with .apkg generation
  • ankit-mcp - MCP server for AI assistant integration

Requirements

  • Anki with AnkiConnect add-on installed
  • AnkiConnect running (Anki must be open)
  • Rust 1.85+ (Edition 2024)

License

Licensed under either of:

at your option.