https://github.com/gaussfff/anki-multitool
Just useful tool for Anki users
https://github.com/gaussfff/anki-multitool
anki anki-cli anki-multitool anki-utils cli multitool utils
Last synced: 5 days ago
JSON representation
Just useful tool for Anki users
- Host: GitHub
- URL: https://github.com/gaussfff/anki-multitool
- Owner: gaussfff
- License: mit
- Created: 2025-06-29T20:58:06.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-07-23T23:23:38.000Z (10 months ago)
- Last Synced: 2025-07-24T01:27:17.605Z (10 months ago)
- Topics: anki, anki-cli, anki-multitool, anki-utils, cli, multitool, utils
- Language: Rust
- Homepage:
- Size: 2.29 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# anki-multitool (anki-mtool)
Anki-Multitool (Anki-MTool) - just useful multitool for Anki users. What it can do:
- Export decks to JSON and Markdown files 🃏 -> 📄
- Import decks from JSON and Markdown files 📄 -> 🃏
- List all decks in your Anki collection 📋
- Create a new deck ➕🃏
- To be continued... ⏩
## Requirements
- [Rust 1.88.0+ (*only if you are installing from source*)](https://www.rust-lang.org/tools/install)
- [Anki 25.02.7+](https://apps.ankiweb.net/)
- [AnkiConnect plugin with API version 6+](https://ankiweb.net/shared/info/2055492159)
- [OpenSSL 3.5.0+ (*only for Linux users*)](https://openssl.org/)
## Installation
You can install manually by cloning the repository and running the following command:
```bash
sudo chmod +x install.sh
./install.sh
```
Or install through [Homebrew](https://brew.sh/) (MacOS only):
```bash
brew tap gaussfff/anki-multitool
brew install anki-multitool
```
Details about homebrew formula you can find [here](https://github.com/gaussfff/homebrew-anki-multitool).
## Shell Completions
Fish shell completions are available to provide command suggestions and autocompletion.
### Fish Shell Setup
Script will automatically install completions for the Fish shell. After installation, restart your fish shell or run `fish` to activate completions.
You'll now get suggestions when typing `anki-mtool` commands.
## Usage
`anki-mtool [options]`
### Available commands
- `anki-mtool help [command]` - show help for a command or list all commands
- `anki-mtool info` - 📝 show description about anki-multitool
- `anki-mtool version` - 🏷️ show the version of anki-multitool
- `anki-mtool decklist` - 📋 list all decks in your Anki collection
- `anki-mtool newdeck ` - ➕🃏 create a new deck in Anki, if deck exists, it will return error
- `anki-mtool json2deck ` - 📄 -> 🃏 import a deck from a JSON file into Anki, if deck exists, it will return error
- `anki-mtool deck2json ` - 🃏 -> 📄 export a deck from Anki to a JSON file, if file exists, it will return error
- `anki-mtool md2deck ` - 📄 -> 🃏 import a deck from a Markdown file into Anki, if deck exists, it will return error
- `anki-mtool deck2md ` - 🃏 -> 📄 export a deck from Anki to a Markdown file, if file exists, it will return error
## Custom host and port
You can define custom host and port for the server by setting the environment variables `ANKI_MULTITOOL_HOST` and `ANKI_MULTITOOL_PORT`. For example, you can run the following command in your terminal:
```bash
export ANKI_MULTITOOL_HOST=""
export ANKI_MULTITOOL_PORT=""
```
By default, tool will listening on `localhost:8765`.
## Formats
Anki-multitool supports two formats for importing and exporting decks: JSON and Markdown. Full examples you can find in [`examples`](https://github.com/gaussfff/anki-multitool/tree/master/resources/examples) directory.
### JSON format
Name of file is deck name, so if you want to export deck named "My Deck" to JSON file, it will be saved as `my_deck.json`.
Vice versa, if you want to import deck from JSON file, the name of the deck will be taken from the file name (without extension).
If deck doesn't exist in Anki, it will be created automatically.
Here is example of JSON format used for importing and exporting decks:
```json
[
{
"front": "What is the capital of Ukraine?",
"back": "Kyiv"
},
{
"front": "What is the capital of Germany?",
"back": "Berlin"
}
]
```
### Markdown format
Name of file is deck name, so if you want to export deck named "My Deck" to Markdown file, it will be saved as `my_deck.md`.
Vice versa, if you want to import deck from Markdown file, the name of the deck will be taken from the file name (without extension).
If deck doesn't exist in Anki, it will be created automatically.
Here is an example of Markdown formats used for importing and exporting decks:
```markdown
1. What is the capital of Ukraine? - Kyiv
2. What is the capital of Germany? - Berlin
```
and
```markdown
- What is the capital of Ukraine? - Kyiv
- What is the capital of Germany? - Berlin
```
## License
This software is under the MIT license. See details in [license file](https://github.com/gaussfff/anki-multitool/blob/master/LICENSE-MIT).
## Contribution
So-so, just create issue or PR, I will try to fix or approve it as soon as possible 😉