Crossbill Anki Plugin

Import flash card questions from Crossbill to Anki.
For Crossbill highlight service, see the Crossbill-web repository
Installation
Follow installation instructions on Anki addon page
Configuration
Initial Setup
- In Anki, go to Tools β Crossbill Settings
- Enter your Crossbill server URL (e.g.,
http://localhost:8000)
- Click Test Connection to verify it works
- Click Save
See config.md for detailed configuration documentation.
Development
Setup
This plugin uses Poetry for dependency management and code quality tools.
cd clients/anki-plugin
# Install dependencies (creates .venv in project directory)
poetry install
# Run code quality checks
poetry run ruff format --check . # Check formatting
poetry run ruff format . # Auto-format
poetry run ruff check . # Lint
poetry run ruff check --fix . # Auto-fix lint issues
poetry run pyright # Type checking
Install local version to Anki
-
Clone or download the Crossbill repository
-
Locate your Anki add-ons directory:
- Windows:
%APPDATA%\Anki2\addons21\
- Mac:
~/Library/Application Support/Anki2/addons21/
- Linux:
~/.local/share/Anki2/addons21/
-
Copy the plugin folder to the Anki addon folder by running:
./install.sh
-
Restart Anki
-
The plugin should appear in Tools β Add-ons
Testing
- Make changes to the plugin code
- Restart Anki to reload the plugin
- Test functionality through the UI
- Check Anki's console for error messages (Tools β Add-ons β View Files)
Debugging
Enable Anki's debug console:
- Help β About β Copy Debug Info (to see Python version and Anki version)
- Tools β Add-ons β [Select Crossbill] β View Files (to see plugin directory)
- Check
~/.local/share/Anki2/addons21/crossbill/ for log files
Contributing
Contributions are welcome!
License
See the main Crossbill repository for details.
Acknowledgments
- Built for Anki, the powerful spaced repetition software
- Part of the Crossbill project