ki API documentation

submited by

Style Pass

2024-10-27 06:00:04

Ki is a command-line interface for the version control and editing of .anki2 collections as git repositories of markdown files. Rather than providing an interactive UI like the Anki desktop client, ki aims to allow natural editing in the filesystem.

In general, the purpose of ki is to allow users to work on large, complex Anki decks in exactly the same way they work on large, complex software projects.

Note. If you're new to Anki, or are unfamiliar with the terms collection, profile, note, or card, you may wish to take a look at the Anki documentation.

If you already know the path to the .anki2 collection file you want to clone, skip to the section on running the clone command.

If you are running Anki 2.1 (which you should be, because ki is not tested with lower versions), opening this directory will reveal several files and subdirectories. The following example output is from a machine running Debian GNU/Linux:

In particular, there is a subdirectory for each profile. In the above example, there is only one profile, User 1. But, in general, there may be many profiles associated with a given Anki installation.