VINCA(1)

NAME
vinca - simple spaced repetition

SYNOPSIS
Vinca is a command line flashcard program. It is used to create and review information according to the principles of spaced repetition.

TL;DR

vinca 2
    create a simple question and answer card

vinca r
    review your collection of cards

QUICKSTART
Use vinca b to open the browser. Then read the BROWSER HOTKEYS section.

BROWSER HOTKEYS

  Navigation
j       scroll down one card
k       scroll up one card
q       close the browser

  Hotkeys which effect the selected card (usually lowercase)
e       edit the card
d       delete the card
r       review the card
s       summarize the card
t       edit the card's tags
+       postpone the card until tomorrow
E       edit the card's metadata
M       print the card's metadata

  Hotkeys which effect the collection of cards (uppercase)
R       review all cards
D       delete all cards
T       edit tags for all cards
C       count all cards

TUTORIAL

  Main Idea: the NOUN VERB syntax
Vinca uses a NOUN VERB syntax. The two kinds of nouns are a collection of cards and a specific card.

  Examples of NOUN VERB syntax.

vinca col browse
    col is the noun; it refers to the entire collection of cards. browse is the verb; it launches the browser for this collection of cards.

vinca col review
    col is the noun; review is the verb.

vinca lc edit
    lc is the noun; it refers to the most recently created card ("last-card") edit is the verb; this command will edit the most recently created card

vinca lc delete
    lc is the noun; it refers to the most recently created card ("last-card") delete is the verb; this command will delete the card we just created

  Chaining
If the output of a command is a noun we can apply a verb to it.

  Examples of Chaining

vinca col sort --due-date browse
    col sort --due-date returns a list of cards sorted by due-date. We then open a browser with these cards to browse these cards sorted by due-date.

vinca col findall Lincoln - delete
    col findall Lincoln returns a list of cards containing the word Lincoln. This command will delete all of them.

  Indexing
We can refer to a card by its position in a collection. NOTE: indicies begin at 0 not 1.

  Examples of Indexing
Suppose vinca findall Lincoln returns the following list of cards:

    - Who is the 16th American president? | Lincoln
    - What was Lincoln's first name? | Abraham

Then we can reference these cards by their index:

    * `vinca findall Lincoln - 1 delete`:
        This will erase the card asking for Lincoln's first name.
    * `vinca findall Lincoln - 0 review`:
        This will review the first card.

  Exceptions to the NOUN VERB syntax
The most import abbreviation is the ommission of col.

    - `vinca purge` is equivalent `vinca col purge`
    - `vinca count` is equivalent to `vinca col count`

The set-cards-path command is used to specify a directory which vinca will search for cards.

  Learning More
Read through vinca col --help and vinca lc --help to learn all the possible subcommands for collections and cards.

AUTHOR
olaird25@gmail.com