clsr stands for Command Line Spaced Repetition.
It is a learning tool that uses spaced repetition
to help you learn and retain information efficiently.
It is similar to other spaced repetition software, but takes a
minimalist, text-based, and version-controllable approach.
clsr was inspired by ledger, and
more generally by the plain text accounting
ecosystem.
First, some terms:
A card is a virtual flash card. It contains a question or prompt for
something you want to learn, and the answer to that question.
A deck is a group of related cards. For example, you might make a deck
for learning French, or for a programming language you want to learn.
In clsr, decks take the form of JSON files. The idea is that you keep
all of your deck files in a directory. Then when you run clsr commands
from inside that directory, clsr can work with those files.
Having these files in one directory also lends itself to the use of
version control.
clsr will work well for you if:
- You want to easily understand how your data is stored
- You want to store your card data in version control
- You want to write scripts that use your card data
- You work over SSH, or want the option to do so
You should not use clsr if:
- You are not comfortable with the command line
- You need to include anything other than text (i.e. pictures, sounds) in your cards
- You need fancier features such as cloze and reversed cards
Binaries are available from the releases page.
Alternatively, you may use go install:
go install github.com/adamkpickering/clsr@latest
Note that if you do this, clsr --version will output development,
not a real version. This is because goreleaser or go build with the
-ldflags argument is needed to specify the version during the build.
First, install go 1.21 or later and goreleaser.
Clone the clsr repo. Then, from the base of that repo:
goreleaser build --clean
Thanks to SUSE for holding Hack Week 22,
which helped to get clsr to the point where it is usable!