This repository has been archived by the owner on Mar 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Config
Kirill Salnikov edited this page Apr 22, 2021
·
15 revisions
Config file contained inside package folder and named config.ini
.
-
defaults.profile
- Anki profile to which cards will be added. If you haven't provided value for this option and you have multiple profiles, inka will ask you which profile should it use at startup. This option doesn't have default value. -
defaults.deck
- Anki deck to use, if you didn't specify deck for the section. Default value isDefault
. -
defaults.folder
- the path to the folder which is used if you don't pass thePATH
argument tocollect
command. This option doesn't have default value. -
anki.basic_type
- the name of the note type used to create Front/Back cards. The default value isBasic
. -
anki.front_field
- the name of the front field of the Front/Back note type. The default value isFront
. -
anki.back_field
- the name of the back field of the Front/Back note type. The default value isBack
. -
anki.cloze_type
- the name of the note type used to create Cloze cards. The default value isCloze
. -
anki.cloze_field
- the name of the field of the Cloze note type. The default value isText
. -
anki_connect.port
- the port used by Anki Connect. The default value is8765
. -
highlight.style
- style that is used to highlight code blocks. The default value ismonokai
.
You can interact with the config via the config
command.
To list all config options, use the -l/--list
flag:
inka config -l
Example output:
defaults.profile =
defaults.deck = Default
defaults.folder =
anki.basic_type = Basic
anki.front_field = Front
anki.back_field = Back
anki.cloze_type = Cloze
anki.cloze_field = Text
anki_connect.port = 8765
highlight.style = monokai
To see value of an individual option, pass its name as the argument:
inka config defaults.deck
Example output:
Default
To change the value of the option, pass the options name as the first argument and the new value as the second:
inka config defaults.folder /home/user/my_folder
To reset the config to its default state, use -r/--reset
flag:
inka config -r