Seamlessly interact via code or CLI with AnkiConnect, a plugin for the Anki flashcard application.
MIT License
Elixir-AnkiConnect is a powerful Elixir library that provides a convenient and elegant way to interact with the AnkiConnect extension for Anki, a popular spaced repetition flashcard application. This library encapsulates the complexities of communicating with AnkiConnect, allowing developers to effortlessly create functions for various Anki operations within their Elixir applications.
Note: Before using Elixir-AnkiConnect, ensure that you have the AnkiConnect extension installed and activated in your Anki application. AnkiConnect provides the necessary API for communication with Anki. Instructions on how to install and activate the AnkiConnect extension can be found in the Anki documentation or on the official AnkiConnect website.
To use AnkiConnect in your Elixir project, simply add it as a dependency in your mix.exs
file:
defp deps do
[
{:anki_connect, "~> 0.1.1"}
]
end
After updating your mix.exs
file, run mix deps.get
to fetch the library.
To use Elixir-AnkiConnect as a standalone CLI tool, you can install it globally using mix archive. Ensure you have Elixir and Mix installed on your system, and then run the following command:
mix archive.install hex anki_connect
This command will download and install the Elixir-AnkiConnect archive globally on your system.
Once installed, you can execute the CLI tasks using the mix anki_connect ...
command. For example:
mix anki_connect add_notes_from_file --file="words.md" --deck="TEST DECK"
Contributions, bug reports, and feature requests are welcome! If you encounter any issues or have any questions about using AnkiConnect, please feel free to open an issue on the GitHub repository.
Elixir AnkiConnect is licensed under the MIT License. See the LICENSE file for more details.