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

1. In Anki, go to Tools → Crossbill Settings
2. Enter your Crossbill server URL (e.g., http://localhost:8000)
3. Click Test Connection to verify it works
4. 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

1. Clone or download the Crossbill repository

2. Locate your Anki add-ons directory:

   • Windows: %APPDATA%\Anki2\addons21\
   • Mac: ~/Library/Application Support/Anki2/addons21/
   • Linux: ~/.local/share/Anki2/addons21/

3. Create a symbolic link or copy the plugin folder:

   cp -r . ~/.local/share/Anki2/addons21/crossbill # linux
   

4. Restart Anki

5. The plugin should appear in Tools → Add-ons

Testing

1. Make changes to the plugin code
2. Restart Anki to reload the plugin
3. Test functionality through the UI
4. Check Anki's console for error messages (Tools → Add-ons → View Files)

Debugging

Enable Anki's debug console:

1. Help → About → Copy Debug Info (to see Python version and Anki version)
2. Tools → Add-ons → [Select Crossbill] → View Files (to see plugin directory)
3. 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