Skip to content

CLI and programmability-focused memorizing flashcard app.

License

Notifications You must be signed in to change notification settings

rep2recall/r2r-cli

Repository files navigation

r2r-cli

Repeat until recall, with widening intervals, minimal CLI version.

CLI and programmability-focused memorizing flashcard app.

$ r2r --help

Repeat Until Recall - a simple, yet powerful, flashcard app

Usage:
   r2r {flags}
   r2r <command> {flags}

Commands: 
   help                          displays usage informationn
   load                          load the YAML into the database and exit
   version                       displays version number

Flags: 
   -b, --browser                 browser to open (default: Chrome with Edge fallback) (default: .)
   -o, --db                      database to use (default: data.db)
   --debug                       whether to run in debug mode (default: false)
   -f, --file                    files to use (must be loaded first) (default: .)
   --filter                      keyword to filter (default: .)
   -h, --help                    displays usage information of the application or a command (default: false)
   -m, --mode                    mode to run in (app / server / proxy / quiz) (default: app)
   -p, --port                    port to run the server (default: 25459)
   -v, --version                 displays version number (default: false)

Simple, and file-based

You can see example input in /data/*.yaml. You can see that it is Eta / browser-side JavaScript based. This is further enhanced by plugins in /packages/app/plugins.

Otherwise, quizzing (and mnemonic) data are generated and stored in data.db; with is a SQLite file. The schema can be seen in /packages/app/db/*.go.

Real and latest browser-side JavaScript

You use any JavaScript that latest browsers support. Of course, <script type="module"> is also supported.

Better search engine

The search allows not only searching by tags (tag:) and data fields ("key":), but also by statistics (srsLevel:0, wrongStreak<2) and by date (nextReview<-1h).

Further design of the search engine can be seen in https://github.com/patarapolw/qsearch.

Dependencies

This app utilizes Chrome DevTools Protocol. Most Windows computers already have this by default via Microsoft Edge.

However, in macOS and Linux, you will require to install either Google Chrome, or Chromium (or Ungoogled Chromium).

Deployment as a server

You can do that, but an environment variable, SECRET will be required, which will be generated in config.yaml by default.

Parent project, as a concept

The idea is not new. It came from another project of mine, https://github.com/rep2recall/rep2recall.