anki-helper

Getting Started

Get sentence definitions

Add new sentences to further practice

Installation

you can install this project with go

go install github.com/MarcusXavierr/anki-helper@latest

Configuration

To use the CLI, you must provide two files: one to save the sentences you have yet to learn and add to Anki, and another to store the sentences you have already added to Anki.

There are two ways to specify the file paths in the CLI. You can pass them as flags with every command you run, or you can configure a file called .anki-config in your home folder.

The .anki-config file allows you to set default options for the CLI, including the file paths for the sentences you have yet to learn and the sentences you have already added to Anki. By using this file, you can avoid passing the file paths as flags with every command, which can be useful if you frequently use the same file paths.

Overall, the CLI offers flexibility in how you choose to provide the file paths, making it easy for you to use it in the way that best fits your needs.

Configuration storage file paths

Here, I'll show the two ways to set your anki helper storage file paths. Remember to use your own paths.

Using flags

Setting your storage file paths with flags is pretty easy. Just use -n in the file where you'll store unknown sentences, and -t to store learned sentences.

anki-helper add "unknown sentence" -n "/tmp/new_sentences_file.txt" -t "/tmp/learned_sentences_file.txt"

Using a configuration file

Create a file called .anki-config.toml in your home folder. Then put this content there

new-words-file-path="/tmp/new_sentences_file.txt"
trash-file-path="/tmp/learned_sentences_file.txt"

Usage

Add word to further practice

You can run this command to add a word to your track file

anki-helper add 'sentence'

Get definition

you can also use the command dictionary to get the definitions of a sentence (works for words and phrasal verbs)

anki-helper dictionary 'sentence'