takacs / donkey

donkey (d-anki) is a terminal flash card review app
MIT License
20 stars 0 forks source link

donkey

A flash card memorization app in your terminal.

### About Donkey is a simplified, terminal-based [flashcard](https://en.m.wikipedia.org/wiki/Flashcard) application designed to offer the core benefits of spaced repetition without the complexity and overhead of a full-featured GUI application like [Anki](https://en.wikipedia.org/wiki/Anki_(software)). ### Installation #### Go ``` go install github.com/takacs/donkey@latest ``` ### Running donkey Running the `donkey` command after installation reaches the cli. To start the actual app: ``` donkey launch ``` ### Card Review Cards to be reviewed are provided by a slightly modified version of the [SuperMemo-2 algorithm](https://en.wikipedia.org/wiki/SuperMemo). ### CLI There's some functionality that can be achieved through the cli. - `donkey add` - add card to db - flags: - -f front - -b back - -d deck (optional: default) - `donkey list` - list all donkey cards - `donkey delete` - delete donkey cards based on id - args - -id id of card to delete - `donkey where` - show where the db is located on local machine - `donkey launch` - launch the Donkey TUI - `donkey load` - docs on how to import: https://github.com/takacs/donkey/blob/main/docs/load_cards.md - load anki exported file - flags: - -d deck (optional: default) ### Acknowledgments Built with [bubbletea](https://github.com/charmbracelet/bubbletea)