Clanki is a command-line interface (CLI) application for managing flashcards. It allows users to create, manage and study flashcards to assist them with memorisation by using a technique called spaced repetition.
Ensure you have Java 11 or above installed.
Download the latest version of Clanki from here.
Copy the file to the folder you want to use as the home folder for Clanki.
Open a command terminal, cd into the folder you put the jar file in, and
use the java -jar clanki.jar command to run the application. You should be
greeted with Welcome to Clanki! Time to start studying! after a few
seconds.
Type the command in the command box and press Enter to execute it. Some example commands you can try:
add /q what is the worst fruit? /a durian: Add a flashcard with
Question:
What is the worst fruit? and Answer: Durian to the list of flashcards.
review: Go through the flashcards that are due today.
bye: Exit the app.
Refer to the Features below for details of each command.
Square brackets indicate optional sections of the syntax.
add /q QUESTION /a ANSWER
QUESTION will be displayed when reviewing. For how the reviewing process
works, see “Review flashcards” section below.
Since a slash character (/) can be interpreted as a command option, both
QUESTION and ANSWER must not include (/). (In some of the times, /
might still work normally, that’s just you being lucky.)
/q QUESTION and /a ANSWER can be arranged in any order.
The first letter of QUESTION and ANSWER are automatically capitalised.
If any options are duplicated, all but the last one are ignored.
The question and answer can include non-Latin characters such as Chinese characters. However, your terminal might have trouble displaying it. If you need such characters, find a terminal that supports it. A relatively modern terminal (more modern than cmd.exe) should do, or buy a Mac since the default Mac terminal does support it.
add /q What is the worst fruit? /a Durian
You have added the following card:
Q: What is the worst fruit?
A: Durian
add /a 果物 /q What is the Japanese word for "fruit"?
You have added the following card:
Q: What is the Japanese word for "fruit"?
A: 果物
review
Flashcards that are due on the day will be displayed one after another, queued in a secret order.
When the user has recalled the answer for a card, or has given up on doing so, they can then press Enter.
The app will then show the answer and ask the user if they got it right. They
can then type y/n to indicate that they remembered the answer correctly,
or they couldn’t remember the correct answer, respectively.
y is indicated, the card is then set to a new due date in the
future.When the user has got it correct, the new date is set to a future
date according to a top-secret
Spaced repetition
schedule that you can try to figure out if you want to explore mysteries.n is indicated, the card is pushed back to the today’s queue for
reviewing later, until the user can get it correct.y or n is indicated, it will be regarded as an
invalid command, and then the user will be prompted again to enter a valid
answer.Then the review session continues with the next card in the queue.
> review
There are 2 cards available for review today.
---
Q: What is the worst fruit? (ENTER to view answer)
A: Durian
Did you get it right? (y/n) n
No worries, we will try again later today.
---
Q: What is the Japanese word for "fruit"? (ENTER to view answer)
A: 果物
Did you get it right? (y/n) y
Great, you got it right!
---
Q: What is the worst fruit? (ENTER to view answer)
A: Durian
Did you get it right? (y/n) y
Great, you got it right!
---
Congrats! You have reviewed all the flashcards due today!
update QUERY
QUERY is part of the card’s question or answer. It is not case sensitive.
A list of cards that contain this query will be listed, with an index assigned to each.
The user can then type the index of the card they wish to update with the following syntax
INDEX [/q NEW_QUESTION] [/a NEW_ANSWER]
At least one of /q and /a must be provided.
Format of NEW_QUESTION and NEW_ANSWER is the same as in the add command
above.
update fruit
Found 2 card(s) with query "fruit":
[1]
Q: What is the worst fruit?
A: Durian
[2]
Q: What is the Japanese word for "fruit"?
A: 果物
Which one do you want to update?
1 /q What is the best fruit?
Understood. The card has been updated to
Q: What is the best fruit?
A: Durian
delete QUERY
QUERY can be part of the card’s question or answer.
A list of cards that contain this query will be listed, with an index assigned to each.
The user can then type the index of the card they wish to delete. The card with that index (on that list) is then deleted.
delete fruit
Found 2 card(s) with query "fruit":
[1]
Q: What is the best fruit?
A: Durian
[2]
Q: What is the Japanese word for "fruit"?
A: 果物
Which one do you want to delete?
2
Got it. Deleted the flashcard at index 2
clear
Delete all the flashcards in the list.
clear
All flashcards have been deleted.
Your list of flashcards is now empty.
list all
Display the questions and answers for all the flashcards in the list that have been added by the user, regardless of the date.
list all
Here is your list of flashcards:
[1]
Q: What is the biggest animal in the world
A: Antartic blue whale
[2]
Q: What are the best food for health
A: Lemons
[3]
Q: What colour is the sun
A: Red
list DUE_DATE
Display the questions and answers for all the flashcards in the list that has the due date specified by the user
DUE_DATE has to be in the format yyyy-mm-ddlist 2023-04-15
Here is your list of flashcards:
[1]
Q: What is the biggest animal in the world
A: Antartic blue whale
[2]
Q: What are the best food for health
A: Lemons
[3]
Q: What colour is the sun
A: Red
help
Display the list of possible commands the user can input.
help
The following are the commands you can use:
add Adds a flashcard to the current list of flashcards.
Parameters: add /q QUESTION /a ANSWER
Example: add /q What is the worst fruit? /a Durian
update Changes the content of flashcard's question or answer.
Parameters: update QUERY
Example: update fruit
Which flashcard do you want to update? 1 /q What is the best fruit?
delete Removes a flashcard with specified string.
Parameters: delete QUERY
Example: delete fruit
review Go through all flashcards that are due today.
list Lists out the questions and answers in the list of flashcards.
Parameters: list all (lists all flashcards)
Parameters: list DUE_DATE (list all flashcards with that specified due date)
Example: list 2023-05-04
clear Deletes all the flashcards in the list.
bye Exit the program.
bye
Exit the program. Bye.